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 containing 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 */
159 const char* call_id; /**unique id of a call*/
164 * Enum describing type of media encryption types.
166 enum LinphoneMediaEncryption {
167 LinphoneMediaEncryptionNone,
168 LinphoneMediaEncryptionSRTP,
169 LinphoneMediaEncryptionZRTP
173 * Enum describing type of media encryption types.
175 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
178 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
179 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
180 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
181 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
182 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
183 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
184 char * linphone_call_log_to_str(LinphoneCallLog *cl);
186 struct _LinphoneCallParams;
189 * The LinphoneCallParams is an object containing various call related parameters.
190 * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
193 typedef struct _LinphoneCallParams LinphoneCallParams;
195 const PayloadType* linphone_call_params_get_used_audio_codec(const LinphoneCallParams *cp);
196 const PayloadType* linphone_call_params_get_used_video_codec(const LinphoneCallParams *cp);
197 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
198 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
199 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
200 LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
201 void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
202 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
203 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
204 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
205 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
206 void linphone_call_params_destroy(LinphoneCallParams *cp);
207 bool_t linphone_call_params_low_bandwidth_enabled(const LinphoneCallParams *cp);
208 void linphone_call_params_enable_low_bandwidth(LinphoneCallParams *cp, bool_t enabled);
211 * Enum describing failure reasons.
212 * @ingroup initializing
214 enum _LinphoneReason{
216 LinphoneReasonNoResponse, /**<No response received from remote*/
217 LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
218 LinphoneReasonDeclined, /**<The call has been declined*/
219 LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
220 LinphoneReasonNotAnswered, /**<The call was not answered in time*/
221 LinphoneReasonBusy /**<Phone line was busy */
225 * Enum describing failure reasons.
226 * @ingroup initializing
228 typedef enum _LinphoneReason LinphoneReason;
230 const char *linphone_reason_to_string(LinphoneReason err);
233 * Structure describing policy regarding video streams establishments.
234 * @ingroup media_parameters
236 struct _LinphoneVideoPolicy{
237 bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/
238 bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
243 * Structure describing policy regarding video streams establishments.
244 * @ingroup media_parameters
246 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
249 * The LinphoneCall object represents a call issued or received by the LinphoneCore
250 * @ingroup call_control
252 struct _LinphoneCall;
254 * The LinphoneCall object represents a call issued or received by the LinphoneCore
255 * @ingroup call_control
257 typedef struct _LinphoneCall LinphoneCall;
261 * @addtogroup call_misc
265 #define LINPHONE_CALL_STATS_AUDIO 0
266 #define LINPHONE_CALL_STATS_VIDEO 1
269 * Enum describing ICE states.
270 * @ingroup initializing
272 enum _LinphoneIceState{
273 LinphoneIceStateNotActivated, /**< ICE has not been activated for this call */
274 LinphoneIceStateFailed, /**< ICE processing has failed */
275 LinphoneIceStateInProgress, /**< ICE process is in progress */
276 LinphoneIceStateHostConnection, /**< ICE has established a direct connection to the remote host */
277 LinphoneIceStateReflexiveConnection, /**< ICE has established a connection to the remote host through one or several NATs */
278 LinphoneIceStateRelayConnection /**< ICE has established a connection through a relay */
282 * Enum describing Ice states.
283 * @ingroup initializing
285 typedef enum _LinphoneIceState LinphoneIceState;
288 * Enum describing uPnP states.
289 * @ingroup initializing
291 enum _LinphoneUpnpState{
292 LinphoneUpnpStateIdle, /**< uPnP is not activate */
293 LinphoneUpnpStatePending, /**< uPnP process is in progress */
294 LinphoneUpnpStateAdding, /**< Internal use: Only used by port binding */
295 LinphoneUpnpStateRemoving, /**< Internal use: Only used by port binding */
296 LinphoneUpnpStateNotAvailable, /**< uPnP is not available */
297 LinphoneUpnpStateOk, /**< uPnP is enabled */
298 LinphoneUpnpStateKo, /**< uPnP processing has failed */
302 * Enum describing uPnP states.
303 * @ingroup initializing
305 typedef enum _LinphoneUpnpState LinphoneUpnpState;
309 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
311 * 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
312 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
314 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
316 typedef struct _LinphoneCallStats LinphoneCallStats;
319 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
321 * 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
322 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
324 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
326 struct _LinphoneCallStats {
327 int type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
328 jitter_stats_t jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
329 mblk_t* received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
330 mblk_t* sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
331 float round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
332 LinphoneIceState ice_state; /**< State of ICE processing. */
333 LinphoneUpnpState upnp_state; /**< State of uPnP processing. */
334 float download_bandwidth; /**<Download bandwidth measurement of received stream, expressed in kbit/s, including IP/UDP/RTP headers*/
335 float upload_bandwidth; /**<Download bandwidth measurement of sent stream, expressed in kbit/s, including IP/UDP/RTP headers*/
342 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
343 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
346 /** Callback prototype */
347 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
350 * LinphoneCallState enum represents the different state a call can reach into.
351 * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
352 * @ingroup call_control
354 typedef enum _LinphoneCallState{
355 LinphoneCallIdle, /**<Initial call state */
356 LinphoneCallIncomingReceived, /**<This is a new incoming call */
357 LinphoneCallOutgoingInit, /**<An outgoing call is started */
358 LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
359 LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
360 LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
361 LinphoneCallConnected, /**<Connected, the call is answered */
362 LinphoneCallStreamsRunning, /**<The media streams are established and running*/
363 LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
364 LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
365 LinphoneCallResuming, /**<The call is being resumed by local end*/
366 LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
367 LinphoneCallError, /**<The call encountered an error*/
368 LinphoneCallEnd, /**<The call ended normally*/
369 LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
370 LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
371 LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
372 LinphoneCallUpdating, /**<A call update has been initiated by us */
373 LinphoneCallReleased /**< The call object is no more retained by the core */
376 const char *linphone_call_state_to_string(LinphoneCallState cs);
378 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
379 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
380 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
381 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
382 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
383 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
384 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
385 LinphoneCall * linphone_call_ref(LinphoneCall *call);
386 void linphone_call_unref(LinphoneCall *call);
387 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
388 const char *linphone_call_get_refer_to(const LinphoneCall *call);
389 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
390 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
391 int linphone_call_get_duration(const LinphoneCall *call);
392 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
393 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
394 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
395 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
396 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
397 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
398 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
399 float linphone_call_get_play_volume(LinphoneCall *call);
400 float linphone_call_get_record_volume(LinphoneCall *call);
401 float linphone_call_get_current_quality(LinphoneCall *call);
402 float linphone_call_get_average_quality(LinphoneCall *call);
403 const char* linphone_call_get_authentication_token(LinphoneCall *call);
404 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
405 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
406 void linphone_call_send_vfu_request(LinphoneCall *call);
407 void *linphone_call_get_user_pointer(LinphoneCall *call);
408 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
409 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
410 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
411 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);
413 * Return TRUE if this call is currently part of a conference
414 *@param call #LinphoneCall
415 *@return TRUE if part of a conference.
417 @ingroup call_control
419 bool_t linphone_call_is_in_conference(const LinphoneCall *call);
421 * Enables or disable echo cancellation for this call
425 * @ingroup media_parameters
427 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
429 * Returns TRUE if echo cancellation is enabled.
431 * @ingroup media_parameters
433 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
435 * Enables or disable echo limiter for this call
439 * @ingroup media_parameters
441 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
443 * Returns TRUE if echo limiter is enabled.
445 * @ingroup media_parameters
447 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
449 /*keep this in sync with mediastreamer2/msvolume.h*/
452 * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
455 #define LINPHONE_VOLUME_DB_LOWEST (-120)
458 * @addtogroup proxies
462 * The LinphoneProxyConfig object represents a proxy configuration to be used
463 * by the LinphoneCore object.
464 * Its fields must not be used directly in favour of the accessors methods.
465 * Once created and filled properly the LinphoneProxyConfig can be given to
466 * LinphoneCore with linphone_core_add_proxy_config().
467 * This will automatically triggers the registration, if enabled.
469 * The proxy configuration are persistent to restarts because they are saved
470 * in the configuration file. As a consequence, after linphone_core_new() there
471 * might already be a list of configured proxy that can be examined with
472 * linphone_core_get_proxy_config_list().
474 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
475 * that is used by default for calls.
477 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
480 * LinphoneRegistrationState describes proxy registration states.
482 typedef enum _LinphoneRegistrationState{
483 LinphoneRegistrationNone, /**<Initial state for registrations */
484 LinphoneRegistrationProgress, /**<Registration is in progress */
485 LinphoneRegistrationOk, /**< Registration is successful */
486 LinphoneRegistrationCleared, /**< Unregistration succeeded */
487 LinphoneRegistrationFailed /**<Registration failed */
488 }LinphoneRegistrationState;
491 * Human readable version of the #LinphoneRegistrationState
494 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
496 LinphoneProxyConfig *linphone_proxy_config_new(void);
497 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
498 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
499 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
500 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
502 * Indicates either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
503 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
504 * @param obj object pointer
505 * @param val if true, registration will be engaged
507 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
508 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
509 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
510 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
512 * Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
513 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
514 * @param obj object pointer
515 * @param val if true, publish will be engaged
518 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
519 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
520 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
522 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
523 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
524 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
526 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
527 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
528 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
529 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
530 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
531 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
532 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
533 const char *linphone_proxy_config_get_contact_parameters(const LinphoneProxyConfig *obj);
534 void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, const char *contact_params);
535 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
537 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
538 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
540 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
542 /* destruction is called automatically when removing the proxy config */
543 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
544 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
545 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
546 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
548 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
550 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
552 * attached a user data to a proxy config
554 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
556 * get user data to a proxy config. return null if any
558 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
564 typedef struct _LinphoneAccountCreator{
565 struct _LinphoneCore *lc;
566 struct _SipSetupContext *ssctx;
574 }LinphoneAccountCreator;
576 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
577 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
578 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
579 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
580 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
581 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
582 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
583 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
584 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
585 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
586 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
587 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
588 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
590 struct _LinphoneAuthInfo;
593 * @ingroup authentication
594 * Object holding authentication information.
596 * @note The object's fields should not be accessed directly. Prefer using
597 * the accessor methods.
599 * In most case, authentication information consists of a username and password.
600 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
601 * different SIP domains.
603 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
604 * order to become known and used automatically when needed.
605 * Use linphone_core_add_auth_info() for that purpose.
607 * The LinphoneCore object can take the initiative to request authentication information
608 * when needed to the application through the auth_info_requested callback of the
609 * LinphoneCoreVTable structure.
611 * The application can respond to this information request later using
612 * linphone_core_add_auth_info(). This will unblock all pending authentication
613 * transactions and retry them with authentication headers.
616 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
618 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
619 const char *passwd, const char *ha1,const char *realm);
620 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
621 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
622 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
624 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
625 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
626 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
628 /* you don't need those function*/
629 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
630 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
633 struct _LinphoneChatRoom;
635 * @addtogroup chatroom
640 * A chat room message to old content to be sent.
641 * <br> Can be created by linphone_chat_room_create_message().
643 typedef struct _LinphoneChatMessage LinphoneChatMessage;
646 * A chat room is the place where text messages are exchanged.
647 * <br> Can be created by linphone_core_create_chat_room().
649 typedef struct _LinphoneChatRoom LinphoneChatRoom;
652 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
653 * @param lc #LinphoneCore object
654 * @param to destination address for messages
655 * @return #LinphoneChatRoom where messaging can take place.
657 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
660 * @param cr #LinphoneChatRoom object
662 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
665 * create a message attached to a dedicated chat room;
667 LinphoneChatMessage* linphone_chat_room_create_message(const LinphoneChatRoom *cr,const char* message);
671 * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
672 * @param cr #LinphoneChatRoom object
673 * @return #LinphoneAddress peer address
675 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
677 * send a message to peer member of this chat room.
678 * @param cr #LinphoneChatRoom object
679 * @param msg message to be sent
681 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
683 *LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
685 typedef enum _LinphoneChatMessageStates {
686 LinphoneChatMessageStateIdle, /**<initial state*/
687 LinphoneChatMessageStateInProgress, /**<delivery in progress**/
688 LinphoneChatMessageStateDelivered, /**<message succesffully delivered an acknoleged by remote end point*/
689 LinphoneChatMessageStateNotDelivered /**<message was not delivered*/
690 }LinphoneChatMessageState;
696 const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
699 * Clone a chat message
700 *@param message #LinphoneChatMessage obj
701 *@return #LinphoneChatMessage
703 LinphoneChatMessage* linphone_chat_message_clone(const LinphoneChatMessage* message);
705 * Set origin of the message
706 *@param message #LinphoneChatMessage obj
707 *@param from #LinphoneAddress origin of this message (copied)
709 void linphone_chat_message_set_from(LinphoneChatMessage* message, const LinphoneAddress* from);
712 * Get origin of the message
713 *@param message #LinphoneChatMessage obj
714 *@return #LinphoneAddress
716 LinphoneAddress* linphone_chat_message_get_from(const LinphoneChatMessage* message);
719 * Linphone message can carry external body as defined by rfc2017
720 * @param message #LinphoneChatMessage
721 * @return external body url or NULL if not present.
723 const char* linphone_chat_message_get_external_body_url(const LinphoneChatMessage* message);
726 * Linphone message can carry external body as defined by rfc2017
728 * @param message a LinphoneChatMessage
729 * @param url ex: access-type=URL; URL="http://www.foo.com/file"
731 void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
734 * Get text part of this message
735 * @return text or NULL if no text.
737 const char * linphone_chat_message_get_text(const LinphoneChatMessage* message);
739 * user pointer get function
742 void* linphone_chat_message_get_user_data(const LinphoneChatMessage* message);
744 * user pointer set function
746 void linphone_chat_message_set_user_data(LinphoneChatMessage* message,void*);
749 * Call back used to notify message delivery status
750 *@param msg #LinphoneChatMessage object
751 *@param status LinphoneChatMessageState
752 *@param ud application user data
754 typedef void (*LinphoneChatMessageStateChangeCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
756 * send a message to peer member of this chat room.
757 * @param cr #LinphoneChatRoom object
758 * @param msg #LinphoneChatMessage message to be sent
759 * @param status_cb LinphoneChatMessageStateChangeCb status callback invoked when message is delivered or could not be delivered. May be NULL
760 * @param ud user data for the status cb.
762 void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage* msg,LinphoneChatMessageStateChangeCb status_cb,void* ud);
763 LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr);
764 LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
765 char* linphone_chat_message_get_message(LinphoneChatMessage *msg);
766 const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
767 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
768 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
776 * @addtogroup initializing
781 * LinphoneGlobalState describes the global state of the LinphoneCore object.
782 * It is notified via the LinphoneCoreVTable::global_state_changed
784 typedef enum _LinphoneGlobalState{
786 LinphoneGlobalStartup,
788 LinphoneGlobalShutdown
789 }LinphoneGlobalState;
791 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
794 /**Call state notification callback prototype*/
795 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
796 /**Call state notification callback prototype*/
797 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
798 /**Call encryption changed callback prototype*/
799 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
802 * Registration state notification callback prototype
804 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
805 /** Callback prototype */
806 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
807 /** Callback prototype */
808 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
809 /** Callback prototype */
810 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
811 /** Callback prototype */
812 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
813 /** Callback prototype */
814 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
815 /** Callback prototype */
816 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
818 * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
819 * @param lc #LinphoneCore object .
820 * @param lf Updated #LinphoneFriend .
822 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
824 * Reports that a new subscription request has been received and wait for a decision.
825 * <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
826 * @param lc #LinphoneCore object
827 * @param lf #LinphoneFriend corresponding to the subscriber
828 * @param url of the subscriber
831 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
832 /** Callback prototype */
833 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
834 /** Callback prototype */
835 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
838 * @deprecated use #MessageReceived instead.
840 * @param lc #LinphoneCore object
841 * @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.
842 * @param from #LinphoneAddress from
843 * @param message incoming message
845 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
847 * Chat message callback prototype
849 * @param lc #LinphoneCore object
850 * @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.
851 * @param LinphoneChatMessage incoming message
853 typedef void (*MessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
855 /** Callback prototype */
856 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
857 /** Callback prototype */
858 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
859 /** Callback prototype */
860 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
861 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
862 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
863 /** Callback prototype for receiving quality statistics for calls*/
864 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
867 * This structure holds all callbacks that the application should implement.
870 typedef struct _LinphoneVTable{
871 LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
872 LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
873 LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
874 NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
875 NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
876 AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
877 CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
878 TextMessageReceived text_received; /** @deprecated, use #message_received instead <br> A text message has been received */
879 MessageReceived message_received; /** a message is received, can be text or external body*/
880 DtmfReceived dtmf_received; /**< A dtmf has been received received */
881 ReferReceived refer_received; /**< An out of call refer was received */
882 CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
883 LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
884 BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
885 NotifyReceivedCb notify_recv; /**< Other notifications*/
886 CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
887 DisplayStatusCb display_status; /**< DEPRECATED Callback that notifies various events with human readable text.*/
888 DisplayMessageCb display_message;/**< DEPRECATED Callback to display a message to the user */
889 DisplayMessageCb display_warning;/**< DEPRECATED Callback to display a warning to the user */
890 DisplayUrlCb display_url; /**< DEPRECATED */
891 ShowInterfaceCb show; /**< DEPRECATED Notifies the application that it should show up*/
892 } LinphoneCoreVTable;
898 typedef struct _LCCallbackObj
900 LinphoneCoreCbFunc _func;
906 typedef enum _LinphoneFirewallPolicy{
907 LinphonePolicyNoFirewall,
908 LinphonePolicyUseNatAddress,
909 LinphonePolicyUseStun,
910 LinphonePolicyUseIce,
911 LinphonePolicyUseUpnp,
912 } LinphoneFirewallPolicy;
914 typedef enum _LinphoneWaitingState{
915 LinphoneWaitingStart,
916 LinphoneWaitingProgress,
917 LinphoneWaitingFinished
918 } LinphoneWaitingState;
919 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
924 void linphone_core_enable_logs(FILE *file);
925 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
926 void linphone_core_disable_logs(void);
927 const char *linphone_core_get_version(void);
928 const char *linphone_core_get_user_agent_name(void);
929 const char *linphone_core_get_user_agent_version(void);
931 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
932 const char *config_path, const char *factory_config, void* userdata);
934 /* function to be periodically called in a main loop */
935 /* For ICE to work properly it should be called every 20ms */
936 void linphone_core_iterate(LinphoneCore *lc);
937 #if 0 /*not implemented yet*/
939 * @ingroup initializing
940 * Provide Linphone Core with an unique identifier. This be later used to identified contact address coming from this device.
941 * Value is not saved.
943 * @param string identifying the device, can be EMEI or UDID
946 void linphone_core_set_device_identifier(LinphoneCore *lc,const char* device_id);
948 * @ingroup initializing
949 * get Linphone unique identifier
952 const char* linphone_core_get_device_identifier(const LinphoneCore *lc);
956 /*sets the user-agent string in sip messages, ideally called just after linphone_core_new() or linphone_core_init() */
957 void linphone_core_set_user_agent(LinphoneCore *lc, const char *ua_name, const char *version);
959 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
961 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
963 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
965 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
967 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
969 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
971 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
973 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
975 bool_t linphone_core_in_call(const LinphoneCore *lc);
977 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
979 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
981 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
983 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
985 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
987 int linphone_core_decline_call(LinphoneCore *lc, LinphoneCall * call, LinphoneReason reason);
989 int linphone_core_terminate_all_calls(LinphoneCore *lc);
991 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
993 int linphone_core_pause_all_calls(LinphoneCore *lc);
995 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
997 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
999 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
1001 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
1003 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
1005 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
1007 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
1009 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
1011 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
1013 const char * linphone_core_get_identity(LinphoneCore *lc);
1015 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
1016 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
1018 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
1019 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
1021 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
1022 const char * linphone_core_get_identity(LinphoneCore *lc);
1023 /*0= no bandwidth limit*/
1024 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
1025 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
1027 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
1028 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
1030 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
1031 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
1033 * set audio packetization time linphone expect to receive from peer
1034 * @ingroup media_parameters
1037 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
1039 * get audio packetization time linphone expect to receive from peer, 0 means unspecified
1040 * @ingroup media_parameters
1042 int linphone_core_get_download_ptime(LinphoneCore *lc);
1044 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
1046 int linphone_core_get_upload_ptime(LinphoneCore *lc);
1048 /* returns a MSList of PayloadType */
1049 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
1051 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
1052 /* returns a MSList of PayloadType */
1053 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
1055 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
1057 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
1059 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
1062 * Wildcard value used by #linphone_core_find_payload_type to ignore rate in search algirithm
1063 * @ingroup media_parameters
1065 #define LINPHONE_FIND_PAYLOAD_IGNORE_RATE -1
1067 * Wildcard value used by #linphone_core_find_payload_type to ignore channel in search algirithm
1068 * @ingroup media_parameters
1070 #define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS -1
1072 * Get payload type from mime type and clock rate
1073 * @ingroup media_parameters
1074 * This function searches in audio and video codecs for the given payload type name and clockrate.
1075 * @param lc #LinphoneCore object
1076 * @param type payload mime type (I.E SPEEX, PCMU, VP8)
1077 * @param rate can be #LINPHONE_FIND_PAYLOAD_IGNORE_RATE
1078 * @param channels number of channels, can be #LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
1079 * @return Returns NULL if not found.
1081 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate, int channels) ;
1083 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
1085 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
1087 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
1091 *Create a proxy config with default value from Linphone core.
1092 *@param lc #LinphoneCore object
1093 *@return #LinphoneProxyConfig with defualt value set
1095 LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *lc);
1097 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1099 void linphone_core_clear_proxy_config(LinphoneCore *lc);
1101 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1103 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
1105 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
1107 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
1109 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
1111 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1113 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1115 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
1117 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
1119 void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info);
1121 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
1123 void linphone_core_enable_audio_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1125 bool_t linphone_core_audio_adaptive_jittcomp_enabled(LinphoneCore *lc);
1127 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
1129 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
1131 void linphone_core_enable_video_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1133 bool_t linphone_core_video_adaptive_jittcomp_enabled(LinphoneCore *lc);
1135 int linphone_core_get_video_jittcomp(LinphoneCore *lc);
1137 void linphone_core_set_video_jittcomp(LinphoneCore *lc, int value);
1139 int linphone_core_get_audio_port(const LinphoneCore *lc);
1141 void linphone_core_get_audio_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1143 int linphone_core_get_video_port(const LinphoneCore *lc);
1145 void linphone_core_get_video_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1147 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
1149 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
1151 void linphone_core_set_audio_port_range(LinphoneCore *lc, int min_port, int max_port);
1153 void linphone_core_set_video_port(LinphoneCore *lc, int port);
1155 void linphone_core_set_video_port_range(LinphoneCore *lc, int min_port, int max_port);
1157 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
1159 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
1161 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
1163 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
1165 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
1167 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
1169 int linphone_core_get_sip_port(LinphoneCore *lc);
1171 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
1173 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
1176 * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
1177 * @param lc #LinphoneCore
1178 * @return socket file descriptor
1180 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
1182 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
1184 int linphone_core_get_inc_timeout(LinphoneCore *lc);
1186 void linphone_core_set_in_call_timeout(LinphoneCore *lc, int seconds);
1188 int linphone_core_get_in_call_timeout(LinphoneCore *lc);
1190 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
1192 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
1194 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
1196 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
1198 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
1200 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
1202 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
1204 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
1206 /* sound functions */
1207 /* returns a null terminated static array of string describing the sound devices */
1208 const char** linphone_core_get_sound_devices(LinphoneCore *lc);
1209 void linphone_core_reload_sound_devices(LinphoneCore *lc);
1210 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
1211 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
1212 int linphone_core_get_ring_level(LinphoneCore *lc);
1213 int linphone_core_get_play_level(LinphoneCore *lc);
1214 int linphone_core_get_rec_level(LinphoneCore *lc);
1215 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
1216 void linphone_core_set_play_level(LinphoneCore *lc, int level);
1218 void linphone_core_set_mic_gain_db(LinphoneCore *lc, float level);
1219 float linphone_core_get_mic_gain_db(LinphoneCore *lc);
1220 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
1221 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
1223 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
1224 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
1225 const char * linphone_core_get_playback_device(LinphoneCore *lc);
1226 const char * linphone_core_get_capture_device(LinphoneCore *lc);
1227 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
1228 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
1229 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
1230 char linphone_core_get_sound_source(LinphoneCore *lc);
1231 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
1232 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
1233 const char *linphone_core_get_ring(const LinphoneCore *lc);
1234 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1235 void linphone_core_verify_server_cn(LinphoneCore *lc, bool_t yesno);
1236 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1237 const char *linphone_core_get_root_ca(LinphoneCore *lc);
1238 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1239 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1241 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1242 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1244 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1245 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1246 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1248 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1249 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1251 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1252 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1254 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1258 * @ingroup media_parameters
1260 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1262 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1264 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1265 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1268 /* returns a list of LinphoneCallLog */
1269 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1270 void linphone_core_clear_call_logs(LinphoneCore *lc);
1271 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1272 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1273 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1276 bool_t linphone_core_video_supported(LinphoneCore *lc);
1277 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1278 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1279 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1280 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1282 typedef struct MSVideoSizeDef{
1286 /* returns a zero terminated table of MSVideoSizeDef*/
1287 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1288 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1289 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1290 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1292 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1293 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1295 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1296 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1299 /* returns a null terminated static array of string describing the webcams */
1300 void linphone_core_reload_video_devices(LinphoneCore *lc);
1301 const char** linphone_core_get_video_devices(const LinphoneCore *lc);
1302 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1303 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1305 /* Set and get static picture to be used when "Static picture" is the video device */
1306 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1307 const char *linphone_core_get_static_picture(LinphoneCore *lc);
1309 /* Set and get frame rate for static picture */
1310 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1311 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1313 /*function to be used for eventually setting window decorations (icons, title...)*/
1314 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1315 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1317 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1318 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1320 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1321 int linphone_core_get_device_rotation(LinphoneCore *lc );
1322 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1324 /* start or stop streaming video in case of embedded window */
1325 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1327 /*play/record support: use files instead of soundcard*/
1328 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1329 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1330 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1332 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1333 void linphone_core_stop_dtmf(LinphoneCore *lc);
1335 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1338 int linphone_core_get_mtu(const LinphoneCore *lc);
1339 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1342 * @ingroup network_parameters
1343 * This method is called by the application to notify the linphone core library when network is reachable.
1344 * Calling this method with true trigger linphone to initiate a registration process for all proxies.
1345 * Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
1347 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1349 * @ingroup network_parameters
1350 * return network state either as positioned by the application or by linphone itself.
1352 bool_t linphone_core_is_network_reachable(LinphoneCore* lc);
1355 * @ingroup network_parameters
1356 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1358 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1360 * @ingroup network_parameters
1361 * Is signaling keep alive
1363 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1365 void *linphone_core_get_user_data(LinphoneCore *lc);
1366 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1368 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1369 the config file with your own sections */
1370 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1372 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1373 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1375 /*returns the list of registered SipSetup (linphonecore plugins) */
1376 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1378 void linphone_core_destroy(LinphoneCore *lc);
1380 /*for advanced users:*/
1381 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1382 struct _LinphoneRtpTransportFactories{
1383 LinphoneRtpTransportFactoryFunc audio_rtp_func;
1384 void *audio_rtp_func_data;
1385 LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1386 void *audio_rtcp_func_data;
1387 LinphoneRtpTransportFactoryFunc video_rtp_func;
1388 void *video_rtp_func_data;
1389 LinphoneRtpTransportFactoryFunc video_rtcp_func;
1390 void *video_rtcp_func_data;
1392 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1394 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1396 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1398 int linphone_core_get_calls_nb(const LinphoneCore *lc);
1400 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1402 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1404 * force registration refresh to be initiated upon next iterate
1407 void linphone_core_refresh_registers(LinphoneCore* lc);
1409 /* Path to the file storing secrets cache */
1410 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1411 const char *linphone_core_get_zrtp_secrets_file(LinphoneCore *lc);
1413 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1415 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1416 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1417 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1418 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1419 int linphone_core_enter_conference(LinphoneCore *lc);
1420 int linphone_core_leave_conference(LinphoneCore *lc);
1421 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1423 int linphone_core_terminate_conference(LinphoneCore *lc);
1424 int linphone_core_get_conference_size(LinphoneCore *lc);
1426 int linphone_core_get_max_calls(LinphoneCore *lc);
1427 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1429 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1431 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1434 * Choose media encryption policy to be used for RTP packets
1436 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1437 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1439 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1441 * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1442 * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1444 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1447 * Init call params using LinphoneCore's current configuration
1449 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1452 * True if tunnel support was compiled.
1454 bool_t linphone_core_tunnel_available(void);
1456 typedef struct _LinphoneTunnel LinphoneTunnel;
1458 * get tunnel instance if available
1460 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1462 void linphone_core_set_sip_dscp(LinphoneCore *lc, int dscp);
1463 int linphone_core_get_sip_dscp(const LinphoneCore *lc);
1465 void linphone_core_set_audio_dscp(LinphoneCore *lc, int dscp);
1466 int linphone_core_get_audio_dscp(const LinphoneCore *lc);
1468 void linphone_core_set_video_dscp(LinphoneCore *lc, int dscp);
1469 int linphone_core_get_video_dscp(const LinphoneCore *lc);