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 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
290 * 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
291 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
293 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
295 typedef struct _LinphoneCallStats LinphoneCallStats;
298 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
300 * 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
301 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
303 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
305 struct _LinphoneCallStats {
306 int type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
307 jitter_stats_t jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
308 mblk_t* received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
309 mblk_t* sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
310 float round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
311 LinphoneIceState ice_state; /**< State of ICE processing. */
312 float download_bandwidth; /**<Download bandwidth measurement of received stream, expressed in kbit/s, including IP/UDP/RTP headers*/
313 float upload_bandwidth; /**<Download bandwidth measurement of sent stream, expressed in kbit/s, including IP/UDP/RTP headers*/
320 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
321 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
324 /** Callback prototype */
325 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
328 * LinphoneCallState enum represents the different state a call can reach into.
329 * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
330 * @ingroup call_control
332 typedef enum _LinphoneCallState{
333 LinphoneCallIdle, /**<Initial call state */
334 LinphoneCallIncomingReceived, /**<This is a new incoming call */
335 LinphoneCallOutgoingInit, /**<An outgoing call is started */
336 LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
337 LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
338 LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
339 LinphoneCallConnected, /**<Connected, the call is answered */
340 LinphoneCallStreamsRunning, /**<The media streams are established and running*/
341 LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
342 LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
343 LinphoneCallResuming, /**<The call is being resumed by local end*/
344 LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
345 LinphoneCallError, /**<The call encountered an error*/
346 LinphoneCallEnd, /**<The call ended normally*/
347 LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
348 LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
349 LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
350 LinphoneCallUpdating, /**<A call update has been initiated by us */
351 LinphoneCallReleased /**< The call object is no more retained by the core */
354 const char *linphone_call_state_to_string(LinphoneCallState cs);
356 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
357 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
358 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
359 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
360 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
361 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
362 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
363 LinphoneCall * linphone_call_ref(LinphoneCall *call);
364 void linphone_call_unref(LinphoneCall *call);
365 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
366 const char *linphone_call_get_refer_to(const LinphoneCall *call);
367 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
368 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
369 int linphone_call_get_duration(const LinphoneCall *call);
370 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
371 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
372 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
373 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
374 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
375 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
376 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
377 float linphone_call_get_play_volume(LinphoneCall *call);
378 float linphone_call_get_record_volume(LinphoneCall *call);
379 float linphone_call_get_current_quality(LinphoneCall *call);
380 float linphone_call_get_average_quality(LinphoneCall *call);
381 const char* linphone_call_get_authentication_token(LinphoneCall *call);
382 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
383 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
384 void linphone_call_send_vfu_request(LinphoneCall *call);
385 void *linphone_call_get_user_pointer(LinphoneCall *call);
386 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
387 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
388 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
389 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);
391 * Return TRUE if this call is currently part of a conference
392 *@param call #LinphoneCall
393 *@return TRUE if part of a conference.
395 @ingroup call_control
397 bool_t linphone_call_is_in_conference(const LinphoneCall *call);
399 * Enables or disable echo cancellation for this call
403 * @ingroup media_parameters
405 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
407 * Returns TRUE if echo cancellation is enabled.
409 * @ingroup media_parameters
411 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
413 * Enables or disable echo limiter for this call
417 * @ingroup media_parameters
419 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
421 * Returns TRUE if echo limiter is enabled.
423 * @ingroup media_parameters
425 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
427 /*keep this in sync with mediastreamer2/msvolume.h*/
430 * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
433 #define LINPHONE_VOLUME_DB_LOWEST (-120)
436 * @addtogroup proxies
440 * The LinphoneProxyConfig object represents a proxy configuration to be used
441 * by the LinphoneCore object.
442 * Its fields must not be used directly in favour of the accessors methods.
443 * Once created and filled properly the LinphoneProxyConfig can be given to
444 * LinphoneCore with linphone_core_add_proxy_config().
445 * This will automatically triggers the registration, if enabled.
447 * The proxy configuration are persistent to restarts because they are saved
448 * in the configuration file. As a consequence, after linphone_core_new() there
449 * might already be a list of configured proxy that can be examined with
450 * linphone_core_get_proxy_config_list().
452 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
453 * that is used by default for calls.
455 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
458 * LinphoneRegistrationState describes proxy registration states.
460 typedef enum _LinphoneRegistrationState{
461 LinphoneRegistrationNone, /**<Initial state for registrations */
462 LinphoneRegistrationProgress, /**<Registration is in progress */
463 LinphoneRegistrationOk, /**< Registration is successful */
464 LinphoneRegistrationCleared, /**< Unregistration succeeded */
465 LinphoneRegistrationFailed /**<Registration failed */
466 }LinphoneRegistrationState;
469 * Human readable version of the #LinphoneRegistrationState
472 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
474 LinphoneProxyConfig *linphone_proxy_config_new(void);
475 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
476 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
477 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
478 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
480 * Indicates either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
481 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
482 * @param obj object pointer
483 * @param val if true, registration will be engaged
485 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
486 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
487 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
488 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
490 * Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
491 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
492 * @param obj object pointer
493 * @param val if true, publish will be engaged
496 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
497 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
498 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
500 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
501 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
502 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
504 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
505 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
506 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
507 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
508 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
509 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
510 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
511 const char *linphone_proxy_config_get_contact_parameters(const LinphoneProxyConfig *obj);
512 void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, const char *contact_params);
513 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
515 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
516 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
518 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
520 /* destruction is called automatically when removing the proxy config */
521 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
522 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
523 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
524 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
526 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
528 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
530 * attached a user data to a proxy config
532 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
534 * get user data to a proxy config. return null if any
536 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
542 typedef struct _LinphoneAccountCreator{
543 struct _LinphoneCore *lc;
544 struct _SipSetupContext *ssctx;
552 }LinphoneAccountCreator;
554 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
555 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
556 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
557 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
558 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
559 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
560 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
561 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
562 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
563 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
564 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
565 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
566 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
568 struct _LinphoneAuthInfo;
571 * @ingroup authentication
572 * Object holding authentication information.
574 * @note The object's fields should not be accessed directly. Prefer using
575 * the accessor methods.
577 * In most case, authentication information consists of a username and password.
578 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
579 * different SIP domains.
581 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
582 * order to become known and used automatically when needed.
583 * Use linphone_core_add_auth_info() for that purpose.
585 * The LinphoneCore object can take the initiative to request authentication information
586 * when needed to the application through the auth_info_requested callback of the
587 * LinphoneCoreVTable structure.
589 * The application can respond to this information request later using
590 * linphone_core_add_auth_info(). This will unblock all pending authentication
591 * transactions and retry them with authentication headers.
594 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
596 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
597 const char *passwd, const char *ha1,const char *realm);
598 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
599 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
600 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
602 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
603 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
604 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
606 /* you don't need those function*/
607 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
608 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
611 struct _LinphoneChatRoom;
613 * @addtogroup chatroom
618 * A chat room message to old content to be sent.
619 * <br> Can be created by linphone_chat_room_create_message().
621 typedef struct _LinphoneChatMessage LinphoneChatMessage;
624 * A chat room is the place where text messages are exchanged.
625 * <br> Can be created by linphone_core_create_chat_room().
627 typedef struct _LinphoneChatRoom LinphoneChatRoom;
630 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
631 * @param lc #LinphoneCore object
632 * @param to destination address for messages
633 * @return #LinphoneChatRoom where messaging can take place.
635 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
638 * @param cr #LinphoneChatRoom object
640 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
643 * create a message attached to a dedicated chat room;
645 LinphoneChatMessage* linphone_chat_room_create_message(const LinphoneChatRoom *cr,const char* message);
649 * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
650 * @param cr #LinphoneChatRoom object
651 * @return #LinphoneAddress peer address
653 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
655 * send a message to peer member of this chat room.
656 * @param cr #LinphoneChatRoom object
657 * @param msg message to be sent
659 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
661 *LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
663 typedef enum _LinphoneChatMessageStates {
664 LinphoneChatMessageStateIdle, /**<initial state*/
665 LinphoneChatMessageStateInProgress, /**<delivery in progress**/
666 LinphoneChatMessageStateDelivered, /**<message succesffully delivered an acknoleged by remote end point*/
667 LinphoneChatMessageStateNotDelivered /**<message was not delivered*/
668 }LinphoneChatMessageState;
674 const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
677 * Clone a chat message
678 *@param message #LinphoneChatMessage obj
679 *@return #LinphoneChatMessage
681 LinphoneChatMessage* linphone_chat_message_clone(const LinphoneChatMessage* message);
683 * Set origin of the message
684 *@param message #LinphoneChatMessage obj
685 *@param from #LinphoneAddress origin of this message (copied)
687 void linphone_chat_message_set_from(LinphoneChatMessage* message, const LinphoneAddress* from);
690 * Get origin of the message
691 *@param message #LinphoneChatMessage obj
692 *@return #LinphoneAddress
694 LinphoneAddress* linphone_chat_message_get_from(const LinphoneChatMessage* message);
697 * Linphone message can carry external body as defined by rfc2017
698 * @param message #LinphoneChatMessage
699 * @return external body url or NULL if not present.
701 const char* linphone_chat_message_get_external_body_url(const LinphoneChatMessage* message);
704 * Linphone message can carry external body as defined by rfc2017
706 * @param message a LinphoneChatMessage
707 * @param url ex: access-type=URL; URL="http://www.foo.com/file"
709 void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
712 * Get text part of this message
713 * @return text or NULL if no text.
715 const char * linphone_chat_message_get_text(const LinphoneChatMessage* message);
717 * user pointer get function
720 void* linphone_chat_message_get_user_data(const LinphoneChatMessage* message);
722 * user pointer set function
724 void linphone_chat_message_set_user_data(LinphoneChatMessage* message,void*);
727 * Call back used to notify message delivery status
728 *@param msg #LinphoneChatMessage object
729 *@param status LinphoneChatMessageState
730 *@param ud application user data
732 typedef void (*LinphoneChatMessageStateChangeCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
734 * send a message to peer member of this chat room.
735 * @param cr #LinphoneChatRoom object
736 * @param msg #LinphoneChatMessage message to be sent
737 * @param status_cb LinphoneChatMessageStateChangeCb status callback invoked when message is delivered or could not be delivered. May be NULL
738 * @param ud user data for the status cb.
740 void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage* msg,LinphoneChatMessageStateChangeCb status_cb,void* ud);
741 LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr);
742 LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
743 char* linphone_chat_message_get_message(LinphoneChatMessage *msg);
744 const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
745 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
746 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
754 * @addtogroup initializing
759 * LinphoneGlobalState describes the global state of the LinphoneCore object.
760 * It is notified via the LinphoneCoreVTable::global_state_changed
762 typedef enum _LinphoneGlobalState{
764 LinphoneGlobalStartup,
766 LinphoneGlobalShutdown
767 }LinphoneGlobalState;
769 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
772 /**Call state notification callback prototype*/
773 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
774 /**Call state notification callback prototype*/
775 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
776 /**Call encryption changed callback prototype*/
777 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
780 * Registration state notification callback prototype
782 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
783 /** Callback prototype */
784 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
785 /** Callback prototype */
786 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
787 /** Callback prototype */
788 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
789 /** Callback prototype */
790 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
791 /** Callback prototype */
792 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
793 /** Callback prototype */
794 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
796 * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
797 * @param lc #LinphoneCore object .
798 * @param lf Updated #LinphoneFriend .
800 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
802 * Reports that a new subscription request has been received and wait for a decision.
803 * <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
804 * @param lc #LinphoneCore object
805 * @param lf #LinphoneFriend corresponding to the subscriber
806 * @param url of the subscriber
809 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
810 /** Callback prototype */
811 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
812 /** Callback prototype */
813 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
816 * @deprecated use #MessageReceived instead.
818 * @param lc #LinphoneCore object
819 * @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.
820 * @param from #LinphoneAddress from
821 * @param message incoming message
823 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
825 * Chat message callback prototype
827 * @param lc #LinphoneCore object
828 * @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.
829 * @param LinphoneChatMessage incoming message
831 typedef void (*MessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
833 /** Callback prototype */
834 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
835 /** Callback prototype */
836 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
837 /** Callback prototype */
838 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
839 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
840 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
841 /** Callback prototype for receiving quality statistics for calls*/
842 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
845 * This structure holds all callbacks that the application should implement.
848 typedef struct _LinphoneVTable{
849 LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
850 LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
851 LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
852 NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
853 NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
854 AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
855 CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
856 TextMessageReceived text_received; /** @deprecated, use #message_received instead <br> A text message has been received */
857 MessageReceived message_received; /** a message is received, can be text or external body*/
858 DtmfReceived dtmf_received; /**< A dtmf has been received received */
859 ReferReceived refer_received; /**< An out of call refer was received */
860 CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
861 LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
862 BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
863 NotifyReceivedCb notify_recv; /**< Other notifications*/
864 CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
865 DisplayStatusCb display_status; /**< DEPRECATED Callback that notifies various events with human readable text.*/
866 DisplayMessageCb display_message;/**< DEPRECATED Callback to display a message to the user */
867 DisplayMessageCb display_warning;/**< DEPRECATED Callback to display a warning to the user */
868 DisplayUrlCb display_url; /**< DEPRECATED */
869 ShowInterfaceCb show; /**< DEPRECATED Notifies the application that it should show up*/
870 } LinphoneCoreVTable;
876 typedef struct _LCCallbackObj
878 LinphoneCoreCbFunc _func;
884 typedef enum _LinphoneFirewallPolicy{
885 LinphonePolicyNoFirewall,
886 LinphonePolicyUseNatAddress,
887 LinphonePolicyUseStun,
889 } LinphoneFirewallPolicy;
891 typedef enum _LinphoneWaitingState{
892 LinphoneWaitingStart,
893 LinphoneWaitingProgress,
894 LinphoneWaitingFinished
895 } LinphoneWaitingState;
896 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
901 void linphone_core_enable_logs(FILE *file);
902 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
903 void linphone_core_disable_logs(void);
904 const char *linphone_core_get_version(void);
905 const char *linphone_core_get_user_agent_name(void);
906 const char *linphone_core_get_user_agent_version(void);
908 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
909 const char *config_path, const char *factory_config, void* userdata);
911 /* function to be periodically called in a main loop */
912 /* For ICE to work properly it should be called every 20ms */
913 void linphone_core_iterate(LinphoneCore *lc);
914 #if 0 /*not implemented yet*/
916 * @ingroup initializing
917 * Provide Linphone Core with an unique identifier. This be later used to identified contact address coming from this device.
918 * Value is not saved.
920 * @param string identifying the device, can be EMEI or UDID
923 void linphone_core_set_device_identifier(LinphoneCore *lc,const char* device_id);
925 * @ingroup initializing
926 * get Linphone unique identifier
929 const char* linphone_core_get_device_identifier(const LinphoneCore *lc);
933 /*sets the user-agent string in sip messages, ideally called just after linphone_core_new() or linphone_core_init() */
934 void linphone_core_set_user_agent(LinphoneCore *lc, const char *ua_name, const char *version);
936 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
938 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
940 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
942 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
944 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
946 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
948 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
950 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
952 bool_t linphone_core_in_call(const LinphoneCore *lc);
954 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
956 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
958 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
960 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
962 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
964 int linphone_core_decline_call(LinphoneCore *lc, LinphoneCall * call, LinphoneReason reason);
966 int linphone_core_terminate_all_calls(LinphoneCore *lc);
968 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
970 int linphone_core_pause_all_calls(LinphoneCore *lc);
972 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
974 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
976 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
978 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
980 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
982 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
984 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
986 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
988 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
990 const char * linphone_core_get_identity(LinphoneCore *lc);
992 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
993 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
995 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
996 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
998 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
999 const char * linphone_core_get_identity(LinphoneCore *lc);
1000 /*0= no bandwidth limit*/
1001 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
1002 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
1004 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
1005 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
1007 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
1008 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
1010 * set audio packetization time linphone expect to receive from peer
1011 * @ingroup media_parameters
1014 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
1016 * get audio packetization time linphone expect to receive from peer, 0 means unspecified
1017 * @ingroup media_parameters
1019 int linphone_core_get_download_ptime(LinphoneCore *lc);
1021 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
1023 int linphone_core_get_upload_ptime(LinphoneCore *lc);
1025 /* returns a MSList of PayloadType */
1026 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
1028 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
1029 /* returns a MSList of PayloadType */
1030 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
1032 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
1034 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
1036 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
1039 * Wildcard value used by #linphone_core_find_payload_type to ignore rate in search algirithm
1040 * @ingroup media_parameters
1042 #define LINPHONE_FIND_PAYLOAD_IGNORE_RATE -1
1044 * Wildcard value used by #linphone_core_find_payload_type to ignore channel in search algirithm
1045 * @ingroup media_parameters
1047 #define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS -1
1049 * Get payload type from mime type and clock rate
1050 * @ingroup media_parameters
1051 * This function searches in audio and video codecs for the given payload type name and clockrate.
1052 * @param lc #LinphoneCore object
1053 * @param type payload mime type (I.E SPEEX, PCMU, VP8)
1054 * @param rate can be #LINPHONE_FIND_PAYLOAD_IGNORE_RATE
1055 * @param channels number of channels, can be #LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
1056 * @return Returns NULL if not found.
1058 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate, int channels) ;
1060 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
1062 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
1064 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
1068 *Create a proxy config with default value from Linphone core.
1069 *@param lc #LinphoneCore object
1070 *@return #LinphoneProxyConfig with defualt value set
1072 LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *lc);
1074 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1076 void linphone_core_clear_proxy_config(LinphoneCore *lc);
1078 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1080 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
1082 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
1084 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
1086 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
1088 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1090 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1092 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
1094 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
1096 void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info);
1098 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
1100 void linphone_core_enable_audio_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1102 bool_t linphone_core_audio_adaptive_jittcomp_enabled(LinphoneCore *lc);
1104 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
1106 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
1108 void linphone_core_enable_video_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1110 bool_t linphone_core_video_adaptive_jittcomp_enabled(LinphoneCore *lc);
1112 int linphone_core_get_video_jittcomp(LinphoneCore *lc);
1114 void linphone_core_set_video_jittcomp(LinphoneCore *lc, int value);
1116 int linphone_core_get_audio_port(const LinphoneCore *lc);
1118 void linphone_core_get_audio_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1120 int linphone_core_get_video_port(const LinphoneCore *lc);
1122 void linphone_core_get_video_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1124 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
1126 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
1128 void linphone_core_set_audio_port_range(LinphoneCore *lc, int min_port, int max_port);
1130 void linphone_core_set_video_port(LinphoneCore *lc, int port);
1132 void linphone_core_set_video_port_range(LinphoneCore *lc, int min_port, int max_port);
1134 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
1136 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
1138 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
1140 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
1142 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
1144 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
1146 int linphone_core_get_sip_port(LinphoneCore *lc);
1148 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
1150 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
1153 * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
1154 * @param lc #LinphoneCore
1155 * @return socket file descriptor
1157 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
1159 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
1161 int linphone_core_get_inc_timeout(LinphoneCore *lc);
1163 void linphone_core_set_in_call_timeout(LinphoneCore *lc, int seconds);
1165 int linphone_core_get_in_call_timeout(LinphoneCore *lc);
1167 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
1169 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
1171 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
1173 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
1175 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
1177 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
1179 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
1181 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
1183 /* sound functions */
1184 /* returns a null terminated static array of string describing the sound devices */
1185 const char** linphone_core_get_sound_devices(LinphoneCore *lc);
1186 void linphone_core_reload_sound_devices(LinphoneCore *lc);
1187 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
1188 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
1189 int linphone_core_get_ring_level(LinphoneCore *lc);
1190 int linphone_core_get_play_level(LinphoneCore *lc);
1191 int linphone_core_get_rec_level(LinphoneCore *lc);
1192 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
1193 void linphone_core_set_play_level(LinphoneCore *lc, int level);
1195 void linphone_core_set_mic_gain_db(LinphoneCore *lc, float level);
1196 float linphone_core_get_mic_gain_db(LinphoneCore *lc);
1197 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
1198 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
1200 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
1201 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
1202 const char * linphone_core_get_playback_device(LinphoneCore *lc);
1203 const char * linphone_core_get_capture_device(LinphoneCore *lc);
1204 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
1205 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
1206 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
1207 char linphone_core_get_sound_source(LinphoneCore *lc);
1208 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
1209 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
1210 const char *linphone_core_get_ring(const LinphoneCore *lc);
1211 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1212 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1213 const char *linphone_core_get_root_ca(LinphoneCore *lc);
1214 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1215 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1217 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1218 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1220 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1221 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1222 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1224 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1225 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1227 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1228 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1230 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1234 * @ingroup media_parameters
1236 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1238 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1240 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1241 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1244 /* returns a list of LinphoneCallLog */
1245 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1246 void linphone_core_clear_call_logs(LinphoneCore *lc);
1247 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1248 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1249 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1252 bool_t linphone_core_video_supported(LinphoneCore *lc);
1253 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1254 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1255 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1256 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1258 typedef struct MSVideoSizeDef{
1262 /* returns a zero terminated table of MSVideoSizeDef*/
1263 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1264 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1265 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1266 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1268 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1269 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1271 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1272 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1275 /* returns a null terminated static array of string describing the webcams */
1276 void linphone_core_reload_video_devices(LinphoneCore *lc);
1277 const char** linphone_core_get_video_devices(const LinphoneCore *lc);
1278 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1279 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1281 /* Set and get static picture to be used when "Static picture" is the video device */
1282 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1283 const char *linphone_core_get_static_picture(LinphoneCore *lc);
1285 /* Set and get frame rate for static picture */
1286 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1287 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1289 /*function to be used for eventually setting window decorations (icons, title...)*/
1290 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1291 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1293 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1294 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1296 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1297 int linphone_core_get_device_rotation(LinphoneCore *lc );
1298 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1300 /* start or stop streaming video in case of embedded window */
1301 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1303 /*play/record support: use files instead of soundcard*/
1304 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1305 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1306 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1308 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1309 void linphone_core_stop_dtmf(LinphoneCore *lc);
1311 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1314 int linphone_core_get_mtu(const LinphoneCore *lc);
1315 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1318 * @ingroup network_parameters
1319 * This method is called by the application to notify the linphone core library when network is reachable.
1320 * Calling this method with true trigger linphone to initiate a registration process for all proxies.
1321 * Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
1323 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1325 * @ingroup network_parameters
1326 * return network state either as positioned by the application or by linphone itself.
1328 bool_t linphone_core_is_network_reachable(LinphoneCore* lc);
1331 * @ingroup network_parameters
1332 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1334 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1336 * @ingroup network_parameters
1337 * Is signaling keep alive
1339 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1341 void *linphone_core_get_user_data(LinphoneCore *lc);
1342 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1344 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1345 the config file with your own sections */
1346 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1348 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1349 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1351 /*returns the list of registered SipSetup (linphonecore plugins) */
1352 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1354 void linphone_core_destroy(LinphoneCore *lc);
1356 /*for advanced users:*/
1357 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1358 struct _LinphoneRtpTransportFactories{
1359 LinphoneRtpTransportFactoryFunc audio_rtp_func;
1360 void *audio_rtp_func_data;
1361 LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1362 void *audio_rtcp_func_data;
1363 LinphoneRtpTransportFactoryFunc video_rtp_func;
1364 void *video_rtp_func_data;
1365 LinphoneRtpTransportFactoryFunc video_rtcp_func;
1366 void *video_rtcp_func_data;
1368 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1370 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1372 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1374 int linphone_core_get_calls_nb(const LinphoneCore *lc);
1376 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1378 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1380 * force registration refresh to be initiated upon next iterate
1383 void linphone_core_refresh_registers(LinphoneCore* lc);
1385 /* Path to the file storing secrets cache */
1386 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1387 const char *linphone_core_get_zrtp_secrets_file(LinphoneCore *lc);
1389 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1391 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1392 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1393 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1394 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1395 int linphone_core_enter_conference(LinphoneCore *lc);
1396 int linphone_core_leave_conference(LinphoneCore *lc);
1397 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1399 int linphone_core_terminate_conference(LinphoneCore *lc);
1400 int linphone_core_get_conference_size(LinphoneCore *lc);
1402 int linphone_core_get_max_calls(LinphoneCore *lc);
1403 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1405 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1407 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1410 * Choose media encryption policy to be used for RTP packets
1412 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1413 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1415 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1417 * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1418 * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1420 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1423 * Init call params using LinphoneCore's current configuration
1425 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1428 * True if tunnel support was compiled.
1430 bool_t linphone_core_tunnel_available(void);
1432 typedef struct _LinphoneTunnel LinphoneTunnel;
1434 * get tunnel instance if available
1436 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1438 void linphone_core_set_sip_dscp(LinphoneCore *lc, int dscp);
1439 int linphone_core_get_sip_dscp(const LinphoneCore *lc);
1441 void linphone_core_set_audio_dscp(LinphoneCore *lc, int dscp);
1442 int linphone_core_get_audio_dscp(const LinphoneCore *lc);
1444 void linphone_core_set_video_dscp(LinphoneCore *lc, int dscp);
1445 int linphone_core_get_video_dscp(const LinphoneCore *lc);