3 Copyright (C) 2000 - 2010 Simon MORLAT (simon.morlat@linphone.org)
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 #ifndef LINPHONECORE_H
20 #define LINPHONECORE_H
22 #include "ortp/ortp.h"
23 #include "ortp/payloadtype.h"
24 #include "mediastreamer2/mscommon.h"
25 #include "mediastreamer2/msvideo.h"
30 #include "linphone/sipsetup.h"
33 #define LINPHONE_IPADDR_SIZE 64
34 #define LINPHONE_HOSTNAME_SIZE 128
43 * Linphone core main object created by function linphone_core_new() .
44 * @ingroup initializing
46 typedef struct _LinphoneCore LinphoneCore;
52 struct _LCSipTransports{
59 typedef struct _LCSipTransports LCSipTransports;
62 * Object that represents a SIP address.
64 * The LinphoneAddress is an opaque object to represents SIP addresses, ie
65 * the content of SIP's 'from' and 'to' headers.
66 * A SIP address is made of display name, username, domain name, port, and various
67 * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
68 * The LinphoneAddress has methods to extract and manipulate all parts of the address.
69 * When some part of the address (for example the username) is empty, the accessor methods
72 * @ingroup linphone_address
73 * @var LinphoneAddress
75 typedef struct SalAddress LinphoneAddress;
77 #include "linphonefriend.h"
79 #include "linphone/linphonefriend.h"
82 LinphoneAddress * linphone_address_new(const char *uri);
83 LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
84 const char *linphone_address_get_scheme(const LinphoneAddress *u);
85 const char *linphone_address_get_display_name(const LinphoneAddress* u);
86 const char *linphone_address_get_username(const LinphoneAddress *u);
87 const char *linphone_address_get_domain(const LinphoneAddress *u);
89 * Get port number as an integer value.
92 int linphone_address_get_port_int(const LinphoneAddress *u);
94 * Get port number, null if not present.
96 const char* linphone_address_get_port(const LinphoneAddress *u);
97 void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
98 void linphone_address_set_username(LinphoneAddress *uri, const char *username);
99 void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
100 void linphone_address_set_port(LinphoneAddress *uri, const char *port);
101 void linphone_address_set_port_int(LinphoneAddress *uri, int port);
102 /*remove tags, params etc... so that it is displayable to the user*/
103 void linphone_address_clean(LinphoneAddress *uri);
104 char *linphone_address_as_string(const LinphoneAddress *u);
105 char *linphone_address_as_string_uri_only(const LinphoneAddress *u);
106 bool_t linphone_address_weak_equal(const LinphoneAddress *a1, const LinphoneAddress *a2);
107 void linphone_address_destroy(LinphoneAddress *u);
109 struct _SipSetupContext;
113 * Enum representing the direction of a call.
116 enum _LinphoneCallDir {
117 LinphoneCallOutgoing, /**< outgoing calls*/
118 LinphoneCallIncoming /**< incoming calls*/
125 typedef enum _LinphoneCallDir LinphoneCallDir;
128 * Enum representing the status of a call
131 typedef enum _LinphoneCallStatus {
132 LinphoneCallSuccess, /**< The call was sucessful*/
133 LinphoneCallAborted, /**< The call was aborted */
134 LinphoneCallMissed, /**< The call was missed (unanswered)*/
135 LinphoneCallDeclined /**< The call was declined, either locally or by remote end*/
136 } LinphoneCallStatus;
139 * Structure representing a call log.
144 typedef struct _LinphoneCallLog{
145 LinphoneCallDir dir; /**< The direction of the call*/
146 LinphoneCallStatus status; /**< The status of the call*/
147 LinphoneAddress *from; /**<Originator of the call as a LinphoneAddress object*/
148 LinphoneAddress *to; /**<Destination of the call as a LinphoneAddress object*/
149 char start_date[128]; /**<Human readable string containg the start date*/
150 int duration; /**<Duration of the call in seconds*/
153 rtp_stats_t local_stats;
154 rtp_stats_t remote_stats;
157 struct _LinphoneCore *lc;
158 time_t start_date_time; /**Start date of the call in seconds as expressed in a time_t */
163 * Enum describing type of media encryption types.
165 enum LinphoneMediaEncryption {
166 LinphoneMediaEncryptionNone,
167 LinphoneMediaEncryptionSRTP,
168 LinphoneMediaEncryptionZRTP
172 * Enum describing type of media encryption types.
174 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
177 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
178 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
179 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
180 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
181 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
182 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
183 char * linphone_call_log_to_str(LinphoneCallLog *cl);
185 struct _LinphoneCallParams;
188 * The LinphoneCallParams is an object containing various call related parameters.
189 * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
192 typedef struct _LinphoneCallParams LinphoneCallParams;
194 const PayloadType* linphone_call_params_get_used_audio_codec(const LinphoneCallParams *cp);
195 const PayloadType* linphone_call_params_get_used_video_codec(const LinphoneCallParams *cp);
196 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
197 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
198 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
199 LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
200 void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
201 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
202 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
203 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
204 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
205 void linphone_call_params_destroy(LinphoneCallParams *cp);
208 * Enum describing failure reasons.
209 * @ingroup initializing
211 enum _LinphoneReason{
213 LinphoneReasonNoResponse, /**<No response received from remote*/
214 LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
215 LinphoneReasonDeclined, /**<The call has been declined*/
216 LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
217 LinphoneReasonNotAnswered
221 * Enum describing failure reasons.
222 * @ingroup initializing
224 typedef enum _LinphoneReason LinphoneReason;
226 const char *linphone_reason_to_string(LinphoneReason err);
229 * Structure describing policy regarding video streams establishments.
230 * @ingroup media_parameters
232 struct _LinphoneVideoPolicy{
233 bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/
234 bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
239 * Structure describing policy regarding video streams establishments.
240 * @ingroup media_parameters
242 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
245 * The LinphoneCall object represents a call issued or received by the LinphoneCore
246 * @ingroup call_control
248 struct _LinphoneCall;
250 * The LinphoneCall object represents a call issued or received by the LinphoneCore
251 * @ingroup call_control
253 typedef struct _LinphoneCall LinphoneCall;
257 * @addtogroup call_misc
261 #define LINPHONE_CALL_STATS_AUDIO 0
262 #define LINPHONE_CALL_STATS_VIDEO 1
265 * Enum describing ICE states.
266 * @ingroup initializing
268 enum _LinphoneIceState{
269 LinphoneIceStateNotActivated, /**< ICE has not been activated for this call */
270 LinphoneIceStateInProgress, /**< ICE process is in progress */
271 LinphoneIceStateHostConnection, /**< ICE has established a direct connection to the remote host */
272 LinphoneIceStateReflexiveConnection, /**< ICE has established a connection to the remote host through one or several NATs */
273 LinphoneIceStateRelayConnection /**< ICE has established a connection through a relay */
277 * Enum describing Ice states.
278 * @ingroup initializing
280 typedef enum _LinphoneIceState LinphoneIceState;
283 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
285 * 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
286 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
288 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
290 typedef struct _LinphoneCallStats LinphoneCallStats;
293 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
295 * 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
296 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
298 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
300 struct _LinphoneCallStats {
301 int type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
302 jitter_stats_t jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
303 mblk_t* received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
304 mblk_t* sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
305 float round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
306 LinphoneIceState ice_state; /**< State of ICE processing. */
307 float download_bandwidth; /**<Download bandwidth measurement of received stream, expressed in kbit/s, including IP/UDP/RTP headers*/
308 float upload_bandwidth; /**<Download bandwidth measurement of sent stream, expressed in kbit/s, including IP/UDP/RTP headers*/
315 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
316 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
319 /** Callback prototype */
320 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
323 * LinphoneCallState enum represents the different state a call can reach into.
324 * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
325 * @ingroup call_control
327 typedef enum _LinphoneCallState{
328 LinphoneCallIdle, /**<Initial call state */
329 LinphoneCallIncomingReceived, /**<This is a new incoming call */
330 LinphoneCallOutgoingInit, /**<An outgoing call is started */
331 LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
332 LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
333 LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
334 LinphoneCallConnected, /**<Connected, the call is answered */
335 LinphoneCallStreamsRunning, /**<The media streams are established and running*/
336 LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
337 LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
338 LinphoneCallResuming, /**<The call is being resumed by local end*/
339 LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
340 LinphoneCallError, /**<The call encountered an error*/
341 LinphoneCallEnd, /**<The call ended normally*/
342 LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
343 LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
344 LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
345 LinphoneCallUpdated, /**<The remote accepted the call update initiated by us */
346 LinphoneCallReleased /**< The call object is no more retained by the core */
349 const char *linphone_call_state_to_string(LinphoneCallState cs);
351 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
352 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
353 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
354 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
355 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
356 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
357 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
358 LinphoneCall * linphone_call_ref(LinphoneCall *call);
359 void linphone_call_unref(LinphoneCall *call);
360 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
361 const char *linphone_call_get_refer_to(const LinphoneCall *call);
362 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
363 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
364 int linphone_call_get_duration(const LinphoneCall *call);
365 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
366 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
367 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
368 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
369 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
370 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
371 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
372 float linphone_call_get_play_volume(LinphoneCall *call);
373 float linphone_call_get_record_volume(LinphoneCall *call);
374 float linphone_call_get_current_quality(LinphoneCall *call);
375 float linphone_call_get_average_quality(LinphoneCall *call);
376 const char* linphone_call_get_authentication_token(LinphoneCall *call);
377 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
378 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
379 void linphone_call_send_vfu_request(LinphoneCall *call);
380 void *linphone_call_get_user_pointer(LinphoneCall *call);
381 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
382 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
383 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
385 * Return TRUE if this call is currently part of a conference
386 *@param call #LinphoneCall
387 *@return TRUE if part of a conference.
389 @ingroup call_control
391 bool_t linphone_call_is_in_conference(const LinphoneCall *call);
393 * Enables or disable echo cancellation for this call
397 * @ingroup media_parameters
399 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
401 * Returns TRUE if echo cancellation is enabled.
403 * @ingroup media_parameters
405 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
407 * Enables or disable echo limiter for this call
411 * @ingroup media_parameters
413 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
415 * Returns TRUE if echo limiter is enabled.
417 * @ingroup media_parameters
419 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
421 /*keep this in sync with mediastreamer2/msvolume.h*/
424 * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
427 #define LINPHONE_VOLUME_DB_LOWEST (-120)
430 * @addtogroup proxies
434 * The LinphoneProxyConfig object represents a proxy configuration to be used
435 * by the LinphoneCore object.
436 * Its fields must not be used directly in favour of the accessors methods.
437 * Once created and filled properly the LinphoneProxyConfig can be given to
438 * LinphoneCore with linphone_core_add_proxy_config().
439 * This will automatically triggers the registration, if enabled.
441 * The proxy configuration are persistent to restarts because they are saved
442 * in the configuration file. As a consequence, after linphone_core_new() there
443 * might already be a list of configured proxy that can be examined with
444 * linphone_core_get_proxy_config_list().
446 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
447 * that is used by default for calls.
449 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
452 * LinphoneRegistrationState describes proxy registration states.
454 typedef enum _LinphoneRegistrationState{
455 LinphoneRegistrationNone, /**<Initial state for registrations */
456 LinphoneRegistrationProgress, /**<Registration is in progress */
457 LinphoneRegistrationOk, /**< Registration is successful */
458 LinphoneRegistrationCleared, /**< Unregistration succeeded */
459 LinphoneRegistrationFailed /**<Registration failed */
460 }LinphoneRegistrationState;
463 * Human readable version of the #LinphoneRegistrationState
466 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
468 LinphoneProxyConfig *linphone_proxy_config_new(void);
469 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
470 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
471 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
472 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
474 * Indicates either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
475 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
476 * @param obj object pointer
477 * @param val if true, registration will be engaged
479 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
480 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
481 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
482 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
484 * Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
485 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
486 * @param obj object pointer
487 * @param val if true, publish will be engaged
490 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
491 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
492 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
494 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
495 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
496 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
498 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
499 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
500 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
501 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
502 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
503 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
504 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
505 const char *linphone_proxy_config_get_contact_parameters(const LinphoneProxyConfig *obj);
506 void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, const char *contact_params);
507 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
509 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
510 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
512 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
514 /* destruction is called automatically when removing the proxy config */
515 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
516 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
517 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
518 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
520 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
522 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
524 * attached a user data to a proxy config
526 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
528 * get user data to a proxy config. return null if any
530 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
536 typedef struct _LinphoneAccountCreator{
537 struct _LinphoneCore *lc;
538 struct _SipSetupContext *ssctx;
546 }LinphoneAccountCreator;
548 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
549 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
550 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
551 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
552 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
553 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
554 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
555 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
556 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
557 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
558 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
559 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
560 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
562 struct _LinphoneAuthInfo;
565 * @ingroup authentication
566 * Object holding authentication information.
568 * @note The object's fields should not be accessed directly. Prefer using
569 * the accessor methods.
571 * In most case, authentication information consists of a username and password.
572 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
573 * different SIP domains.
575 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
576 * order to become known and used automatically when needed.
577 * Use linphone_core_add_auth_info() for that purpose.
579 * The LinphoneCore object can take the initiative to request authentication information
580 * when needed to the application through the auth_info_requested callback of the
581 * LinphoneCoreVTable structure.
583 * The application can respond to this information request later using
584 * linphone_core_add_auth_info(). This will unblock all pending authentication
585 * transactions and retry them with authentication headers.
588 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
590 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
591 const char *passwd, const char *ha1,const char *realm);
592 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
593 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
594 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
596 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
597 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
598 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
600 /* you don't need those function*/
601 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
602 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
605 struct _LinphoneChatRoom;
607 * @addtogroup chatroom
612 * A chat room message to old content to be sent.
613 * <br> Can be created by linphone_chat_room_create_message().
615 typedef struct _LinphoneChatMessage LinphoneChatMessage;
618 * A chat room is the place where text messages are exchanged.
619 * <br> Can be created by linphone_core_create_chat_room().
621 typedef struct _LinphoneChatRoom LinphoneChatRoom;
624 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
625 * @param lc #LinphoneCore object
626 * @param to destination address for messages
627 * @return #LinphoneChatRoom where messaging can take place.
629 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
632 * @param cr #LinphoneChatRoom object
634 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
637 * create a message attached to a dedicated chat room;
639 LinphoneChatMessage* linphone_chat_room_create_message(const LinphoneChatRoom *cr,const char* message);
643 * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
644 * @param cr #LinphoneChatRoom object
645 * @return #LinphoneAddress peer address
647 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
649 * send a message to peer member of this chat room.
650 * @param cr #LinphoneChatRoom object
651 * @param msg message to be sent
653 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
655 *LinphoneChatMessageStatus used to notify if message has been succesfully delivered or not
657 typedef enum _LinphoneChatMessageStates {
658 LinphoneChatMessageStateIdle, /** initial state*/
659 LinphoneChatMessageStateInProgress, /*delivery in progress**/
660 LinphoneChatMessageStateDelivered, /** message succesffully delivered an acknoleged by remote end point*/
661 LinphoneChatMessageStateNotDelivered /** message was not delivered*/
662 }LinphoneChatMessageState;
668 const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
671 * clone a chat message
672 *@param message #LinphoneChatMessage obj
673 *@return #LinphoneChatMessage
675 LinphoneChatMessage* linphone_chat_message_clone(const LinphoneChatMessage* message);
677 * set origine of the message
678 *@param message #LinphoneChatMessage obj
679 *@param from #LinphoneAddress origin of this message (copied)
681 void linphone_chat_message_set_from(LinphoneChatMessage* message, const LinphoneAddress* from);
684 * get origine of the message
685 *@param message #LinphoneChatMessage obj
686 *@return #LinphoneAddress
688 LinphoneAddress* linphone_chat_message_get_from(const LinphoneChatMessage* message);
691 * Linphone message can carry external body as defined by rfc2017
692 * @param message #LinphoneChatMessage
693 * @return return external body url null if not present.
695 const char* linphone_chat_message_get_external_body_url(const LinphoneChatMessage* message);
698 * Linphone message can carry external body as defined by rfc2017
700 * @param #LinphoneChatMessage
701 * @param url ex: access-type=URL; URL="http://www.foo.com/file"
703 void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
706 * get text part of this message
707 *@return text or NULL if no text.
709 const char * linphone_chat_message_get_text(const LinphoneChatMessage* message);
711 * user pointer get function
714 void* linphone_chat_message_get_user_data(const LinphoneChatMessage* message);
716 * user pointer set function
718 void linphone_chat_message_set_user_data(LinphoneChatMessage* message,void*);
721 * Call back used to notify message delivery status
722 *@param msg #LinphoneChatMessage object
723 *@param status #LinphoneChatMessageStatus
724 *@param ud us user data
726 typedef void (*LinphoneChatMessageStateChangeCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
728 * send a message to peer member of this chat room.
729 * @param cr #LinphoneChatRoom object
730 * @param msg #LinphoneChatMessage message to be sent
731 * @param status_cb #LinphoneChatMessageStatus status call back invoked when to message is delivered or not. May be NULL
732 * @param ud user data for the status cb.
734 void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage* msg,LinphoneChatMessageStateChangeCb status_cb,void* ud);
735 LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr);
736 LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
737 char* linphone_chat_message_get_message(LinphoneChatMessage *msg);
738 const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
739 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
740 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
748 * @addtogroup initializing
753 * LinphoneGlobalState describes the global state of the LinphoneCore object.
754 * It is notified via the LinphoneCoreVTable::global_state_changed
756 typedef enum _LinphoneGlobalState{
758 LinphoneGlobalStartup,
760 LinphoneGlobalShutdown
761 }LinphoneGlobalState;
763 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
766 /**Call state notification callback prototype*/
767 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
768 /**Call state notification callback prototype*/
769 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
770 /**Call encryption changed callback prototype*/
771 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
774 * Registration state notification callback prototype
776 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
777 /** Callback prototype */
778 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
779 /** Callback prototype */
780 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
781 /** Callback prototype */
782 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
783 /** Callback prototype */
784 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
785 /** Callback prototype */
786 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
787 /** Callback prototype */
788 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
790 * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
791 * @param lc #LinphoneCore object .
792 * @param lf Updated #LinphoneFriend .
794 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
796 * Reports that a new subscription request has been received and wait for a decision.
797 * <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
798 * @param lc #LinphoneCore object
799 * @param lf #LinphoneFriend corresponding to the subscriber
800 * @param url of the subscriber
803 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
804 /** Callback prototype */
805 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
806 /** Callback prototype */
807 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
810 * @deprecated use #MessageReceived instead.
812 * @param lc #LinphoneCore object
813 * @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.
814 * @param from #LinphoneAddress from
815 * @param message incoming message
817 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
819 * Chat message callback prototype
821 * @param lc #LinphoneCore object
822 * @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.
823 * @param LinphoneChatMessage incoming message
825 typedef void (*MessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
827 /** Callback prototype */
828 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
829 /** Callback prototype */
830 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
831 /** Callback prototype */
832 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
833 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
834 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
835 /** Callback prototype for receiving quality statistics for calls*/
836 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
839 * This structure holds all callbacks that the application should implement.
842 typedef struct _LinphoneVTable{
843 LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
844 LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
845 LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
846 NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
847 NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
848 AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
849 CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
850 TextMessageReceived text_received; /** @deprecated, use #message_received instead <br> A text message has been received */
851 MessageReceived message_received; /** a message is received, can be text or external body*/
852 DtmfReceived dtmf_received; /**< A dtmf has been received received */
853 ReferReceived refer_received; /**< An out of call refer was received */
854 CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
855 LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
856 BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
857 NotifyReceivedCb notify_recv; /**< Other notifications*/
858 CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
859 DisplayStatusCb display_status; /**< DEPRECATED Callback that notifies various events with human readable text.*/
860 DisplayMessageCb display_message;/**< DEPRECATED Callback to display a message to the user */
861 DisplayMessageCb display_warning;/**< DEPRECATED Callback to display a warning to the user */
862 DisplayUrlCb display_url; /**< DEPRECATED */
863 ShowInterfaceCb show; /**< DEPRECATED Notifies the application that it should show up*/
864 } LinphoneCoreVTable;
870 typedef struct _LCCallbackObj
872 LinphoneCoreCbFunc _func;
878 typedef enum _LinphoneFirewallPolicy{
879 LinphonePolicyNoFirewall,
880 LinphonePolicyUseNatAddress,
881 LinphonePolicyUseStun,
883 } LinphoneFirewallPolicy;
885 typedef enum _LinphoneWaitingState{
886 LinphoneWaitingStart,
887 LinphoneWaitingProgress,
888 LinphoneWaitingFinished
889 } LinphoneWaitingState;
890 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
895 void linphone_core_enable_logs(FILE *file);
896 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
897 void linphone_core_disable_logs(void);
898 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
899 void linphone_core_set_user_agent(const char *ua_name, const char *version);
900 const char *linphone_core_get_version(void);
902 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
903 const char *config_path, const char *factory_config, void* userdata);
905 /* function to be periodically called in a main loop */
906 void linphone_core_iterate(LinphoneCore *lc);
907 #if 0 /*not implemented yet*/
909 * @ingroup initializing
910 * Provide Linphone Core with an unique identifier. This be later used to identified contact address coming from this device.
911 * Value is not saved.
913 * @param string identifying the device, can be EMEI or UDID
916 void linphone_core_set_device_identifier(LinphoneCore *lc,const char* device_id);
918 * @ingroup initializing
919 * get Linphone unique identifier
922 const char* linphone_core_get_device_identifier(const LinphoneCore *lc);
926 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
928 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
930 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
932 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
934 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
936 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
938 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
940 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
942 bool_t linphone_core_in_call(const LinphoneCore *lc);
944 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
946 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
948 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
950 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
952 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
954 int linphone_core_terminate_all_calls(LinphoneCore *lc);
956 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
958 int linphone_core_pause_all_calls(LinphoneCore *lc);
960 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
962 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
964 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
966 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
968 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
970 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
972 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
974 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
976 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
978 const char * linphone_core_get_identity(LinphoneCore *lc);
980 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
981 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
983 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
984 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
986 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
987 const char * linphone_core_get_identity(LinphoneCore *lc);
988 /*0= no bandwidth limit*/
989 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
990 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
992 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
993 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
995 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
996 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
998 * set audio packetization time linphone expect to receive from peer
999 * @ingroup media_parameters
1002 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
1004 * get audio packetization time linphone expect to receive from peer, 0 means unspecified
1005 * @ingroup media_parameters
1007 int linphone_core_get_download_ptime(LinphoneCore *lc);
1009 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
1011 int linphone_core_get_upload_ptime(LinphoneCore *lc);
1013 /* returns a MSList of PayloadType */
1014 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
1016 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
1017 /* returns a MSList of PayloadType */
1018 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
1020 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
1022 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
1024 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
1027 * Wildcard value used by #linphone_core_find_payload_type to ignore rate in search algirithm
1028 * @ingroup media_parameters
1030 #define LINPHONE_FIND_PAYLOAD_IGNORE_RATE -1
1032 * Wildcard value used by #linphone_core_find_payload_type to ignore channel in search algirithm
1033 * @ingroup media_parameters
1035 #define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS -1
1037 * Get payload type from mime type and clock rate
1038 * @ingroup media_parameters
1039 * This function searches in audio and video codecs for the given payload type name and clockrate.
1040 * @param lc #LinphoneCore object
1041 * @param type payload mime type (I.E SPEEX, PCMU, VP8)
1042 * @param rate, can be #LINPHONE_FIND_PAYLOAD_IGNORE_RATE
1043 * @param channels, number of channels, can be #LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
1044 * @return Returns NULL if not found.
1046 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate, int channels) ;
1048 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
1050 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
1052 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
1056 *Create a proxy config with default value from Linphone core.
1057 *@param lc #LinphoneCore object
1058 *@return #LinphoneProxyConfig with defualt value set
1060 LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *lc);
1062 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1064 void linphone_core_clear_proxy_config(LinphoneCore *lc);
1066 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1068 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
1070 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
1072 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
1074 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
1076 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1078 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1080 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
1082 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
1084 void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info);
1086 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
1088 void linphone_core_enable_audio_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1090 bool_t linphone_core_audio_adaptive_jittcomp_enabled(LinphoneCore *lc);
1092 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
1094 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
1096 void linphone_core_enable_video_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1098 bool_t linphone_core_video_adaptive_jittcomp_enabled(LinphoneCore *lc);
1100 int linphone_core_get_video_jittcomp(LinphoneCore *lc);
1102 void linphone_core_set_video_jittcomp(LinphoneCore *lc, int value);
1104 int linphone_core_get_audio_port(const LinphoneCore *lc);
1106 int linphone_core_get_video_port(const LinphoneCore *lc);
1108 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
1110 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
1112 void linphone_core_set_video_port(LinphoneCore *lc, int port);
1114 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
1116 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
1118 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
1120 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
1122 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
1124 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
1126 int linphone_core_get_sip_port(LinphoneCore *lc);
1128 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
1130 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
1133 * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
1134 * @param lc #LinphoneCore
1135 * @return socket file descriptor
1137 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
1139 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
1141 int linphone_core_get_inc_timeout(LinphoneCore *lc);
1143 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
1145 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
1147 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
1149 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
1151 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
1153 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
1155 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
1157 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
1159 /* sound functions */
1160 /* returns a null terminated static array of string describing the sound devices */
1161 const char** linphone_core_get_sound_devices(LinphoneCore *lc);
1162 void linphone_core_reload_sound_devices(LinphoneCore *lc);
1163 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
1164 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
1165 int linphone_core_get_ring_level(LinphoneCore *lc);
1166 int linphone_core_get_play_level(LinphoneCore *lc);
1167 int linphone_core_get_rec_level(LinphoneCore *lc);
1168 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
1169 void linphone_core_set_play_level(LinphoneCore *lc, int level);
1171 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
1173 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
1174 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
1175 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
1176 const char * linphone_core_get_playback_device(LinphoneCore *lc);
1177 const char * linphone_core_get_capture_device(LinphoneCore *lc);
1178 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
1179 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
1180 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
1181 char linphone_core_get_sound_source(LinphoneCore *lc);
1182 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
1183 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
1184 const char *linphone_core_get_ring(const LinphoneCore *lc);
1185 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1186 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1187 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1188 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1190 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1191 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1193 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1194 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1195 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1197 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1198 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1200 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1201 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1203 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1207 * @ingroup media_parameters
1209 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1211 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
1212 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1214 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1215 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1218 /* returns a list of LinphoneCallLog */
1219 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1220 void linphone_core_clear_call_logs(LinphoneCore *lc);
1221 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1222 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1223 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1226 bool_t linphone_core_video_supported(LinphoneCore *lc);
1227 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1228 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1229 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1230 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1232 typedef struct MSVideoSizeDef{
1236 /* returns a zero terminated table of MSVideoSizeDef*/
1237 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1238 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1239 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1240 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1242 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1243 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1245 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1246 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1249 /* returns a null terminated static array of string describing the webcams */
1250 void linphone_core_reload_video_devices(LinphoneCore *lc);
1251 const char** linphone_core_get_video_devices(const LinphoneCore *lc);
1252 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1253 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1255 /* Set static picture to be used when "Static picture" is the video device */
1256 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1258 /* Set and get frame rate for static picture */
1259 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1260 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1262 /*function to be used for eventually setting window decorations (icons, title...)*/
1263 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1264 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1266 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1267 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1269 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1270 int linphone_core_get_device_rotation(LinphoneCore *lc );
1271 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1273 /* start or stop streaming video in case of embedded window */
1274 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1276 /*play/record support: use files instead of soundcard*/
1277 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1278 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1279 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1281 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1282 void linphone_core_stop_dtmf(LinphoneCore *lc);
1284 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1287 int linphone_core_get_mtu(const LinphoneCore *lc);
1288 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1291 * @ingroup network_parameters
1292 * This method is called by the application to notify the linphone core library when network is reachable.
1293 * Calling this method with true trigger linphone to initiate a registration process for all proxies.
1294 * Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
1296 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1298 * @ingroup network_parameters
1299 * return network state either as positioned by the application or by linphone itself.
1301 bool_t linphone_core_is_network_reachable(LinphoneCore* lc);
1304 * @ingroup network_parameters
1305 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1307 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1309 * @ingroup network_parameters
1310 * Is signaling keep alive
1312 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1314 void *linphone_core_get_user_data(LinphoneCore *lc);
1315 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1317 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1318 the config file with your own sections */
1319 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1321 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1322 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1324 /*returns the list of registered SipSetup (linphonecore plugins) */
1325 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1327 void linphone_core_destroy(LinphoneCore *lc);
1329 /*for advanced users:*/
1330 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1331 struct _LinphoneRtpTransportFactories{
1332 LinphoneRtpTransportFactoryFunc audio_rtp_func;
1333 void *audio_rtp_func_data;
1334 LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1335 void *audio_rtcp_func_data;
1336 LinphoneRtpTransportFactoryFunc video_rtp_func;
1337 void *video_rtp_func_data;
1338 LinphoneRtpTransportFactoryFunc video_rtcp_func;
1339 void *video_rtcp_func_data;
1341 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1343 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1345 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1347 int linphone_core_get_calls_nb(const LinphoneCore *lc);
1349 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1351 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1353 * force registration refresh to be initiated upon next iterate
1356 void linphone_core_refresh_registers(LinphoneCore* lc);
1358 /* Path to the file storing secrets cache */
1359 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1362 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1364 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1365 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1366 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1367 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1368 int linphone_core_enter_conference(LinphoneCore *lc);
1369 int linphone_core_leave_conference(LinphoneCore *lc);
1370 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1372 int linphone_core_terminate_conference(LinphoneCore *lc);
1373 int linphone_core_get_conference_size(LinphoneCore *lc);
1375 int linphone_core_get_max_calls(LinphoneCore *lc);
1376 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1378 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1380 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1383 * Choose media encryption policy to be used for RTP packets
1385 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1386 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1388 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1390 * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1391 * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1393 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1396 * Init call params using LinphoneCore's current configuration
1398 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1401 * True if tunnel support was compiled.
1403 bool_t linphone_core_tunnel_available(void);
1405 typedef struct LinphoneTunnel LinphoneTunnel;
1407 * get tunnel instance if available
1409 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1411 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);
1413 void linphone_core_set_sip_dscp(LinphoneCore *lc, int dscp);
1414 int linphone_core_get_sip_dscp(const LinphoneCore *lc);
1416 void linphone_core_set_audio_dscp(LinphoneCore *lc, int dscp);
1417 int linphone_core_get_audio_dscp(const LinphoneCore *lc);
1419 void linphone_core_set_video_dscp(LinphoneCore *lc, int dscp);
1420 int linphone_core_get_video_dscp(const LinphoneCore *lc);