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);
209 void linphone_call_params_set_record_file(LinphoneCallParams *cp, const char *path);
210 const char *linphone_call_params_get_record_file(const LinphoneCallParams *cp);
212 * Enum describing failure reasons.
213 * @ingroup initializing
215 enum _LinphoneReason{
217 LinphoneReasonNoResponse, /**<No response received from remote*/
218 LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
219 LinphoneReasonDeclined, /**<The call has been declined*/
220 LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
221 LinphoneReasonNotAnswered, /**<The call was not answered in time*/
222 LinphoneReasonBusy /**<Phone line was busy */
226 * Enum describing failure reasons.
227 * @ingroup initializing
229 typedef enum _LinphoneReason LinphoneReason;
231 const char *linphone_reason_to_string(LinphoneReason err);
234 * Structure describing policy regarding video streams establishments.
235 * @ingroup media_parameters
237 struct _LinphoneVideoPolicy{
238 bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/
239 bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
244 * Structure describing policy regarding video streams establishments.
245 * @ingroup media_parameters
247 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
250 * The LinphoneCall object represents a call issued or received by the LinphoneCore
251 * @ingroup call_control
253 struct _LinphoneCall;
255 * The LinphoneCall object represents a call issued or received by the LinphoneCore
256 * @ingroup call_control
258 typedef struct _LinphoneCall LinphoneCall;
262 * @addtogroup call_misc
266 #define LINPHONE_CALL_STATS_AUDIO 0
267 #define LINPHONE_CALL_STATS_VIDEO 1
270 * Enum describing ICE states.
271 * @ingroup initializing
273 enum _LinphoneIceState{
274 LinphoneIceStateNotActivated, /**< ICE has not been activated for this call */
275 LinphoneIceStateFailed, /**< ICE processing has failed */
276 LinphoneIceStateInProgress, /**< ICE process is in progress */
277 LinphoneIceStateHostConnection, /**< ICE has established a direct connection to the remote host */
278 LinphoneIceStateReflexiveConnection, /**< ICE has established a connection to the remote host through one or several NATs */
279 LinphoneIceStateRelayConnection /**< ICE has established a connection through a relay */
283 * Enum describing Ice states.
284 * @ingroup initializing
286 typedef enum _LinphoneIceState LinphoneIceState;
289 * Enum describing uPnP states.
290 * @ingroup initializing
292 enum _LinphoneUpnpState{
293 LinphoneUpnpStateIdle, /**< uPnP is not activate */
294 LinphoneUpnpStatePending, /**< uPnP process is in progress */
295 LinphoneUpnpStateAdding, /**< Internal use: Only used by port binding */
296 LinphoneUpnpStateRemoving, /**< Internal use: Only used by port binding */
297 LinphoneUpnpStateNotAvailable, /**< uPnP is not available */
298 LinphoneUpnpStateOk, /**< uPnP is enabled */
299 LinphoneUpnpStateKo, /**< uPnP processing has failed */
303 * Enum describing uPnP states.
304 * @ingroup initializing
306 typedef enum _LinphoneUpnpState LinphoneUpnpState;
310 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
312 * 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
313 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
315 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
317 typedef struct _LinphoneCallStats LinphoneCallStats;
320 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
322 * 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
323 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
325 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
327 struct _LinphoneCallStats {
328 int type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
329 jitter_stats_t jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
330 mblk_t* received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
331 mblk_t* sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
332 float round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
333 LinphoneIceState ice_state; /**< State of ICE processing. */
334 LinphoneUpnpState upnp_state; /**< State of uPnP processing. */
335 float download_bandwidth; /**<Download bandwidth measurement of received stream, expressed in kbit/s, including IP/UDP/RTP headers*/
336 float upload_bandwidth; /**<Download bandwidth measurement of sent stream, expressed in kbit/s, including IP/UDP/RTP headers*/
343 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
344 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
347 /** Callback prototype */
348 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
351 * LinphoneCallState enum represents the different state a call can reach into.
352 * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
353 * @ingroup call_control
355 typedef enum _LinphoneCallState{
356 LinphoneCallIdle, /**<Initial call state */
357 LinphoneCallIncomingReceived, /**<This is a new incoming call */
358 LinphoneCallOutgoingInit, /**<An outgoing call is started */
359 LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
360 LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
361 LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
362 LinphoneCallConnected, /**<Connected, the call is answered */
363 LinphoneCallStreamsRunning, /**<The media streams are established and running*/
364 LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
365 LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
366 LinphoneCallResuming, /**<The call is being resumed by local end*/
367 LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
368 LinphoneCallError, /**<The call encountered an error*/
369 LinphoneCallEnd, /**<The call ended normally*/
370 LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
371 LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
372 LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
373 LinphoneCallUpdating, /**<A call update has been initiated by us */
374 LinphoneCallReleased /**< The call object is no more retained by the core */
377 const char *linphone_call_state_to_string(LinphoneCallState cs);
379 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
380 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
381 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
382 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
383 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
384 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
385 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
386 LinphoneCall * linphone_call_ref(LinphoneCall *call);
387 void linphone_call_unref(LinphoneCall *call);
388 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
389 const char *linphone_call_get_refer_to(const LinphoneCall *call);
390 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
391 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
392 int linphone_call_get_duration(const LinphoneCall *call);
393 const LinphoneCallParams * linphone_call_get_current_params(LinphoneCall *call);
394 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
395 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
396 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
397 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
398 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
399 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
400 const char *linphone_call_get_remote_contact(LinphoneCall *call);
401 float linphone_call_get_play_volume(LinphoneCall *call);
402 float linphone_call_get_record_volume(LinphoneCall *call);
403 float linphone_call_get_current_quality(LinphoneCall *call);
404 float linphone_call_get_average_quality(LinphoneCall *call);
405 const char* linphone_call_get_authentication_token(LinphoneCall *call);
406 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
407 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
408 void linphone_call_send_vfu_request(LinphoneCall *call);
409 void *linphone_call_get_user_pointer(LinphoneCall *call);
410 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
411 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
412 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
413 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);
414 void linphone_call_start_recording(LinphoneCall *call);
415 void linphone_call_stop_recording(LinphoneCall *call);
417 * Return TRUE if this call is currently part of a conference
418 *@param call #LinphoneCall
419 *@return TRUE if part of a conference.
421 @ingroup call_control
423 bool_t linphone_call_is_in_conference(const LinphoneCall *call);
425 * Enables or disable echo cancellation for this call
429 * @ingroup media_parameters
431 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
433 * Returns TRUE if echo cancellation is enabled.
435 * @ingroup media_parameters
437 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
439 * Enables or disable echo limiter for this call
443 * @ingroup media_parameters
445 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
447 * Returns TRUE if echo limiter is enabled.
449 * @ingroup media_parameters
451 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
453 /*keep this in sync with mediastreamer2/msvolume.h*/
456 * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
459 #define LINPHONE_VOLUME_DB_LOWEST (-120)
462 * @addtogroup proxies
466 * The LinphoneProxyConfig object represents a proxy configuration to be used
467 * by the LinphoneCore object.
468 * Its fields must not be used directly in favour of the accessors methods.
469 * Once created and filled properly the LinphoneProxyConfig can be given to
470 * LinphoneCore with linphone_core_add_proxy_config().
471 * This will automatically triggers the registration, if enabled.
473 * The proxy configuration are persistent to restarts because they are saved
474 * in the configuration file. As a consequence, after linphone_core_new() there
475 * might already be a list of configured proxy that can be examined with
476 * linphone_core_get_proxy_config_list().
478 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
479 * that is used by default for calls.
481 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
484 * LinphoneRegistrationState describes proxy registration states.
486 typedef enum _LinphoneRegistrationState{
487 LinphoneRegistrationNone, /**<Initial state for registrations */
488 LinphoneRegistrationProgress, /**<Registration is in progress */
489 LinphoneRegistrationOk, /**< Registration is successful */
490 LinphoneRegistrationCleared, /**< Unregistration succeeded */
491 LinphoneRegistrationFailed /**<Registration failed */
492 }LinphoneRegistrationState;
495 * Human readable version of the #LinphoneRegistrationState
498 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
500 LinphoneProxyConfig *linphone_proxy_config_new(void);
501 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
502 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
503 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
504 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
506 * Indicates either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
507 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
508 * @param obj object pointer
509 * @param val if true, registration will be engaged
511 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
512 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
513 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
514 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
516 * Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
517 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
518 * @param obj object pointer
519 * @param val if true, publish will be engaged
522 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
523 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
524 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
526 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
527 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
528 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
530 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
531 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
532 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
533 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
534 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
535 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
536 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
537 const char *linphone_proxy_config_get_contact_parameters(const LinphoneProxyConfig *obj);
538 void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, const char *contact_params);
539 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
541 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
542 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
544 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
546 /* destruction is called automatically when removing the proxy config */
547 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
548 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
549 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
550 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
552 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
554 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
556 * attached a user data to a proxy config
558 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
560 * get user data to a proxy config. return null if any
562 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
568 typedef struct _LinphoneAccountCreator{
569 struct _LinphoneCore *lc;
570 struct _SipSetupContext *ssctx;
578 }LinphoneAccountCreator;
580 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
581 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
582 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
583 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
584 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
585 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
586 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
587 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
588 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
589 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
590 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
591 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
592 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
594 struct _LinphoneAuthInfo;
597 * @ingroup authentication
598 * Object holding authentication information.
600 * @note The object's fields should not be accessed directly. Prefer using
601 * the accessor methods.
603 * In most case, authentication information consists of a username and password.
604 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
605 * different SIP domains.
607 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
608 * order to become known and used automatically when needed.
609 * Use linphone_core_add_auth_info() for that purpose.
611 * The LinphoneCore object can take the initiative to request authentication information
612 * when needed to the application through the auth_info_requested callback of the
613 * LinphoneCoreVTable structure.
615 * The application can respond to this information request later using
616 * linphone_core_add_auth_info(). This will unblock all pending authentication
617 * transactions and retry them with authentication headers.
620 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
622 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
623 const char *passwd, const char *ha1,const char *realm);
624 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
625 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
626 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
628 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
629 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
630 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
632 /* you don't need those function*/
633 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
634 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
637 struct _LinphoneChatRoom;
639 * @addtogroup chatroom
644 * A chat room message to old content to be sent.
645 * <br> Can be created by linphone_chat_room_create_message().
647 typedef struct _LinphoneChatMessage LinphoneChatMessage;
650 * A chat room is the place where text messages are exchanged.
651 * <br> Can be created by linphone_core_create_chat_room().
653 typedef struct _LinphoneChatRoom LinphoneChatRoom;
656 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
657 * @param lc #LinphoneCore object
658 * @param to destination address for messages
659 * @return #LinphoneChatRoom where messaging can take place.
661 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
664 * @param cr #LinphoneChatRoom object
666 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
669 * create a message attached to a dedicated chat room;
671 LinphoneChatMessage* linphone_chat_room_create_message(const LinphoneChatRoom *cr,const char* message);
675 * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
676 * @param cr #LinphoneChatRoom object
677 * @return #LinphoneAddress peer address
679 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
681 * send a message to peer member of this chat room.
682 * @param cr #LinphoneChatRoom object
683 * @param msg message to be sent
685 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
687 *LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
689 typedef enum _LinphoneChatMessageStates {
690 LinphoneChatMessageStateIdle, /**<initial state*/
691 LinphoneChatMessageStateInProgress, /**<delivery in progress**/
692 LinphoneChatMessageStateDelivered, /**<message succesffully delivered an acknoleged by remote end point*/
693 LinphoneChatMessageStateNotDelivered /**<message was not delivered*/
694 }LinphoneChatMessageState;
700 const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
703 * Clone a chat message
704 *@param message #LinphoneChatMessage obj
705 *@return #LinphoneChatMessage
707 LinphoneChatMessage* linphone_chat_message_clone(const LinphoneChatMessage* message);
709 * Set origin of the message
710 *@param message #LinphoneChatMessage obj
711 *@param from #LinphoneAddress origin of this message (copied)
713 void linphone_chat_message_set_from(LinphoneChatMessage* message, const LinphoneAddress* from);
716 * Get origin of the message
717 *@param message #LinphoneChatMessage obj
718 *@return #LinphoneAddress
720 LinphoneAddress* linphone_chat_message_get_from(const LinphoneChatMessage* message);
723 * Linphone message can carry external body as defined by rfc2017
724 * @param message #LinphoneChatMessage
725 * @return external body url or NULL if not present.
727 const char* linphone_chat_message_get_external_body_url(const LinphoneChatMessage* message);
730 * Linphone message can carry external body as defined by rfc2017
732 * @param message a LinphoneChatMessage
733 * @param url ex: access-type=URL; URL="http://www.foo.com/file"
735 void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
738 * Get text part of this message
739 * @return text or NULL if no text.
741 const char * linphone_chat_message_get_text(const LinphoneChatMessage* message);
744 * Get the time the message was sent
745 * @return time_t or NULL if no time
747 time_t linphone_chat_message_get_time(const LinphoneChatMessage* message);
750 * user pointer get function
753 void* linphone_chat_message_get_user_data(const LinphoneChatMessage* message);
755 * user pointer set function
757 void linphone_chat_message_set_user_data(LinphoneChatMessage* message,void*);
760 * Call back used to notify message delivery status
761 *@param msg #LinphoneChatMessage object
762 *@param status LinphoneChatMessageState
763 *@param ud application user data
765 typedef void (*LinphoneChatMessageStateChangeCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
767 * send a message to peer member of this chat room.
768 * @param cr #LinphoneChatRoom object
769 * @param msg #LinphoneChatMessage message to be sent
770 * @param status_cb LinphoneChatMessageStateChangeCb status callback invoked when message is delivered or could not be delivered. May be NULL
771 * @param ud user data for the status cb.
773 void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage* msg,LinphoneChatMessageStateChangeCb status_cb,void* ud);
774 LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr);
775 LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
776 char* linphone_chat_message_get_message(LinphoneChatMessage *msg);
777 const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
778 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
779 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
787 * @addtogroup initializing
792 * LinphoneGlobalState describes the global state of the LinphoneCore object.
793 * It is notified via the LinphoneCoreVTable::global_state_changed
795 typedef enum _LinphoneGlobalState{
797 LinphoneGlobalStartup,
799 LinphoneGlobalShutdown
800 }LinphoneGlobalState;
802 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
805 /**Call state notification callback prototype*/
806 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
807 /**Call state notification callback prototype*/
808 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
809 /**Call encryption changed callback prototype*/
810 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
813 * Registration state notification callback prototype
815 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
816 /** Callback prototype */
817 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
818 /** Callback prototype */
819 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
820 /** Callback prototype */
821 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
822 /** Callback prototype */
823 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
824 /** Callback prototype */
825 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
826 /** Callback prototype */
827 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
829 * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
830 * @param lc #LinphoneCore object .
831 * @param lf Updated #LinphoneFriend .
833 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
835 * Reports that a new subscription request has been received and wait for a decision.
836 * <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
837 * @param lc #LinphoneCore object
838 * @param lf #LinphoneFriend corresponding to the subscriber
839 * @param url of the subscriber
842 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
843 /** Callback prototype */
844 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
845 /** Callback prototype */
846 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
849 * @deprecated use #MessageReceived instead.
851 * @param lc #LinphoneCore object
852 * @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.
853 * @param from #LinphoneAddress from
854 * @param message incoming message
856 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
858 * Chat message callback prototype
860 * @param lc #LinphoneCore object
861 * @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.
862 * @param LinphoneChatMessage incoming message
864 typedef void (*MessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
866 /** Callback prototype */
867 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
868 /** Callback prototype */
869 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
870 /** Callback prototype */
871 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
872 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
873 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
874 /** Callback prototype for receiving quality statistics for calls*/
875 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
878 * This structure holds all callbacks that the application should implement.
881 typedef struct _LinphoneVTable{
882 LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
883 LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
884 LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
885 NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
886 NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
887 AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
888 CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
889 TextMessageReceived text_received; /** @deprecated, use #message_received instead <br> A text message has been received */
890 MessageReceived message_received; /** a message is received, can be text or external body*/
891 DtmfReceived dtmf_received; /**< A dtmf has been received received */
892 ReferReceived refer_received; /**< An out of call refer was received */
893 CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
894 LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
895 BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
896 NotifyReceivedCb notify_recv; /**< Other notifications*/
897 CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
898 DisplayStatusCb display_status; /**< DEPRECATED Callback that notifies various events with human readable text.*/
899 DisplayMessageCb display_message;/**< DEPRECATED Callback to display a message to the user */
900 DisplayMessageCb display_warning;/**< DEPRECATED Callback to display a warning to the user */
901 DisplayUrlCb display_url; /**< DEPRECATED */
902 ShowInterfaceCb show; /**< DEPRECATED Notifies the application that it should show up*/
903 } LinphoneCoreVTable;
909 typedef struct _LCCallbackObj
911 LinphoneCoreCbFunc _func;
917 typedef enum _LinphoneFirewallPolicy{
918 LinphonePolicyNoFirewall,
919 LinphonePolicyUseNatAddress,
920 LinphonePolicyUseStun,
921 LinphonePolicyUseIce,
922 LinphonePolicyUseUpnp,
923 } LinphoneFirewallPolicy;
925 typedef enum _LinphoneWaitingState{
926 LinphoneWaitingStart,
927 LinphoneWaitingProgress,
928 LinphoneWaitingFinished
929 } LinphoneWaitingState;
930 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
935 void linphone_core_enable_logs(FILE *file);
936 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
937 void linphone_core_disable_logs(void);
938 const char *linphone_core_get_version(void);
939 const char *linphone_core_get_user_agent_name(void);
940 const char *linphone_core_get_user_agent_version(void);
942 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
943 const char *config_path, const char *factory_config, void* userdata);
945 /* function to be periodically called in a main loop */
946 /* For ICE to work properly it should be called every 20ms */
947 void linphone_core_iterate(LinphoneCore *lc);
948 #if 0 /*not implemented yet*/
950 * @ingroup initializing
951 * Provide Linphone Core with an unique identifier. This be later used to identified contact address coming from this device.
952 * Value is not saved.
954 * @param string identifying the device, can be EMEI or UDID
957 void linphone_core_set_device_identifier(LinphoneCore *lc,const char* device_id);
959 * @ingroup initializing
960 * get Linphone unique identifier
963 const char* linphone_core_get_device_identifier(const LinphoneCore *lc);
967 /*sets the user-agent string in sip messages, ideally called just after linphone_core_new() or linphone_core_init() */
968 void linphone_core_set_user_agent(LinphoneCore *lc, const char *ua_name, const char *version);
970 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
972 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
974 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
976 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
978 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
980 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
982 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
984 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
986 bool_t linphone_core_in_call(const LinphoneCore *lc);
988 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
990 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
992 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
994 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
996 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
998 int linphone_core_decline_call(LinphoneCore *lc, LinphoneCall * call, LinphoneReason reason);
1000 int linphone_core_terminate_all_calls(LinphoneCore *lc);
1002 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
1004 int linphone_core_pause_all_calls(LinphoneCore *lc);
1006 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
1008 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
1010 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
1012 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
1014 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
1016 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
1018 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
1020 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
1022 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
1024 const char * linphone_core_get_identity(LinphoneCore *lc);
1026 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
1027 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
1029 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
1030 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
1032 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
1033 const char * linphone_core_get_identity(LinphoneCore *lc);
1034 /*0= no bandwidth limit*/
1035 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
1036 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
1038 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
1039 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
1041 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
1042 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
1044 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
1045 int linphone_core_get_download_ptime(LinphoneCore *lc);
1047 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
1049 int linphone_core_get_upload_ptime(LinphoneCore *lc);
1051 /* returns a MSList of PayloadType */
1052 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
1054 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
1055 /* returns a MSList of PayloadType */
1056 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
1058 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
1060 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
1062 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
1065 * Wildcard value used by #linphone_core_find_payload_type to ignore rate in search algirithm
1066 * @ingroup media_parameters
1068 #define LINPHONE_FIND_PAYLOAD_IGNORE_RATE -1
1070 * Wildcard value used by #linphone_core_find_payload_type to ignore channel in search algirithm
1071 * @ingroup media_parameters
1073 #define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS -1
1075 * Get payload type from mime type and clock rate
1076 * @ingroup media_parameters
1077 * This function searches in audio and video codecs for the given payload type name and clockrate.
1078 * @param lc #LinphoneCore object
1079 * @param type payload mime type (I.E SPEEX, PCMU, VP8)
1080 * @param rate can be #LINPHONE_FIND_PAYLOAD_IGNORE_RATE
1081 * @param channels number of channels, can be #LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
1082 * @return Returns NULL if not found.
1084 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate, int channels) ;
1086 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
1088 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
1090 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
1094 *Create a proxy config with default value from Linphone core.
1095 *@param lc #LinphoneCore object
1096 *@return #LinphoneProxyConfig with defualt value set
1098 LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *lc);
1100 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1102 void linphone_core_clear_proxy_config(LinphoneCore *lc);
1104 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1106 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
1108 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
1110 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
1112 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
1114 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1116 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1118 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
1120 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
1122 void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info);
1124 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
1126 void linphone_core_enable_audio_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1128 bool_t linphone_core_audio_adaptive_jittcomp_enabled(LinphoneCore *lc);
1130 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
1132 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
1134 void linphone_core_enable_video_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1136 bool_t linphone_core_video_adaptive_jittcomp_enabled(LinphoneCore *lc);
1138 int linphone_core_get_video_jittcomp(LinphoneCore *lc);
1140 void linphone_core_set_video_jittcomp(LinphoneCore *lc, int value);
1142 int linphone_core_get_audio_port(const LinphoneCore *lc);
1144 void linphone_core_get_audio_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1146 int linphone_core_get_video_port(const LinphoneCore *lc);
1148 void linphone_core_get_video_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1150 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
1152 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
1154 void linphone_core_set_audio_port_range(LinphoneCore *lc, int min_port, int max_port);
1156 void linphone_core_set_video_port(LinphoneCore *lc, int port);
1158 void linphone_core_set_video_port_range(LinphoneCore *lc, int min_port, int max_port);
1160 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
1162 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
1164 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
1166 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
1168 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
1170 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
1172 int linphone_core_get_sip_port(LinphoneCore *lc);
1174 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
1176 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
1179 * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
1180 * @param lc #LinphoneCore
1181 * @return socket file descriptor
1183 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
1185 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
1187 int linphone_core_get_inc_timeout(LinphoneCore *lc);
1189 void linphone_core_set_in_call_timeout(LinphoneCore *lc, int seconds);
1191 int linphone_core_get_in_call_timeout(LinphoneCore *lc);
1193 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
1195 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
1197 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
1199 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
1201 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
1203 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
1205 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
1207 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
1209 /* sound functions */
1210 /* returns a null terminated static array of string describing the sound devices */
1211 const char** linphone_core_get_sound_devices(LinphoneCore *lc);
1212 void linphone_core_reload_sound_devices(LinphoneCore *lc);
1213 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
1214 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
1215 int linphone_core_get_ring_level(LinphoneCore *lc);
1216 int linphone_core_get_play_level(LinphoneCore *lc);
1217 int linphone_core_get_rec_level(LinphoneCore *lc);
1218 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
1219 void linphone_core_set_play_level(LinphoneCore *lc, int level);
1221 void linphone_core_set_mic_gain_db(LinphoneCore *lc, float level);
1222 float linphone_core_get_mic_gain_db(LinphoneCore *lc);
1223 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
1224 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
1226 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
1227 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
1228 const char * linphone_core_get_playback_device(LinphoneCore *lc);
1229 const char * linphone_core_get_capture_device(LinphoneCore *lc);
1230 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
1231 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
1232 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
1233 char linphone_core_get_sound_source(LinphoneCore *lc);
1234 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
1235 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
1236 const char *linphone_core_get_ring(const LinphoneCore *lc);
1237 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1238 void linphone_core_verify_server_cn(LinphoneCore *lc, bool_t yesno);
1239 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1240 const char *linphone_core_get_root_ca(LinphoneCore *lc);
1241 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1242 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1244 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1245 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1247 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1248 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1249 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1251 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1252 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1254 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1255 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1257 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1261 * @ingroup media_parameters
1263 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1265 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1267 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1268 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1271 /* returns a list of LinphoneCallLog */
1272 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1273 void linphone_core_clear_call_logs(LinphoneCore *lc);
1274 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1275 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1276 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1279 bool_t linphone_core_video_supported(LinphoneCore *lc);
1280 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1281 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1282 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1283 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1285 typedef struct MSVideoSizeDef{
1289 /* returns a zero terminated table of MSVideoSizeDef*/
1290 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1291 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1292 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1293 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1295 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1296 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1298 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1299 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1302 /* returns a null terminated static array of string describing the webcams */
1303 void linphone_core_reload_video_devices(LinphoneCore *lc);
1304 const char** linphone_core_get_video_devices(const LinphoneCore *lc);
1305 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1306 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1308 /* Set and get static picture to be used when "Static picture" is the video device */
1309 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1310 const char *linphone_core_get_static_picture(LinphoneCore *lc);
1312 /* Set and get frame rate for static picture */
1313 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1314 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1316 /*function to be used for eventually setting window decorations (icons, title...)*/
1317 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1318 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1320 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1321 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1323 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1324 int linphone_core_get_device_rotation(LinphoneCore *lc );
1325 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1327 /* start or stop streaming video in case of embedded window */
1328 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1330 /*play/record support: use files instead of soundcard*/
1331 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1332 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1333 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1335 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1336 void linphone_core_stop_dtmf(LinphoneCore *lc);
1338 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1341 int linphone_core_get_mtu(const LinphoneCore *lc);
1342 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1345 * @ingroup network_parameters
1346 * This method is called by the application to notify the linphone core library when network is reachable.
1347 * Calling this method with true trigger linphone to initiate a registration process for all proxies.
1348 * Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
1350 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1352 * @ingroup network_parameters
1353 * return network state either as positioned by the application or by linphone itself.
1355 bool_t linphone_core_is_network_reachable(LinphoneCore* lc);
1358 * @ingroup network_parameters
1359 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1361 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1363 * @ingroup network_parameters
1364 * Is signaling keep alive
1366 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1368 void *linphone_core_get_user_data(LinphoneCore *lc);
1369 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1371 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1372 the config file with your own sections */
1373 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1375 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1376 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1378 /*returns the list of registered SipSetup (linphonecore plugins) */
1379 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1381 void linphone_core_destroy(LinphoneCore *lc);
1383 /*for advanced users:*/
1384 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1385 struct _LinphoneRtpTransportFactories{
1386 LinphoneRtpTransportFactoryFunc audio_rtp_func;
1387 void *audio_rtp_func_data;
1388 LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1389 void *audio_rtcp_func_data;
1390 LinphoneRtpTransportFactoryFunc video_rtp_func;
1391 void *video_rtp_func_data;
1392 LinphoneRtpTransportFactoryFunc video_rtcp_func;
1393 void *video_rtcp_func_data;
1395 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1397 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1399 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1401 int linphone_core_get_calls_nb(const LinphoneCore *lc);
1403 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1405 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1407 * force registration refresh to be initiated upon next iterate
1410 void linphone_core_refresh_registers(LinphoneCore* lc);
1412 /* Path to the file storing secrets cache */
1413 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1414 const char *linphone_core_get_zrtp_secrets_file(LinphoneCore *lc);
1416 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1418 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1419 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1420 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1421 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1422 int linphone_core_enter_conference(LinphoneCore *lc);
1423 int linphone_core_leave_conference(LinphoneCore *lc);
1424 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1426 int linphone_core_terminate_conference(LinphoneCore *lc);
1427 int linphone_core_get_conference_size(LinphoneCore *lc);
1429 int linphone_core_get_max_calls(LinphoneCore *lc);
1430 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1432 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1434 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1437 * Choose media encryption policy to be used for RTP packets
1439 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1440 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1442 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1444 * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1445 * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1447 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1450 * Init call params using LinphoneCore's current configuration
1452 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1455 * True if tunnel support was compiled.
1457 bool_t linphone_core_tunnel_available(void);
1459 typedef struct _LinphoneTunnel LinphoneTunnel;
1461 * get tunnel instance if available
1463 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1465 void linphone_core_set_sip_dscp(LinphoneCore *lc, int dscp);
1466 int linphone_core_get_sip_dscp(const LinphoneCore *lc);
1468 void linphone_core_set_audio_dscp(LinphoneCore *lc, int dscp);
1469 int linphone_core_get_audio_dscp(const LinphoneCore *lc);
1471 void linphone_core_set_video_dscp(LinphoneCore *lc, int dscp);
1472 int linphone_core_get_video_dscp(const LinphoneCore *lc);