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;
158 time_t start_date_time; /**Start date of the call in seconds as expressed in a time_t */
163 * Enum describing type of media encryption types.
165 enum LinphoneMediaEncryption {
166 LinphoneMediaEncryptionNone,
167 LinphoneMediaEncryptionSRTP,
168 LinphoneMediaEncryptionZRTP
172 * Enum describing type of media encryption types.
174 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
177 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
178 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
179 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
180 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
181 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
182 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
183 char * linphone_call_log_to_str(LinphoneCallLog *cl);
185 struct _LinphoneCallParams;
188 * The LinphoneCallParams is an object containing various call related parameters.
189 * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
192 typedef struct _LinphoneCallParams LinphoneCallParams;
194 const PayloadType* linphone_call_params_get_used_audio_codec(const LinphoneCallParams *cp);
195 const PayloadType* linphone_call_params_get_used_video_codec(const LinphoneCallParams *cp);
196 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
197 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
198 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
199 LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
200 void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
201 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
202 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
203 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
204 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
205 void linphone_call_params_destroy(LinphoneCallParams *cp);
208 * Enum describing failure reasons.
209 * @ingroup initializing
211 enum _LinphoneReason{
213 LinphoneReasonNoResponse, /**<No response received from remote*/
214 LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
215 LinphoneReasonDeclined, /**<The call has been declined*/
216 LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
217 LinphoneReasonNotAnswered
221 * Enum describing failure reasons.
222 * @ingroup initializing
224 typedef enum _LinphoneReason LinphoneReason;
226 const char *linphone_reason_to_string(LinphoneReason err);
229 * Structure describing policy regarding video streams establishments.
230 * @ingroup media_parameters
232 struct _LinphoneVideoPolicy{
233 bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/
234 bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
239 * Structure describing policy regarding video streams establishments.
240 * @ingroup media_parameters
242 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
245 * The LinphoneCall object represents a call issued or received by the LinphoneCore
246 * @ingroup call_control
248 struct _LinphoneCall;
250 * The LinphoneCall object represents a call issued or received by the LinphoneCore
251 * @ingroup call_control
253 typedef struct _LinphoneCall LinphoneCall;
257 * @addtogroup call_misc
261 #define LINPHONE_CALL_STATS_AUDIO 0
262 #define LINPHONE_CALL_STATS_VIDEO 1
265 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
267 * 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
268 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
270 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
272 typedef struct _LinphoneCallStats LinphoneCallStats;
275 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
277 * 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
278 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
280 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
282 struct _LinphoneCallStats {
283 int type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
284 jitter_stats_t jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
285 mblk_t* received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
286 mblk_t* sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
287 float round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
294 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
295 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
298 /** Callback prototype */
299 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
302 * LinphoneCallState enum represents the different state a call can reach into.
303 * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
304 * @ingroup call_control
306 typedef enum _LinphoneCallState{
307 LinphoneCallIdle, /**<Initial call state */
308 LinphoneCallIncomingReceived, /**<This is a new incoming call */
309 LinphoneCallOutgoingInit, /**<An outgoing call is started */
310 LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
311 LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
312 LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
313 LinphoneCallConnected, /**<Connected, the call is answered */
314 LinphoneCallStreamsRunning, /**<The media streams are established and running*/
315 LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
316 LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
317 LinphoneCallResuming, /**<The call is being resumed by local end*/
318 LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
319 LinphoneCallError, /**<The call encountered an error*/
320 LinphoneCallEnd, /**<The call ended normally*/
321 LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
322 LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
323 LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
324 LinphoneCallUpdated, /**<The remote accepted the call update initiated by us */
325 LinphoneCallReleased /**< The call object is no more retained by the core */
328 const char *linphone_call_state_to_string(LinphoneCallState cs);
330 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
331 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
332 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
333 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
334 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
335 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
336 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
337 LinphoneCall * linphone_call_ref(LinphoneCall *call);
338 void linphone_call_unref(LinphoneCall *call);
339 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
340 const char *linphone_call_get_refer_to(const LinphoneCall *call);
341 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
342 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
343 int linphone_call_get_duration(const LinphoneCall *call);
344 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
345 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
346 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
347 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
348 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
349 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
350 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
351 float linphone_call_get_play_volume(LinphoneCall *call);
352 float linphone_call_get_record_volume(LinphoneCall *call);
353 float linphone_call_get_current_quality(LinphoneCall *call);
354 float linphone_call_get_average_quality(LinphoneCall *call);
355 const char* linphone_call_get_authentication_token(LinphoneCall *call);
356 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
357 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
358 void linphone_call_send_vfu_request(LinphoneCall *call);
359 void *linphone_call_get_user_pointer(LinphoneCall *call);
360 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
361 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
362 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
365 * Enables or disable echo cancellation for this call
369 * @ingroup media_parameters
371 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
373 * Returns TRUE if echo cancellation is enabled.
375 * @ingroup media_parameters
377 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
379 * Enables or disable echo limiter for this call
383 * @ingroup media_parameters
385 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
387 * Returns TRUE if echo limiter is enabled.
389 * @ingroup media_parameters
391 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
394 * Enable or disable video for this call.
398 * @ingroup media_parameters
400 void linphone_call_enable_video(LinphoneCall *call, bool_t enabled);
402 /*keep this in sync with mediastreamer2/msvolume.h*/
405 * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
408 #define LINPHONE_VOLUME_DB_LOWEST (-120)
411 * @addtogroup proxies
415 * The LinphoneProxyConfig object represents a proxy configuration to be used
416 * by the LinphoneCore object.
417 * Its fields must not be used directly in favour of the accessors methods.
418 * Once created and filled properly the LinphoneProxyConfig can be given to
419 * LinphoneCore with linphone_core_add_proxy_config().
420 * This will automatically triggers the registration, if enabled.
422 * The proxy configuration are persistent to restarts because they are saved
423 * in the configuration file. As a consequence, after linphone_core_new() there
424 * might already be a list of configured proxy that can be examined with
425 * linphone_core_get_proxy_config_list().
427 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
428 * that is used by default for calls.
430 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
433 * LinphoneRegistrationState describes proxy registration states.
435 typedef enum _LinphoneRegistrationState{
436 LinphoneRegistrationNone, /**<Initial state for registrations */
437 LinphoneRegistrationProgress, /**<Registration is in progress */
438 LinphoneRegistrationOk, /**< Registration is successful */
439 LinphoneRegistrationCleared, /**< Unregistration succeeded */
440 LinphoneRegistrationFailed /**<Registration failed */
441 }LinphoneRegistrationState;
444 * Human readable version of the #LinphoneRegistrationState
447 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
449 LinphoneProxyConfig *linphone_proxy_config_new(void);
450 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
451 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
452 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
453 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
455 * Indicates either or not, REGISTRATION 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, registration will be engaged
460 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
461 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
462 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
463 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
465 * Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
466 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
467 * @param obj object pointer
468 * @param val if true, publish will be engaged
471 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
472 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
473 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
475 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
476 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
477 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
479 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
480 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
481 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
482 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
483 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
484 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
485 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
486 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
488 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
489 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
491 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
493 /* destruction is called automatically when removing the proxy config */
494 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
495 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
496 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
497 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
499 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
501 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
503 * attached a user data to a proxy config
505 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
507 * get user data to a proxy config. return null if any
509 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
515 typedef struct _LinphoneAccountCreator{
516 struct _LinphoneCore *lc;
517 struct _SipSetupContext *ssctx;
525 }LinphoneAccountCreator;
527 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
528 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
529 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
530 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
531 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
532 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
533 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
534 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
535 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
536 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
537 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
538 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
539 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
541 struct _LinphoneAuthInfo;
544 * @ingroup authentication
545 * Object holding authentication information.
547 * @note The object's fields should not be accessed directly. Prefer using
548 * the accessor methods.
550 * In most case, authentication information consists of a username and password.
551 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
552 * different SIP domains.
554 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
555 * order to become known and used automatically when needed.
556 * Use linphone_core_add_auth_info() for that purpose.
558 * The LinphoneCore object can take the initiative to request authentication information
559 * when needed to the application through the auth_info_requested callback of the
560 * LinphoneCoreVTable structure.
562 * The application can respond to this information request later using
563 * linphone_core_add_auth_info(). This will unblock all pending authentication
564 * transactions and retry them with authentication headers.
567 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
569 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
570 const char *passwd, const char *ha1,const char *realm);
571 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
572 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
573 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
575 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
576 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
577 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
579 /* you don't need those function*/
580 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
581 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
584 struct _LinphoneChatRoom;
586 * @addtogroup chatroom
590 * A chat room is the place where text messages are exchanged.
591 * <br> Can be created by linphone_core_create_chat_room().
593 typedef struct _LinphoneChatRoom LinphoneChatRoom;
595 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
596 * @param lc #LinphoneCore object
597 * @param to destination address for messages
598 * @return #LinphoneChatRoom where messaging can take place.
600 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
603 * @param cr #LinphoneChatRoom object
605 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
609 * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
610 * @param cr #LinphoneChatRoom object
611 * @return #LinphoneAddress peer address
613 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
615 * send a message to peer member of this chat room.
616 * @param cr #LinphoneChatRoom object
617 * @param msg message to be sent
619 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
621 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
622 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
630 * @addtogroup initializing
635 * LinphoneGlobalState describes the global state of the LinphoneCore object.
636 * It is notified via the LinphoneCoreVTable::global_state_changed
638 typedef enum _LinphoneGlobalState{
640 LinphoneGlobalStartup,
642 LinphoneGlobalShutdown
643 }LinphoneGlobalState;
645 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
648 /**Call state notification callback prototype*/
649 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
650 /**Call state notification callback prototype*/
651 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
652 /**Call encryption changed callback prototype*/
653 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
656 * Registration state notification callback prototype
658 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
659 /** Callback prototype */
660 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
661 /** Callback prototype */
662 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
663 /** Callback prototype */
664 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
665 /** Callback prototype */
666 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
667 /** Callback prototype */
668 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
669 /** Callback prototype */
670 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
672 * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
673 * @param lc #LinphoneCore object .
674 * @param lf Updated #LinphoneFriend .
676 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
678 * Reports that a new subscription request has been received and wait for a decision.
679 * <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
680 * @param lc #LinphoneCore object
681 * @param lf #LinphoneFriend corresponding to the subscriber
682 * @param url of the subscriber
685 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
686 /** Callback prototype */
687 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
688 /** Callback prototype */
689 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
693 * @param lc #LinphoneCore object
694 * @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.
695 * @param from #LinphoneAddress from
696 * @param message incoming message
698 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
699 /** Callback prototype */
700 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
701 /** Callback prototype */
702 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
703 /** Callback prototype */
704 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
705 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
706 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
707 /** Callback prototype for receiving quality statistics for calls*/
708 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
711 * This structure holds all callbacks that the application should implement.
714 typedef struct _LinphoneVTable{
715 LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
716 LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
717 LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
718 NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
719 NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
720 AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
721 CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
722 TextMessageReceived text_received; /**< A text message has been received */
723 DtmfReceived dtmf_received; /**< A dtmf has been received received */
724 ReferReceived refer_received; /**< An out of call refer was received */
725 CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
726 LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
727 BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
728 NotifyReceivedCb notify_recv; /**< Other notifications*/
729 CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
730 DisplayStatusCb display_status; /**< Callback that notifies various events with human readable text.*/
731 DisplayMessageCb display_message;/**< Callback to display a message to the user */
732 DisplayMessageCb display_warning;/** Callback to display a warning to the user */
733 DisplayUrlCb display_url;
734 ShowInterfaceCb show; /**< Notifies the application that it should show up*/
735 } LinphoneCoreVTable;
741 typedef struct _LCCallbackObj
743 LinphoneCoreCbFunc _func;
749 typedef enum _LinphoneFirewallPolicy{
750 LinphonePolicyNoFirewall,
751 LinphonePolicyUseNatAddress,
752 LinphonePolicyUseStun,
754 } LinphoneFirewallPolicy;
756 typedef enum _LinphoneWaitingState{
757 LinphoneWaitingStart,
758 LinphoneWaitingProgress,
759 LinphoneWaitingFinished
760 } LinphoneWaitingState;
761 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
766 void linphone_core_enable_logs(FILE *file);
767 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
768 void linphone_core_disable_logs(void);
769 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
770 void linphone_core_set_user_agent(const char *ua_name, const char *version);
771 const char *linphone_core_get_version(void);
773 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
774 const char *config_path, const char *factory_config, void* userdata);
776 /* function to be periodically called in a main loop */
777 void linphone_core_iterate(LinphoneCore *lc);
779 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
781 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
783 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
785 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
787 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
789 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
791 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
793 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
795 void linphone_core_notify_incoming_call(LinphoneCore *lc, LinphoneCall *call);
797 bool_t linphone_core_in_call(const LinphoneCore *lc);
799 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
801 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
803 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
805 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
807 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
809 int linphone_core_terminate_all_calls(LinphoneCore *lc);
811 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
813 int linphone_core_pause_all_calls(LinphoneCore *lc);
815 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
817 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
819 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
821 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
823 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
825 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
827 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
829 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
831 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
833 const char * linphone_core_get_identity(LinphoneCore *lc);
835 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
836 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
838 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
839 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
841 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
842 const char * linphone_core_get_identity(LinphoneCore *lc);
843 /*0= no bandwidth limit*/
844 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
845 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
847 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
848 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
850 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
851 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
853 * set audio packetization time linphone expect to receive from peer
854 * @ingroup media_parameters
857 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
859 * get audio packetization time linphone expect to receive from peer, 0 means unspecified
860 * @ingroup media_parameters
862 int linphone_core_get_download_ptime(LinphoneCore *lc);
864 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
866 int linphone_core_get_upload_ptime(LinphoneCore *lc);
868 /* returns a MSList of PayloadType */
869 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
871 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
872 /* returns a MSList of PayloadType */
873 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
875 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
877 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
879 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
881 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate) ;
883 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
885 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
887 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
889 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
891 void linphone_core_clear_proxy_config(LinphoneCore *lc);
893 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
895 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
897 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
899 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
901 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
903 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
905 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
907 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
909 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
911 void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info);
913 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
915 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
917 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
919 int linphone_core_get_audio_port(const LinphoneCore *lc);
921 int linphone_core_get_video_port(const LinphoneCore *lc);
923 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
925 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
927 void linphone_core_set_video_port(LinphoneCore *lc, int port);
929 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
931 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
933 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
935 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
937 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
939 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
941 int linphone_core_get_sip_port(LinphoneCore *lc);
943 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
945 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
948 * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
949 * @param lc #LinphoneCore
950 * @return socket file descriptor
952 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
954 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
956 int linphone_core_get_inc_timeout(LinphoneCore *lc);
958 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
960 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
962 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
964 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
966 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
968 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
970 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
972 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
974 /* sound functions */
975 /* returns a null terminated static array of string describing the sound devices */
976 const char** linphone_core_get_sound_devices(LinphoneCore *lc);
977 void linphone_core_reload_sound_devices(LinphoneCore *lc);
978 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
979 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
980 int linphone_core_get_ring_level(LinphoneCore *lc);
981 int linphone_core_get_play_level(LinphoneCore *lc);
982 int linphone_core_get_rec_level(LinphoneCore *lc);
983 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
984 void linphone_core_set_play_level(LinphoneCore *lc, int level);
986 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
988 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
989 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
990 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
991 const char * linphone_core_get_playback_device(LinphoneCore *lc);
992 const char * linphone_core_get_capture_device(LinphoneCore *lc);
993 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
994 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
995 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
996 char linphone_core_get_sound_source(LinphoneCore *lc);
997 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
998 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
999 const char *linphone_core_get_ring(const LinphoneCore *lc);
1000 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1001 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1002 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1003 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1005 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1006 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1008 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1009 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1010 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1012 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1013 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1015 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1016 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1018 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1022 * @ingroup media_parameters
1024 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1026 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
1027 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1029 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1030 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1033 /* returns a list of LinphoneCallLog */
1034 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1035 void linphone_core_clear_call_logs(LinphoneCore *lc);
1036 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1037 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1038 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1041 bool_t linphone_core_video_supported(LinphoneCore *lc);
1042 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1043 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1044 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1045 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1047 typedef struct MSVideoSizeDef{
1051 /* returns a zero terminated table of MSVideoSizeDef*/
1052 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1053 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1054 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1055 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1057 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1058 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1060 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1061 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1064 /* returns a null terminated static array of string describing the webcams */
1065 void linphone_core_reload_video_devices(LinphoneCore *lc);
1066 const char** linphone_core_get_video_devices(const LinphoneCore *lc);
1067 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1068 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1070 /* Set static picture to be used when "Static picture" is the video device */
1071 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1073 /* Set and get frame rate for static picture */
1074 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1075 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1077 /*function to be used for eventually setting window decorations (icons, title...)*/
1078 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1079 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1081 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1082 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1084 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1085 int linphone_core_get_device_rotation(LinphoneCore *lc );
1086 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1088 /* start or stop streaming video in case of embedded window */
1089 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1091 /*play/record support: use files instead of soundcard*/
1092 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1093 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1094 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1096 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1097 void linphone_core_stop_dtmf(LinphoneCore *lc);
1099 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1102 int linphone_core_get_mtu(const LinphoneCore *lc);
1103 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1106 * @ingroup network_parameters
1107 * This method is called by the application to notify the linphone core library when network is reachable.
1108 * Calling this method with true trigger linphone to initiate a registration process for all proxy
1109 * configuration with parameter register set to enable.
1110 * This method disable the automatic registration mode. It means you must call this method after each network state changes
1113 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1115 * @ingroup network_parameters
1116 * return network state either as positioned by the application or by linphone
1118 bool_t linphone_core_is_network_reachabled(LinphoneCore* lc);
1121 * @ingroup network_parameters
1122 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1124 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1126 * @ingroup network_parameters
1127 * Is signaling keep alive
1129 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1131 void *linphone_core_get_user_data(LinphoneCore *lc);
1132 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1134 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1135 the config file with your own sections */
1136 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1138 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1139 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1141 /*returns the list of registered SipSetup (linphonecore plugins) */
1142 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1144 void linphone_core_destroy(LinphoneCore *lc);
1146 /*for advanced users:*/
1147 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1148 struct _LinphoneRtpTransportFactories{
1149 LinphoneRtpTransportFactoryFunc audio_rtp_func;
1150 void *audio_rtp_func_data;
1151 LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1152 void *audio_rtcp_func_data;
1153 LinphoneRtpTransportFactoryFunc video_rtp_func;
1154 void *video_rtp_func_data;
1155 LinphoneRtpTransportFactoryFunc video_rtcp_func;
1156 void *video_rtcp_func_data;
1158 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1160 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1162 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1164 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1166 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1168 * force registration refresh to be initiated upon next iterate
1171 void linphone_core_refresh_registers(LinphoneCore* lc);
1173 /* Path to the file storing secrets cache */
1174 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1177 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1179 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1180 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1181 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1182 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1183 int linphone_core_enter_conference(LinphoneCore *lc);
1184 int linphone_core_leave_conference(LinphoneCore *lc);
1185 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1187 int linphone_core_terminate_conference(LinphoneCore *lc);
1188 int linphone_core_get_conference_size(LinphoneCore *lc);
1190 int linphone_core_get_max_calls(LinphoneCore *lc);
1191 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1193 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1195 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1198 * Choose media encryption policy to be used for RTP packets
1200 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1201 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1203 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1205 * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1206 * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1208 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1211 * Init call params using LinphoneCore's current configuration
1213 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1216 * True if tunnel support was compiled.
1218 bool_t linphone_core_tunnel_available(void);
1220 typedef struct LinphoneTunnel LinphoneTunnel;
1222 * get tunnel instance if available
1224 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1226 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);