3 Copyright (C) 2000 - 2010 Simon MORLAT (simon.morlat@linphone.org)
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.
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.
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.
19 #ifndef LINPHONECORE_H
20 #define LINPHONECORE_H
22 #include "ortp/ortp.h"
23 #include "ortp/payloadtype.h"
24 #include "mediastreamer2/mscommon.h"
25 #include "mediastreamer2/msvideo.h"
30 #include "linphone/sipsetup.h"
33 #define LINPHONE_IPADDR_SIZE 64
34 #define LINPHONE_HOSTNAME_SIZE 128
43 * Linphone core main object created by function linphone_core_new() .
44 * @ingroup initializing
46 typedef struct _LinphoneCore LinphoneCore;
52 struct _LCSipTransports{
59 typedef struct _LCSipTransports LCSipTransports;
62 * Object that represents a SIP address.
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
72 * @ingroup linphone_address
73 * @var LinphoneAddress
75 typedef struct SalAddress LinphoneAddress;
77 #include "linphonefriend.h"
79 #include "linphone/linphonefriend.h"
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);
89 * Get port number as an integer value.
92 int linphone_address_get_port_int(const LinphoneAddress *u);
94 * Get port number, null if not present.
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);
109 struct _SipSetupContext;
113 * Enum representing the direction of a call.
116 enum _LinphoneCallDir {
117 LinphoneCallOutgoing, /**< outgoing calls*/
118 LinphoneCallIncoming /**< incoming calls*/
125 typedef enum _LinphoneCallDir LinphoneCallDir;
128 * Enum representing the status of a call
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;
139 * Structure representing a call log.
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*/
153 rtp_stats_t local_stats;
154 rtp_stats_t remote_stats;
157 struct _LinphoneCore *lc;
162 * Enum describing type of media encryption types.
164 enum LinphoneMediaEncryption {
165 LinphoneMediaEncryptionNone,
166 LinphoneMediaEncryptionSRTP,
167 LinphoneMediaEncryptionZRTP
171 * Enum describing type of media encryption types.
173 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
176 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
177 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
178 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
179 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
180 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
181 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
182 char * linphone_call_log_to_str(LinphoneCallLog *cl);
184 struct _LinphoneCallParams;
187 * The LinphoneCallParams is an object containing various call related parameters.
188 * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
191 typedef struct _LinphoneCallParams LinphoneCallParams;
193 const PayloadType* linphone_call_params_get_used_audio_codec(const LinphoneCallParams *cp);
194 const PayloadType* linphone_call_params_get_used_video_codec(const LinphoneCallParams *cp);
195 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
196 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
197 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
198 LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
199 void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
200 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
201 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
202 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
203 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
204 void linphone_call_params_destroy(LinphoneCallParams *cp);
207 * Enum describing failure reasons.
208 * @ingroup initializing
210 enum _LinphoneReason{
212 LinphoneReasonNoResponse, /**<No response received from remote*/
213 LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
214 LinphoneReasonDeclined, /**<The call has been declined*/
215 LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
216 LinphoneReasonNotAnswered
220 * Enum describing failure reasons.
221 * @ingroup initializing
223 typedef enum _LinphoneReason LinphoneReason;
225 const char *linphone_reason_to_string(LinphoneReason err);
228 * Structure describing policy regarding video streams establishments.
229 * @ingroup media_parameters
231 struct _LinphoneVideoPolicy{
232 bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/
233 bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
238 * Structure describing policy regarding video streams establishments.
239 * @ingroup media_parameters
241 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
244 * The LinphoneCall object represents a call issued or received by the LinphoneCore
245 * @ingroup call_control
247 struct _LinphoneCall;
249 * The LinphoneCall object represents a call issued or received by the LinphoneCore
250 * @ingroup call_control
252 typedef struct _LinphoneCall LinphoneCall;
256 * @addtogroup call_misc
260 #define LINPHONE_CALL_STATS_AUDIO 0
261 #define LINPHONE_CALL_STATS_VIDEO 1
264 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
266 * To receive these informations periodically and as soon as they are computed, the application is invited to place a #CallStatsUpdated callback in the LinphoneCoreVTable structure
267 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
269 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
271 typedef struct _LinphoneCallStats LinphoneCallStats;
274 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
276 * To receive these informations periodically and as soon as they are computed, the application is invited to place a #CallStatsUpdated callback in the LinphoneCoreVTable structure
277 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
279 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
281 struct _LinphoneCallStats {
282 int type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
283 jitter_stats_t jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
284 mblk_t* received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
285 mblk_t* sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
286 float round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
293 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
294 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
297 /** Callback prototype */
298 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
301 * LinphoneCallState enum represents the different state a call can reach into.
302 * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
303 * @ingroup call_control
305 typedef enum _LinphoneCallState{
306 LinphoneCallIdle, /**<Initial call state */
307 LinphoneCallIncomingReceived, /**<This is a new incoming call */
308 LinphoneCallOutgoingInit, /**<An outgoing call is started */
309 LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
310 LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
311 LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
312 LinphoneCallConnected, /**<Connected, the call is answered */
313 LinphoneCallStreamsRunning, /**<The media streams are established and running*/
314 LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
315 LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
316 LinphoneCallResuming, /**<The call is being resumed by local end*/
317 LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
318 LinphoneCallError, /**<The call encountered an error*/
319 LinphoneCallEnd, /**<The call ended normally*/
320 LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
321 LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
322 LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
323 LinphoneCallUpdated, /**<The remote accepted the call update initiated by us */
324 LinphoneCallReleased /**< The call object is no more retained by the core */
327 const char *linphone_call_state_to_string(LinphoneCallState cs);
329 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
330 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
331 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
332 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
333 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
334 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
335 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
336 LinphoneCall * linphone_call_ref(LinphoneCall *call);
337 void linphone_call_unref(LinphoneCall *call);
338 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
339 const char *linphone_call_get_refer_to(const LinphoneCall *call);
340 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
341 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
342 int linphone_call_get_duration(const LinphoneCall *call);
343 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
344 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
345 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
346 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
347 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
348 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
349 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
350 float linphone_call_get_play_volume(LinphoneCall *call);
351 float linphone_call_get_record_volume(LinphoneCall *call);
352 float linphone_call_get_current_quality(LinphoneCall *call);
353 float linphone_call_get_average_quality(LinphoneCall *call);
354 const char* linphone_call_get_authentication_token(LinphoneCall *call);
355 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
356 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
357 void linphone_call_send_vfu_request(LinphoneCall *call);
358 void *linphone_call_get_user_pointer(LinphoneCall *call);
359 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
360 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
361 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
364 * Enables or disable echo cancellation for this call
368 * @ingroup media_parameters
370 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
372 * Returns TRUE if echo cancellation is enabled.
374 * @ingroup media_parameters
376 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
378 * Enables or disable echo limiter for this call
382 * @ingroup media_parameters
384 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
386 * Returns TRUE if echo limiter is enabled.
388 * @ingroup media_parameters
390 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
392 /*keep this in sync with mediastreamer2/msvolume.h*/
395 * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
398 #define LINPHONE_VOLUME_DB_LOWEST (-120)
401 * @addtogroup proxies
405 * The LinphoneProxyConfig object represents a proxy configuration to be used
406 * by the LinphoneCore object.
407 * Its fields must not be used directly in favour of the accessors methods.
408 * Once created and filled properly the LinphoneProxyConfig can be given to
409 * LinphoneCore with linphone_core_add_proxy_config().
410 * This will automatically triggers the registration, if enabled.
412 * The proxy configuration are persistent to restarts because they are saved
413 * in the configuration file. As a consequence, after linphone_core_new() there
414 * might already be a list of configured proxy that can be examined with
415 * linphone_core_get_proxy_config_list().
417 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
418 * that is used by default for calls.
420 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
423 * LinphoneRegistrationState describes proxy registration states.
425 typedef enum _LinphoneRegistrationState{
426 LinphoneRegistrationNone, /**<Initial state for registrations */
427 LinphoneRegistrationProgress, /**<Registration is in progress */
428 LinphoneRegistrationOk, /**< Registration is successful */
429 LinphoneRegistrationCleared, /**< Unregistration succeeded */
430 LinphoneRegistrationFailed /**<Registration failed */
431 }LinphoneRegistrationState;
434 * Human readable version of the #LinphoneRegistrationState
437 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
439 LinphoneProxyConfig *linphone_proxy_config_new(void);
440 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
441 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
442 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
443 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
445 * Indicates either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
446 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
447 * @param obj object pointer
448 * @param val if true, registration will be engaged
450 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
451 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
452 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
453 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
455 * Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
456 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
457 * @param obj object pointer
458 * @param val if true, publish will be engaged
461 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
462 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
463 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
465 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
466 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
467 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
469 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
470 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
471 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
472 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
473 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
474 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
475 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
476 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
478 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
479 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
481 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
483 /* destruction is called automatically when removing the proxy config */
484 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
485 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
486 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
487 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
489 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
491 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
493 * attached a user data to a proxy config
495 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
497 * get user data to a proxy config. return null if any
499 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
505 typedef struct _LinphoneAccountCreator{
506 struct _LinphoneCore *lc;
507 struct _SipSetupContext *ssctx;
515 }LinphoneAccountCreator;
517 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
518 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
519 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
520 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
521 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
522 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
523 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
524 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
525 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
526 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
527 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
528 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
529 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
531 struct _LinphoneAuthInfo;
534 * @ingroup authentication
535 * Object holding authentication information.
537 * @note The object's fields should not be accessed directly. Prefer using
538 * the accessor methods.
540 * In most case, authentication information consists of a username and password.
541 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
542 * different SIP domains.
544 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
545 * order to become known and used automatically when needed.
546 * Use linphone_core_add_auth_info() for that purpose.
548 * The LinphoneCore object can take the initiative to request authentication information
549 * when needed to the application through the auth_info_requested callback of the
550 * LinphoneCoreVTable structure.
552 * The application can respond to this information request later using
553 * linphone_core_add_auth_info(). This will unblock all pending authentication
554 * transactions and retry them with authentication headers.
557 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
559 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
560 const char *passwd, const char *ha1,const char *realm);
561 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
562 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
563 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
565 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
566 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
567 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
569 /* you don't need those function*/
570 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
571 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
574 struct _LinphoneChatRoom;
576 * @addtogroup chatroom
580 * A chat room is the place where text messages are exchanged.
581 * <br> Can be created by linphone_core_create_chat_room().
583 typedef struct _LinphoneChatRoom LinphoneChatRoom;
585 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
586 * @param lc #LinphoneCore object
587 * @param to destination address for messages
588 * @return #LinphoneChatRoom where messaging can take place.
590 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
593 * @param cr #LinphoneChatRoom object
595 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
599 * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
600 * @param cr #LinphoneChatRoom object
601 * @return #LinphoneAddress peer address
603 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
605 * send a message to peer member of this chat room.
606 * @param cr #LinphoneChatRoom object
607 * @param msg message to be sent
609 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
611 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
612 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
620 * @addtogroup initializing
625 * LinphoneGlobalState describes the global state of the LinphoneCore object.
626 * It is notified via the LinphoneCoreVTable::global_state_changed
628 typedef enum _LinphoneGlobalState{
630 LinphoneGlobalStartup,
632 LinphoneGlobalShutdown
633 }LinphoneGlobalState;
635 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
638 /**Call state notification callback prototype*/
639 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
640 /**Call state notification callback prototype*/
641 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
642 /**Call encryption changed callback prototype*/
643 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
646 * Registration state notification callback prototype
648 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
649 /** Callback prototype */
650 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
651 /** Callback prototype */
652 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
653 /** Callback prototype */
654 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
655 /** Callback prototype */
656 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
657 /** Callback prototype */
658 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
659 /** Callback prototype */
660 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
662 * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
663 * @param lc #LinphoneCore object .
664 * @param lf Updated #LinphoneFriend .
666 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
668 * Reports that a new subscription request has been received and wait for a decision.
669 * <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
670 * @param lc #LinphoneCore object
671 * @param lf #LinphoneFriend corresponding to the subscriber
672 * @param url of the subscriber
675 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
676 /** Callback prototype */
677 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
678 /** Callback prototype */
679 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
683 * @param lc #LinphoneCore object
684 * @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.
685 * @param from #LinphoneAddress from
686 * @param message incoming message
688 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
689 /** Callback prototype */
690 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
691 /** Callback prototype */
692 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
693 /** Callback prototype */
694 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
695 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
696 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
697 /** Callback prototype for receiving quality statistics for calls*/
698 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
701 * This structure holds all callbacks that the application should implement.
704 typedef struct _LinphoneVTable{
705 LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
706 LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
707 LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
708 NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
709 NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
710 AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
711 CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
712 TextMessageReceived text_received; /**< A text message has been received */
713 DtmfReceived dtmf_received; /**< A dtmf has been received received */
714 ReferReceived refer_received; /**< An out of call refer was received */
715 CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
716 LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
717 BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
718 NotifyReceivedCb notify_recv; /**< Other notifications*/
719 CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
720 DisplayStatusCb display_status; /**< Callback that notifies various events with human readable text.*/
721 DisplayMessageCb display_message;/**< Callback to display a message to the user */
722 DisplayMessageCb display_warning;/** Callback to display a warning to the user */
723 DisplayUrlCb display_url;
724 ShowInterfaceCb show; /**< Notifies the application that it should show up*/
725 } LinphoneCoreVTable;
731 typedef struct _LCCallbackObj
733 LinphoneCoreCbFunc _func;
739 typedef enum _LinphoneFirewallPolicy{
740 LinphonePolicyNoFirewall,
741 LinphonePolicyUseNatAddress,
742 LinphonePolicyUseStun
743 } LinphoneFirewallPolicy;
745 typedef enum _LinphoneWaitingState{
746 LinphoneWaitingStart,
747 LinphoneWaitingProgress,
748 LinphoneWaitingFinished
749 } LinphoneWaitingState;
750 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
755 void linphone_core_enable_logs(FILE *file);
756 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
757 void linphone_core_disable_logs(void);
758 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
759 void linphone_core_set_user_agent(const char *ua_name, const char *version);
760 const char *linphone_core_get_version(void);
762 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
763 const char *config_path, const char *factory_config, void* userdata);
765 /* function to be periodically called in a main loop */
766 void linphone_core_iterate(LinphoneCore *lc);
768 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
770 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
772 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
774 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
776 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
778 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
780 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
782 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
784 bool_t linphone_core_in_call(const LinphoneCore *lc);
786 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
788 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
790 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
792 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
794 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
796 int linphone_core_terminate_all_calls(LinphoneCore *lc);
798 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
800 int linphone_core_pause_all_calls(LinphoneCore *lc);
802 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
804 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
806 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
808 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
810 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
812 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
814 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
816 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
818 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
820 const char * linphone_core_get_identity(LinphoneCore *lc);
822 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
823 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
825 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
826 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
828 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
829 const char * linphone_core_get_identity(LinphoneCore *lc);
830 /*0= no bandwidth limit*/
831 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
832 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
834 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
835 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
837 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
838 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
840 * set audio packetization time linphone expect to receive from peer
841 * @ingroup media_parameters
844 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
846 * get audio packetization time linphone expect to receive from peer, 0 means unspecified
847 * @ingroup media_parameters
849 int linphone_core_get_download_ptime(LinphoneCore *lc);
851 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
853 int linphone_core_get_upload_ptime(LinphoneCore *lc);
855 /* returns a MSList of PayloadType */
856 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
858 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
859 /* returns a MSList of PayloadType */
860 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
862 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
864 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
866 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
868 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate) ;
870 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
872 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
874 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
876 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
878 void linphone_core_clear_proxy_config(LinphoneCore *lc);
880 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
882 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
884 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
886 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
888 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
890 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
892 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
894 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
896 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
898 void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info);
900 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
902 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
904 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
906 int linphone_core_get_audio_port(const LinphoneCore *lc);
908 int linphone_core_get_video_port(const LinphoneCore *lc);
910 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
912 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
914 void linphone_core_set_video_port(LinphoneCore *lc, int port);
916 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
918 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
920 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
922 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
924 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
926 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
928 int linphone_core_get_sip_port(LinphoneCore *lc);
930 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
932 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
935 * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
936 * @param lc #LinphoneCore
937 * @return socket file descriptor
939 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
941 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
943 int linphone_core_get_inc_timeout(LinphoneCore *lc);
945 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
947 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
949 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
951 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
953 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
955 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
957 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
959 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
961 /* sound functions */
962 /* returns a null terminated static array of string describing the sound devices */
963 const char** linphone_core_get_sound_devices(LinphoneCore *lc);
964 void linphone_core_reload_sound_devices(LinphoneCore *lc);
965 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
966 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
967 int linphone_core_get_ring_level(LinphoneCore *lc);
968 int linphone_core_get_play_level(LinphoneCore *lc);
969 int linphone_core_get_rec_level(LinphoneCore *lc);
970 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
971 void linphone_core_set_play_level(LinphoneCore *lc, int level);
973 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
975 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
976 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
977 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
978 const char * linphone_core_get_playback_device(LinphoneCore *lc);
979 const char * linphone_core_get_capture_device(LinphoneCore *lc);
980 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
981 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
982 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
983 char linphone_core_get_sound_source(LinphoneCore *lc);
984 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
985 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
986 const char *linphone_core_get_ring(const LinphoneCore *lc);
987 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
988 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
989 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
990 const char * linphone_core_get_ringback(const LinphoneCore *lc);
992 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
993 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
995 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
996 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
997 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
999 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1000 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1002 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1003 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1005 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1009 * @ingroup media_parameters
1011 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1013 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
1014 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1016 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1017 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1020 /* returns a list of LinphoneCallLog */
1021 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1022 void linphone_core_clear_call_logs(LinphoneCore *lc);
1023 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1024 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1025 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1028 bool_t linphone_core_video_supported(LinphoneCore *lc);
1029 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1030 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1031 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1032 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1034 typedef struct MSVideoSizeDef{
1038 /* returns a zero terminated table of MSVideoSizeDef*/
1039 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1040 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1041 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1042 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1044 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1045 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1047 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1048 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1051 /* returns a null terminated static array of string describing the webcams */
1052 void linphone_core_reload_video_devices(LinphoneCore *lc);
1053 const char** linphone_core_get_video_devices(const LinphoneCore *lc);
1054 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1055 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1057 /* Set static picture to be used when "Static picture" is the video device */
1058 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1060 /* Set and get frame rate for static picture */
1061 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1062 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1064 /*function to be used for eventually setting window decorations (icons, title...)*/
1065 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1066 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1068 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1069 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1071 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1072 int linphone_core_get_device_rotation(LinphoneCore *lc );
1073 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1075 /* start or stop streaming video in case of embedded window */
1076 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1078 /*play/record support: use files instead of soundcard*/
1079 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1080 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1081 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1083 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1084 void linphone_core_stop_dtmf(LinphoneCore *lc);
1086 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1089 int linphone_core_get_mtu(const LinphoneCore *lc);
1090 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1093 * @ingroup network_parameters
1094 * This method is called by the application to notify the linphone core library when network is reachable.
1095 * Calling this method with true trigger linphone to initiate a registration process for all proxy
1096 * configuration with parameter register set to enable.
1097 * This method disable the automatic registration mode. It means you must call this method after each network state changes
1100 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1102 * @ingroup network_parameters
1103 * return network state either as positioned by the application or by linphone
1105 bool_t linphone_core_is_network_reachabled(LinphoneCore* lc);
1108 * @ingroup network_parameters
1109 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1111 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1113 * @ingroup network_parameters
1114 * Is signaling keep alive
1116 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1118 void *linphone_core_get_user_data(LinphoneCore *lc);
1119 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1121 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1122 the config file with your own sections */
1123 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1125 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1126 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1128 /*returns the list of registered SipSetup (linphonecore plugins) */
1129 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1131 void linphone_core_destroy(LinphoneCore *lc);
1133 /*for advanced users:*/
1134 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1135 struct _LinphoneRtpTransportFactories{
1136 LinphoneRtpTransportFactoryFunc audio_rtp_func;
1137 void *audio_rtp_func_data;
1138 LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1139 void *audio_rtcp_func_data;
1140 LinphoneRtpTransportFactoryFunc video_rtp_func;
1141 void *video_rtp_func_data;
1142 LinphoneRtpTransportFactoryFunc video_rtcp_func;
1143 void *video_rtcp_func_data;
1145 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1147 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1149 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1151 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1153 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1155 * force registration refresh to be initiated upon next iterate
1158 void linphone_core_refresh_registers(LinphoneCore* lc);
1160 /* Path to the file storing secrets cache */
1161 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1164 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1166 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1167 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1168 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1169 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1170 int linphone_core_enter_conference(LinphoneCore *lc);
1171 int linphone_core_leave_conference(LinphoneCore *lc);
1172 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1174 int linphone_core_terminate_conference(LinphoneCore *lc);
1175 int linphone_core_get_conference_size(LinphoneCore *lc);
1177 int linphone_core_get_max_calls(LinphoneCore *lc);
1178 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1180 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1182 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1185 * Choose media encryption policy to be used for RTP packets
1187 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1188 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1190 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1192 * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1193 * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1195 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1198 * Init call params using LinphoneCore's current configuration
1200 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1203 * True if tunnel support was compiled.
1205 bool_t linphone_core_tunnel_available(void);
1207 typedef struct LinphoneTunnel LinphoneTunnel;
1209 * get tunnel instance if available
1211 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1213 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);