]> sjero.net Git - linphone/blob - coreapi/linphonecore.h
4a6fed8b3576243acc0461e7fd624292e188f8e5
[linphone] / coreapi / linphonecore.h
1 /*
2 linphone
3 Copyright (C) 2000 - 2010 Simon MORLAT (simon.morlat@linphone.org)
4
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18 */
19 #ifndef LINPHONECORE_H
20 #define LINPHONECORE_H
21
22 #include "ortp/ortp.h"
23 #include "ortp/payloadtype.h"
24 #include "mediastreamer2/mscommon.h"
25 #include "mediastreamer2/msvideo.h"
26
27 #ifdef IN_LINPHONE
28 #include "sipsetup.h"
29 #else
30 #include "linphone/sipsetup.h"
31 #endif
32
33 #define LINPHONE_IPADDR_SIZE 64
34 #define LINPHONE_HOSTNAME_SIZE 128
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct _MSSndCard;
41 struct _LinphoneCore;
42 /**
43  * Linphone core main object created by function linphone_core_new() .
44  * @ingroup initializing
45  */
46 typedef struct _LinphoneCore LinphoneCore;
47 struct SalOp;
48
49 struct _LpConfig;
50
51
52 struct _LCSipTransports{
53         int udp_port;
54         int tcp_port;
55         int dtls_port;
56         int tls_port;
57 };
58
59 typedef struct _LCSipTransports LCSipTransports;
60
61 /**
62  * Object that represents a SIP address.
63  *
64  * The LinphoneAddress is an opaque object to represents SIP addresses, ie
65  * the content of SIP's 'from' and 'to' headers.
66  * A SIP address is made of display name, username, domain name, port, and various
67  * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
68  * The LinphoneAddress has methods to extract and manipulate all parts of the address.
69  * When some part of the address (for example the username) is empty, the accessor methods
70  * return NULL.
71  *
72  * @ingroup linphone_address
73  * @var LinphoneAddress
74  */
75 typedef struct SalAddress LinphoneAddress;
76 #ifdef IN_LINPHONE
77 #include "linphonefriend.h"
78 #else
79 #include "linphone/linphonefriend.h"
80 #endif
81
82 LinphoneAddress * linphone_address_new(const char *uri);
83 LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
84 const char *linphone_address_get_scheme(const LinphoneAddress *u);
85 const char *linphone_address_get_display_name(const LinphoneAddress* u);
86 const char *linphone_address_get_username(const LinphoneAddress *u);
87 const char *linphone_address_get_domain(const LinphoneAddress *u);
88 /**
89  * Get port number as an integer value.
90  *
91  */
92 int linphone_address_get_port_int(const LinphoneAddress *u);
93 /**
94  * Get port number, null if not present.
95  */
96 const char* linphone_address_get_port(const LinphoneAddress *u);
97 void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
98 void linphone_address_set_username(LinphoneAddress *uri, const char *username);
99 void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
100 void linphone_address_set_port(LinphoneAddress *uri, const char *port);
101 void linphone_address_set_port_int(LinphoneAddress *uri, int port);
102 /*remove tags, params etc... so that it is displayable to the user*/
103 void linphone_address_clean(LinphoneAddress *uri);
104 char *linphone_address_as_string(const LinphoneAddress *u);
105 char *linphone_address_as_string_uri_only(const LinphoneAddress *u);
106 bool_t linphone_address_weak_equal(const LinphoneAddress *a1, const LinphoneAddress *a2);
107 void linphone_address_destroy(LinphoneAddress *u);
108
109 struct _SipSetupContext;
110
111
112 /**
113  * Enum representing the direction of a call.
114  * @ingroup call_logs
115 **/
116 enum _LinphoneCallDir {
117         LinphoneCallOutgoing, /**< outgoing calls*/
118         LinphoneCallIncoming  /**< incoming calls*/
119 };
120
121 /**
122  * Typedef for enum
123  * @ingroup call_logs
124 **/
125 typedef enum _LinphoneCallDir LinphoneCallDir;
126
127 /**
128  * Enum representing the status of a call
129  * @ingroup call_logs
130 **/
131 typedef enum _LinphoneCallStatus {
132         LinphoneCallSuccess, /**< The call was sucessful*/
133         LinphoneCallAborted, /**< The call was aborted */
134         LinphoneCallMissed, /**< The call was missed (unanswered)*/
135         LinphoneCallDeclined /**< The call was declined, either locally or by remote end*/
136 } LinphoneCallStatus;
137
138 /**
139  * Structure representing a call log.
140  *
141  * @ingroup call_logs
142  *
143 **/
144 typedef struct _LinphoneCallLog{
145         LinphoneCallDir dir; /**< The direction of the call*/
146         LinphoneCallStatus status; /**< The status of the call*/
147         LinphoneAddress *from; /**<Originator of the call as a LinphoneAddress object*/
148         LinphoneAddress *to; /**<Destination of the call as a LinphoneAddress object*/
149         char start_date[128]; /**<Human readable string containg the start date*/
150         int duration; /**<Duration of the call in seconds*/
151         char *refkey;
152         void *user_pointer;
153         rtp_stats_t local_stats;
154         rtp_stats_t remote_stats;
155         float quality;
156         struct _LinphoneCore *lc;
157 } LinphoneCallLog;
158
159 enum LinphoneMediaEncryption {
160         LinphoneMediaEncryptionNone,
161         LinphoneMediaEncryptionSRTP,
162         LinphoneMediaEncryptionZRTP
163 };
164
165 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
166
167 /*public: */
168 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
169 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
170 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
171 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
172 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
173 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
174 char * linphone_call_log_to_str(LinphoneCallLog *cl);
175
176
177 /**
178  * The LinphoneCallParams is an object containing various call related parameters.
179  * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
180  * dynamically.
181 **/
182 struct _LinphoneCallParams;
183 typedef struct _LinphoneCallParams LinphoneCallParams;
184
185 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
186 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
187 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
188 LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
189 void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
190 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
191 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
192 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
193 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
194 void linphone_call_params_destroy(LinphoneCallParams *cp);
195
196 /**
197  * Enum describing failure reasons.
198  * @ingroup initializing
199 **/
200 enum _LinphoneReason{
201         LinphoneReasonNone,
202         LinphoneReasonNoResponse, /**<No response received from remote*/
203         LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
204         LinphoneReasonDeclined, /**<The call has been declined*/
205         LinphoneReasonNotFound,
206 };
207
208 typedef enum _LinphoneReason LinphoneReason;
209
210 const char *linphone_reason_to_string(LinphoneReason err);
211
212 /**
213  * The LinphoneCall object represents a call issued or received by the LinphoneCore
214 **/
215 struct _LinphoneCall;
216 typedef struct _LinphoneCall LinphoneCall;
217
218 /**
219  * LinphoneCallState enum represents the different state a call can reach into.
220  * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
221  * @ingroup call_control
222 **/
223 typedef enum _LinphoneCallState{
224         LinphoneCallIdle,                                       /**<Initial call state */
225         LinphoneCallIncomingReceived, /**<This is a new incoming call */
226         LinphoneCallOutgoingInit, /**<An outgoing call is started */
227         LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
228         LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
229         LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
230         LinphoneCallConnected, /**<Connected, the call is answered */
231         LinphoneCallStreamsRunning, /**<The media streams are established and running*/
232         LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
233         LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
234         LinphoneCallResuming, /**<The call is being resumed by local end*/
235         LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
236         LinphoneCallError, /**<The call encountered an error*/
237         LinphoneCallEnd, /**<The call ended normally*/
238         LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
239         LinphoneCallUpdatedByRemote, /**<The call's parameters are updated, used for example when video is asked by remote */
240         LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
241         LinphoneCallUpdated, /**<The remote accepted the call update initiated by us */
242         LinphoneCallReleased /**< The call object is no more retained by the core */
243 } LinphoneCallState;
244
245 const char *linphone_call_state_to_string(LinphoneCallState cs);
246
247 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
248 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
249 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
250 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
251 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
252 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
253 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
254 LinphoneCall * linphone_call_ref(LinphoneCall *call);
255 void linphone_call_unref(LinphoneCall *call);
256 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
257 const char *linphone_call_get_refer_to(const LinphoneCall *call);
258 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
259 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
260 int linphone_call_get_duration(const LinphoneCall *call);
261 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
262 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
263 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
264 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
265 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
266 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
267 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
268 float linphone_call_get_play_volume(LinphoneCall *call);
269 float linphone_call_get_record_volume(LinphoneCall *call);
270 float linphone_call_get_current_quality(LinphoneCall *call);
271 float linphone_call_get_average_quality(LinphoneCall *call);
272 const char* linphone_call_get_authentication_token(LinphoneCall *call);
273 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
274 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
275 void linphone_call_send_vfu_request(LinphoneCall *call);
276 void *linphone_call_get_user_pointer(LinphoneCall *call);
277 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
278 /**
279  * Enables or disable echo cancellation for this call
280  * @param call
281  * @param val
282  *
283  * @ingroup media_parameters
284 **/
285 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
286 /**
287  * Returns TRUE if echo cancellation is enabled.
288  *
289  * @ingroup media_parameters
290 **/
291 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
292 /**
293  * Enables or disable echo limiter for this call
294  * @param call
295  * @param val
296  *
297  * @ingroup media_parameters
298 **/
299 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
300 /**
301  * Returns TRUE if echo limiter is enabled.
302  *
303  * @ingroup media_parameters
304 **/
305 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
306
307 /*keep this in sync with mediastreamer2/msvolume.h*/
308 #define LINPHONE_VOLUME_DB_LOWEST (-120) /**< Lowest measured that can be returned.*/
309
310 /**
311  * @addtogroup proxies
312  * @{
313 **/
314 /**
315  * The LinphoneProxyConfig object represents a proxy configuration to be used
316  * by the LinphoneCore object.
317  * Its fields must not be used directly in favour of the accessors methods.
318  * Once created and filled properly the LinphoneProxyConfig can be given to
319  * LinphoneCore with linphone_core_add_proxy_config().
320  * This will automatically triggers the registration, if enabled.
321  *
322  * The proxy configuration are persistent to restarts because they are saved
323  * in the configuration file. As a consequence, after linphone_core_new() there
324  * might already be a list of configured proxy that can be examined with
325  * linphone_core_get_proxy_config_list().
326  *
327  * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
328  * that is used by default for calls.
329 **/
330 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
331
332 /**
333  * LinphoneRegistrationState describes proxy registration states.
334 **/
335 typedef enum _LinphoneRegistrationState{
336         LinphoneRegistrationNone, /**<Initial state for registrations */
337         LinphoneRegistrationProgress, /**<Registration is in progress */
338         LinphoneRegistrationOk, /**< Registration is successful */
339         LinphoneRegistrationCleared, /**< Unregistration succeeded */
340         LinphoneRegistrationFailed      /**<Registration failed */
341 }LinphoneRegistrationState;
342
343 /**
344  * Human readable version of the #LinphoneRegistrationState
345  * @param cs sate
346  */
347 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
348
349 LinphoneProxyConfig *linphone_proxy_config_new(void);
350 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
351 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
352 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
353 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
354 /**
355  * Indicates  either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
356  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
357  * @param obj object pointer
358  * @param val if true, registration will be engaged
359  */
360 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
361 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
362 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
363 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
364 /**
365  * Indicates  either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
366  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
367  * @param obj object pointer
368  * @param val if true, publish will be engaged
369  *
370  */
371 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
372 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
373 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
374
375 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
376 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
377 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
378
379 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
380 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
381 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
382 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
383 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
384 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
385 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
386 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
387
388 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
389 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
390
391 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
392
393 /* destruction is called automatically when removing the proxy config */
394 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
395 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
396 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
397 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
398 /**
399  * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
400  */
401 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
402 /*
403  *  attached a user data to a proxy config
404  */
405 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
406 /*
407  *  get user data to a proxy config. return null if any
408  */
409 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
410
411 /**
412  * @}
413 **/
414
415 typedef struct _LinphoneAccountCreator{
416         struct _LinphoneCore *lc;
417         struct _SipSetupContext *ssctx;
418         char *username;
419         char *password;
420         char *domain;
421         char *route;
422         char *email;
423         int suscribe;
424         bool_t succeeded;
425 }LinphoneAccountCreator;
426
427 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
428 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
429 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
430 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
431 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
432 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
433 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
434 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
435 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
436 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
437 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
438 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
439 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
440
441 struct _LinphoneAuthInfo;
442
443 /**
444  * @ingroup authentication
445  * Object holding authentication information.
446  *
447  * @note The object's fields should not be accessed directly. Prefer using
448  * the accessor methods.
449  *
450  * In most case, authentication information consists of a username and password.
451  * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
452  * different SIP domains.
453  *
454  * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
455  * order to become known and used automatically when needed.
456  * Use linphone_core_add_auth_info() for that purpose.
457  *
458  * The LinphoneCore object can take the initiative to request authentication information
459  * when needed to the application through the auth_info_requested callback of the
460  * LinphoneCoreVTable structure.
461  *
462  * The application can respond to this information request later using
463  * linphone_core_add_auth_info(). This will unblock all pending authentication
464  * transactions and retry them with authentication headers.
465  *
466 **/
467 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
468
469 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
470                 const char *passwd, const char *ha1,const char *realm);
471 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
472 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
473 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
474
475 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
476 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
477 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
478
479 /* you don't need those function*/
480 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
481 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
482
483
484 struct _LinphoneChatRoom;
485 /**
486  * @addtogroup chatroom
487  * @{
488  */
489 /**
490  * A chat room is the place where text messages are exchanged.
491  * <br> Can be created by linphone_core_create_chat_room().
492  */
493 typedef struct _LinphoneChatRoom LinphoneChatRoom;
494 /**
495  * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
496  * @param lc #LinphoneCore object
497  * @param to destination address for messages
498  * @return #LinphoneChatRoom where messaging can take place.
499  */
500 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
501 /**
502  * Destructor
503  * @param cr #LinphoneChatRoom object
504  */
505 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
506
507
508 /**
509  * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
510  * @param cr #LinphoneChatRoom object
511  * @return #LinphoneAddress peer address
512  */
513 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
514 /**
515  * send a message to peer member of this chat room.
516  * @param cr #LinphoneChatRoom object
517  * @param msg message to be sent
518  */
519 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
520
521 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
522 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
523
524 /**
525  * @}
526  */
527
528
529 /**
530  * @addtogroup initializing
531  * @{
532 **/
533
534 /**
535  * LinphoneGlobalState describes the global state of the LinphoneCore object.
536  * It is notified via the LinphoneCoreVTable::global_state_changed
537 **/
538 typedef enum _LinphoneGlobalState{
539         LinphoneGlobalOff,
540         LinphoneGlobalStartup,
541         LinphoneGlobalOn,
542         LinphoneGlobalShutdown
543 }LinphoneGlobalState;
544
545 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
546
547
548 /**Call state notification callback prototype*/
549 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
550 /**Call state notification callback prototype*/
551 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
552 /**Call encryption changed callback prototype*/
553 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
554
555 /** @ingroup Proxies
556  * Registration state notification callback prototype
557  * */
558 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
559 /** Callback prototype */
560 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
561 /** Callback prototype */
562 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
563 /** Callback prototype */
564 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
565 /** Callback prototype */
566 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
567 /** Callback prototype */
568 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
569 /** Callback prototype */
570 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
571 /**
572  * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
573  * @param lc #LinphoneCore object .
574  * @param lf Updated #LinphoneFriend .
575  */
576 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
577 /**
578  *  Reports that a new subscription request has been received and wait for a decision.
579  *  <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
580  *      @param lc #LinphoneCore object
581  *      @param lf #LinphoneFriend corresponding to the subscriber
582  *      @param url of the subscriber
583  *  Callback prototype
584  *  */
585 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
586 /** Callback prototype */
587 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
588 /** Callback prototype */
589 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
590 /**
591  * Callback prototype
592  *
593  * @param lc #LinphoneCore object
594  * @param room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case \link #LinphoneAddress the from \endlink is not present in any chat room.
595  * @param from #LinphoneAddress from
596  * @param message incoming message
597  *  */
598 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
599 /** Callback prototype */
600 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
601 /** Callback prototype */
602 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
603 /** Callback prototype */
604 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
605
606 /**
607  * This structure holds all callbacks that the application should implement.
608  *  None is mandatory.
609 **/
610 typedef struct _LinphoneVTable{
611         LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
612         LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
613         LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
614         NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
615         NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
616         AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
617         CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
618         TextMessageReceived text_received; /**< A text message has been received */
619         DtmfReceived dtmf_received; /**< A dtmf has been received received */
620         ReferReceived refer_received; /**< An out of call refer was received */
621         BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
622         NotifyReceivedCb notify_recv; /**< Other notifications*/
623         DisplayStatusCb display_status; /**< Callback that notifies various events with human readable text.*/
624         DisplayMessageCb display_message;/**< Callback to display a message to the user */
625         DisplayMessageCb display_warning;/** Callback to display a warning to the user */
626         DisplayUrlCb display_url;
627         ShowInterfaceCb show; /**< Notifies the application that it should show up*/
628         CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
629 } LinphoneCoreVTable;
630
631 /**
632  * @}
633 **/
634
635 typedef struct _LCCallbackObj
636 {
637   LinphoneCoreCbFunc _func;
638   void * _user_data;
639 }LCCallbackObj;
640
641
642
643 typedef enum _LinphoneFirewallPolicy{
644         LinphonePolicyNoFirewall,
645         LinphonePolicyUseNatAddress,
646         LinphonePolicyUseStun
647 } LinphoneFirewallPolicy;
648
649 typedef enum _LinphoneWaitingState{
650         LinphoneWaitingStart,
651         LinphoneWaitingProgress,
652         LinphoneWaitingFinished
653 } LinphoneWaitingState;
654 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
655
656
657 /* THE main API */
658
659 void linphone_core_enable_logs(FILE *file);
660 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
661 void linphone_core_disable_logs(void);
662 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
663 void linphone_core_set_user_agent(const char *ua_name, const char *version);
664 const char *linphone_core_get_version(void);
665
666 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
667                                                 const char *config_path, const char *factory_config, void* userdata);
668
669 /* function to be periodically called in a main loop */
670 void linphone_core_iterate(LinphoneCore *lc);
671
672 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
673
674 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
675
676 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
677
678 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
679
680 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
681
682 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
683
684 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
685
686 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
687
688 bool_t linphone_core_in_call(const LinphoneCore *lc);
689
690 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
691
692 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
693
694 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
695
696 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
697
698 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
699
700 int linphone_core_terminate_all_calls(LinphoneCore *lc);
701
702 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
703
704 int linphone_core_pause_all_calls(LinphoneCore *lc);
705
706 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
707
708 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
709
710 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
711
712 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
713
714 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
715
716 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
717
718 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
719
720 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
721
722 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
723
724 const char * linphone_core_get_identity(LinphoneCore *lc);
725
726 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
727 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
728
729 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
730 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
731
732 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
733 const char * linphone_core_get_identity(LinphoneCore *lc);
734 /*0= no bandwidth limit*/
735 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
736 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
737
738 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
739 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
740
741 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
742 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
743 /**
744  * set audio packetization time linphone expect to receive from peer
745  * @ingroup media_parameters
746  *
747  */
748 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
749 /**
750  * get audio packetization time linphone expect to receive from peer, 0 means unspecified
751  * @ingroup media_parameters
752  */
753 int  linphone_core_get_download_ptime(LinphoneCore *lc);
754
755 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
756
757 int linphone_core_get_upload_ptime(LinphoneCore *lc);
758
759 /* returns a MSList of PayloadType */
760 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
761
762 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
763 /* returns a MSList of PayloadType */
764 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
765
766 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
767
768 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, PayloadType *pt);
769
770 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
771
772 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate) ;
773
774 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
775
776 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
777
778 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
779
780 void linphone_core_clear_proxy_config(LinphoneCore *lc);
781
782 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
783
784 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
785
786 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
787
788 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
789
790 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
791
792 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
793
794 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
795
796 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
797
798 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
799
800 void linphone_core_abort_authentication(LinphoneCore *lc,  LinphoneAuthInfo *info);
801
802 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
803
804 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
805
806 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
807
808 int linphone_core_get_audio_port(const LinphoneCore *lc);
809
810 int linphone_core_get_video_port(const LinphoneCore *lc);
811
812 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
813
814 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
815
816 void linphone_core_set_video_port(LinphoneCore *lc, int port);
817
818 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
819
820 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
821
822 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
823
824 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
825
826 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
827
828 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
829
830 int linphone_core_get_sip_port(LinphoneCore *lc);
831
832 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
833
834 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
835 /**
836  *
837  * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
838  * @param lc #LinphoneCore
839  * @return socket file descriptor
840  */
841 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
842
843 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
844
845 int linphone_core_get_inc_timeout(LinphoneCore *lc);
846
847 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
848
849 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
850
851 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
852
853 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
854
855 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
856
857 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
858
859 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
860
861 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
862
863 /* sound functions */
864 /* returns a null terminated static array of string describing the sound devices */
865 const char**  linphone_core_get_sound_devices(LinphoneCore *lc);
866 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
867 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
868 int linphone_core_get_ring_level(LinphoneCore *lc);
869 int linphone_core_get_play_level(LinphoneCore *lc);
870 int linphone_core_get_rec_level(LinphoneCore *lc);
871 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
872 void linphone_core_set_play_level(LinphoneCore *lc, int level);
873
874 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
875
876 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
877 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
878 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
879 const char * linphone_core_get_playback_device(LinphoneCore *lc);
880 const char * linphone_core_get_capture_device(LinphoneCore *lc);
881 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
882 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
883 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
884 char linphone_core_get_sound_source(LinphoneCore *lc);
885 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
886 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
887 const char *linphone_core_get_ring(const LinphoneCore *lc);
888 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
889 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
890 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
891 const char * linphone_core_get_ringback(const LinphoneCore *lc);
892
893 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
894 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
895
896 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
897 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
898 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
899
900 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
901 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
902
903 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
904 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
905
906 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
907 /**
908  * return mic state.
909  *
910  * @ingroup media_parameters
911 **/
912 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
913
914 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
915 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
916
917 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
918 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
919
920
921 /* returns a list of LinphoneCallLog */
922 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
923 void linphone_core_clear_call_logs(LinphoneCore *lc);
924
925 /* video support */
926 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
927 bool_t linphone_core_video_enabled(LinphoneCore *lc);
928
929 typedef struct MSVideoSizeDef{
930         MSVideoSize vsize;
931         const char *name;
932 }MSVideoSizeDef;
933 /* returns a zero terminated table of MSVideoSizeDef*/
934 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
935 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
936 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
937 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
938
939 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
940 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
941
942 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
943 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
944
945
946 /* returns a null terminated static array of string describing the webcams */
947 const char**  linphone_core_get_video_devices(const LinphoneCore *lc);
948 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
949 const char *linphone_core_get_video_device(const LinphoneCore *lc);
950
951 /* Set static picture to be used when "Static picture" is the video device */
952 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
953
954 /* Set and get frame rate for static picture */
955 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
956 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
957
958 /*function to be used for eventually setting window decorations (icons, title...)*/
959 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
960 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
961
962 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
963 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
964
965 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
966 int linphone_core_get_device_rotation(LinphoneCore *lc );
967 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
968
969 /* start or stop streaming video in case of embedded window */
970 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
971
972 /*play/record support: use files instead of soundcard*/
973 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
974 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
975 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
976
977 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
978 void linphone_core_stop_dtmf(LinphoneCore *lc);
979
980 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
981
982
983 int linphone_core_get_mtu(const LinphoneCore *lc);
984 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
985
986 /**
987  * @ingroup network_parameters
988  * This method is called by the application to notify the linphone core library when network is reachable.
989  * Calling this method with true trigger linphone to initiate a registration process for all proxy
990  * configuration with parameter register set to enable.
991  * This method disable the automatic registration mode. It means you must call this method after each network state changes
992  *
993  */
994 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
995 /**
996  * @ingroup network_parameters
997  * return network state either as positioned by the application or by linphone
998  */
999 bool_t linphone_core_is_network_reachabled(LinphoneCore* lc);
1000
1001 /**
1002  *  @ingroup network_parameters
1003  *  enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1004  */
1005 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1006 /**
1007  *  @ingroup network_parameters
1008  * Is signaling keep alive
1009  */
1010 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1011
1012 void *linphone_core_get_user_data(LinphoneCore *lc);
1013
1014 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1015 the config file with your own sections */
1016 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1017
1018 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1019 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1020
1021 /*returns the list of registered SipSetup (linphonecore plugins) */
1022 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1023
1024 void linphone_core_destroy(LinphoneCore *lc);
1025
1026 /*for advanced users:*/
1027 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1028 struct _LinphoneRtpTransportFactories{
1029         LinphoneRtpTransportFactoryFunc audio_rtp_func;
1030         void *audio_rtp_func_data;
1031         LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1032         void *audio_rtcp_func_data;
1033         LinphoneRtpTransportFactoryFunc video_rtp_func;
1034         void *video_rtp_func_data;
1035         LinphoneRtpTransportFactoryFunc video_rtcp_func;
1036         void *video_rtcp_func_data;
1037 };
1038 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1039
1040 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1041
1042 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1043
1044 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1045
1046 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1047 /**
1048  * force registration refresh to be initiated upon next iterate
1049  * @ingroup proxies
1050  */
1051 void linphone_core_refresh_registers(LinphoneCore* lc);
1052
1053 /* Path to the file storing secrets cache */
1054 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1055
1056
1057 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1058
1059 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1060 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1061 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1062 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1063 int linphone_core_enter_conference(LinphoneCore *lc);
1064 int linphone_core_leave_conference(LinphoneCore *lc);
1065 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1066
1067 int linphone_core_terminate_conference(LinphoneCore *lc);
1068 int linphone_core_get_conference_size(LinphoneCore *lc);
1069
1070 int linphone_core_get_max_calls(LinphoneCore *lc);
1071 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1072
1073 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1074
1075 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1076
1077 /**
1078  * Choose media encryption policy to be used for RTP packets
1079  */
1080 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1081 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1082
1083 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1084 /**
1085  * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1086  * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1087  */
1088 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1089
1090 /**
1091  * Init call params using LinphoneCore's current configuration
1092  */
1093 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1094
1095 /**
1096  * True if tunnel support was compiled.
1097  */
1098 bool_t linphone_core_tunnel_available(void);
1099
1100 typedef struct LinphoneTunnel LinphoneTunnel;
1101 /**
1102 * get tunnel instance if available
1103 */
1104 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1105
1106 #ifdef __cplusplus
1107 }
1108 #endif
1109
1110
1111 #endif