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
42 * Linphone core main object created by function linphone_core_new() .
43 * @ingroup initializing
45 typedef struct _LinphoneCore LinphoneCore;
51 * Linphone core SIP transport ports.
52 * Use with #linphone_core_set_sip_transports
53 * @ingroup initializing
55 typedef struct _LCSipTransports{
57 * udp port to listening on, negative value if not set
61 * tcp port to listening on, negative value if not set
65 * dtls port to listening on, negative value if not set
69 * tls port to listening on, negative value if not set
76 * Object that represents a SIP address.
78 * The LinphoneAddress is an opaque object to represents SIP addresses, ie
79 * the content of SIP's 'from' and 'to' headers.
80 * A SIP address is made of display name, username, domain name, port, and various
81 * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
82 * The LinphoneAddress has methods to extract and manipulate all parts of the address.
83 * When some part of the address (for example the username) is empty, the accessor methods
86 * @ingroup linphone_address
87 * @var LinphoneAddress
89 typedef struct SalAddress LinphoneAddress;
91 #include "linphonefriend.h"
93 #include "linphone/linphonefriend.h"
96 LinphoneAddress * linphone_address_new(const char *uri);
97 LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
98 const char *linphone_address_get_scheme(const LinphoneAddress *u);
99 const char *linphone_address_get_display_name(const LinphoneAddress* u);
100 const char *linphone_address_get_username(const LinphoneAddress *u);
101 const char *linphone_address_get_domain(const LinphoneAddress *u);
103 * Get port number as an integer value.
106 int linphone_address_get_port_int(const LinphoneAddress *u);
108 * Get port number, null if not present.
110 const char* linphone_address_get_port(const LinphoneAddress *u);
111 void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
112 void linphone_address_set_username(LinphoneAddress *uri, const char *username);
113 void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
114 void linphone_address_set_port(LinphoneAddress *uri, const char *port);
115 void linphone_address_set_port_int(LinphoneAddress *uri, int port);
116 /*remove tags, params etc... so that it is displayable to the user*/
117 void linphone_address_clean(LinphoneAddress *uri);
118 char *linphone_address_as_string(const LinphoneAddress *u);
119 char *linphone_address_as_string_uri_only(const LinphoneAddress *u);
120 bool_t linphone_address_weak_equal(const LinphoneAddress *a1, const LinphoneAddress *a2);
121 void linphone_address_destroy(LinphoneAddress *u);
123 struct _SipSetupContext;
127 * Enum representing the direction of a call.
130 enum _LinphoneCallDir {
131 LinphoneCallOutgoing, /**< outgoing calls*/
132 LinphoneCallIncoming /**< incoming calls*/
139 typedef enum _LinphoneCallDir LinphoneCallDir;
142 * Enum representing the status of a call
145 typedef enum _LinphoneCallStatus {
146 LinphoneCallSuccess, /**< The call was sucessful*/
147 LinphoneCallAborted, /**< The call was aborted */
148 LinphoneCallMissed, /**< The call was missed (unanswered)*/
149 LinphoneCallDeclined /**< The call was declined, either locally or by remote end*/
150 } LinphoneCallStatus;
153 * Structure representing a call log.
158 typedef struct _LinphoneCallLog LinphoneCallLog;
161 * Enum describing type of media encryption types.
163 enum LinphoneMediaEncryption {
164 LinphoneMediaEncryptionNone,
165 LinphoneMediaEncryptionSRTP,
166 LinphoneMediaEncryptionZRTP
170 * Enum describing type of media encryption types.
172 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
175 LinphoneAddress *linphone_call_log_get_from(LinphoneCallLog *cl);
176 LinphoneAddress *linphone_call_log_get_to(LinphoneCallLog *cl);
177 LinphoneAddress *linphone_call_log_get_remote_address(LinphoneCallLog *cl);
178 LinphoneCallDir linphone_call_log_get_dir(LinphoneCallLog *cl);
179 LinphoneCallStatus linphone_call_log_get_status(LinphoneCallLog *cl);
180 LinphoneCallStatus linphone_call_log_video_enabled(LinphoneCallLog *cl);
181 time_t linphone_call_log_get_start_date(LinphoneCallLog *cl);
182 int linphone_call_log_get_duration(LinphoneCallLog *cl);
183 float linphone_call_log_get_quality(LinphoneCallLog *cl);
184 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
185 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
186 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
187 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
188 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
189 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
190 const char *linphone_call_log_get_call_id(const LinphoneCallLog *cl);
191 char * linphone_call_log_to_str(LinphoneCallLog *cl);
193 struct _LinphoneCallParams;
196 * The LinphoneCallParams is an object containing various call related parameters.
197 * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
200 typedef struct _LinphoneCallParams LinphoneCallParams;
202 const PayloadType* linphone_call_params_get_used_audio_codec(const LinphoneCallParams *cp);
203 const PayloadType* linphone_call_params_get_used_video_codec(const LinphoneCallParams *cp);
204 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
205 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
206 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
207 LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
208 void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
209 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
210 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
211 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
212 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
213 void linphone_call_params_destroy(LinphoneCallParams *cp);
214 bool_t linphone_call_params_low_bandwidth_enabled(const LinphoneCallParams *cp);
215 void linphone_call_params_enable_low_bandwidth(LinphoneCallParams *cp, bool_t enabled);
216 void linphone_call_params_set_record_file(LinphoneCallParams *cp, const char *path);
217 const char *linphone_call_params_get_record_file(const LinphoneCallParams *cp);
218 void linphone_call_params_add_custom_header(LinphoneCallParams *params, const char *header_name, const char *header_value);
219 const char *linphone_call_params_get_custom_header(const LinphoneCallParams *params, const char *header_name);
221 * Enum describing failure reasons.
222 * @ingroup initializing
224 enum _LinphoneReason{
226 LinphoneReasonNoResponse, /**<No response received from remote*/
227 LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
228 LinphoneReasonDeclined, /**<The call has been declined*/
229 LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
230 LinphoneReasonNotAnswered, /**<The call was not answered in time*/
231 LinphoneReasonBusy /**<Phone line was busy */
235 * Enum describing failure reasons.
236 * @ingroup initializing
238 typedef enum _LinphoneReason LinphoneReason;
240 const char *linphone_reason_to_string(LinphoneReason err);
243 * Structure describing policy regarding video streams establishments.
244 * @ingroup media_parameters
246 struct _LinphoneVideoPolicy{
247 bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/
248 bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
253 * Structure describing policy regarding video streams establishments.
254 * @ingroup media_parameters
256 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
259 * The LinphoneCall object represents a call issued or received by the LinphoneCore
260 * @ingroup call_control
262 struct _LinphoneCall;
264 * The LinphoneCall object represents a call issued or received by the LinphoneCore
265 * @ingroup call_control
267 typedef struct _LinphoneCall LinphoneCall;
271 * @addtogroup call_misc
275 #define LINPHONE_CALL_STATS_AUDIO 0
276 #define LINPHONE_CALL_STATS_VIDEO 1
279 * Enum describing ICE states.
280 * @ingroup initializing
282 enum _LinphoneIceState{
283 LinphoneIceStateNotActivated, /**< ICE has not been activated for this call */
284 LinphoneIceStateFailed, /**< ICE processing has failed */
285 LinphoneIceStateInProgress, /**< ICE process is in progress */
286 LinphoneIceStateHostConnection, /**< ICE has established a direct connection to the remote host */
287 LinphoneIceStateReflexiveConnection, /**< ICE has established a connection to the remote host through one or several NATs */
288 LinphoneIceStateRelayConnection /**< ICE has established a connection through a relay */
292 * Enum describing Ice states.
293 * @ingroup initializing
295 typedef enum _LinphoneIceState LinphoneIceState;
298 * Enum describing uPnP states.
299 * @ingroup initializing
301 enum _LinphoneUpnpState{
302 LinphoneUpnpStateIdle, /**< uPnP is not activate */
303 LinphoneUpnpStatePending, /**< uPnP process is in progress */
304 LinphoneUpnpStateAdding, /**< Internal use: Only used by port binding */
305 LinphoneUpnpStateRemoving, /**< Internal use: Only used by port binding */
306 LinphoneUpnpStateNotAvailable, /**< uPnP is not available */
307 LinphoneUpnpStateOk, /**< uPnP is enabled */
308 LinphoneUpnpStateKo, /**< uPnP processing has failed */
312 * Enum describing uPnP states.
313 * @ingroup initializing
315 typedef enum _LinphoneUpnpState LinphoneUpnpState;
319 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
321 * To receive these informations periodically and as soon as they are computed, the application is invited to place a #CallStatsUpdated callback in the LinphoneCoreVTable structure
322 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
324 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
326 typedef struct _LinphoneCallStats LinphoneCallStats;
329 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
331 * 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
332 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
334 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
336 struct _LinphoneCallStats {
337 int type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
338 jitter_stats_t jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
339 mblk_t* received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
340 mblk_t* sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
341 float round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
342 LinphoneIceState ice_state; /**< State of ICE processing. */
343 LinphoneUpnpState upnp_state; /**< State of uPnP processing. */
344 float download_bandwidth; /**<Download bandwidth measurement of received stream, expressed in kbit/s, including IP/UDP/RTP headers*/
345 float upload_bandwidth; /**<Download bandwidth measurement of sent stream, expressed in kbit/s, including IP/UDP/RTP headers*/
346 float local_late_rate; /**<percentage of packet received too late over last second*/
347 float local_loss_rate; /**<percentage of lost packet over last second*/
354 const LinphoneCallStats *linphone_call_get_audio_stats(LinphoneCall *call);
355 const LinphoneCallStats *linphone_call_get_video_stats(LinphoneCall *call);
358 /** Callback prototype */
359 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
362 * LinphoneCallState enum represents the different state a call can reach into.
363 * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
364 * @ingroup call_control
366 typedef enum _LinphoneCallState{
367 LinphoneCallIdle, /**<Initial call state */
368 LinphoneCallIncomingReceived, /**<This is a new incoming call */
369 LinphoneCallOutgoingInit, /**<An outgoing call is started */
370 LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
371 LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
372 LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
373 LinphoneCallConnected, /**<Connected, the call is answered */
374 LinphoneCallStreamsRunning, /**<The media streams are established and running*/
375 LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
376 LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
377 LinphoneCallResuming, /**<The call is being resumed by local end*/
378 LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
379 LinphoneCallError, /**<The call encountered an error*/
380 LinphoneCallEnd, /**<The call ended normally*/
381 LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
382 LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
383 LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
384 LinphoneCallUpdating, /**<A call update has been initiated by us */
385 LinphoneCallReleased /**< The call object is no more retained by the core */
388 const char *linphone_call_state_to_string(LinphoneCallState cs);
390 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
391 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
392 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
393 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
394 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
395 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
396 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
397 LinphoneCall * linphone_call_ref(LinphoneCall *call);
398 void linphone_call_unref(LinphoneCall *call);
399 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
400 const char *linphone_call_get_refer_to(const LinphoneCall *call);
401 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
402 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
403 int linphone_call_get_duration(const LinphoneCall *call);
404 const LinphoneCallParams * linphone_call_get_current_params(LinphoneCall *call);
405 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
406 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
407 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
408 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
409 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
410 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
411 const char *linphone_call_get_remote_contact(LinphoneCall *call);
412 float linphone_call_get_play_volume(LinphoneCall *call);
413 float linphone_call_get_record_volume(LinphoneCall *call);
414 float linphone_call_get_current_quality(LinphoneCall *call);
415 float linphone_call_get_average_quality(LinphoneCall *call);
416 const char* linphone_call_get_authentication_token(LinphoneCall *call);
417 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
418 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
419 void linphone_call_send_vfu_request(LinphoneCall *call);
420 void *linphone_call_get_user_pointer(LinphoneCall *call);
421 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
422 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
423 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
424 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);
425 void linphone_call_start_recording(LinphoneCall *call);
426 void linphone_call_stop_recording(LinphoneCall *call);
428 * Return TRUE if this call is currently part of a conference
429 *@param call #LinphoneCall
430 *@return TRUE if part of a conference.
432 @ingroup call_control
434 bool_t linphone_call_is_in_conference(const LinphoneCall *call);
436 * Enables or disable echo cancellation for this call
440 * @ingroup media_parameters
442 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
444 * Returns TRUE if echo cancellation is enabled.
446 * @ingroup media_parameters
448 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
450 * Enables or disable echo limiter for this call
454 * @ingroup media_parameters
456 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
458 * Returns TRUE if echo limiter is enabled.
460 * @ingroup media_parameters
462 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
464 /*keep this in sync with mediastreamer2/msvolume.h*/
467 * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
470 #define LINPHONE_VOLUME_DB_LOWEST (-120)
473 * @addtogroup proxies
477 * The LinphoneProxyConfig object represents a proxy configuration to be used
478 * by the LinphoneCore object.
479 * Its fields must not be used directly in favour of the accessors methods.
480 * Once created and filled properly the LinphoneProxyConfig can be given to
481 * LinphoneCore with linphone_core_add_proxy_config().
482 * This will automatically triggers the registration, if enabled.
484 * The proxy configuration are persistent to restarts because they are saved
485 * in the configuration file. As a consequence, after linphone_core_new() there
486 * might already be a list of configured proxy that can be examined with
487 * linphone_core_get_proxy_config_list().
489 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
490 * that is used by default for calls.
492 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
495 * LinphoneRegistrationState describes proxy registration states.
497 typedef enum _LinphoneRegistrationState{
498 LinphoneRegistrationNone, /**<Initial state for registrations */
499 LinphoneRegistrationProgress, /**<Registration is in progress */
500 LinphoneRegistrationOk, /**< Registration is successful */
501 LinphoneRegistrationCleared, /**< Unregistration succeeded */
502 LinphoneRegistrationFailed /**<Registration failed */
503 }LinphoneRegistrationState;
506 * Human readable version of the #LinphoneRegistrationState
509 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
511 LinphoneProxyConfig *linphone_proxy_config_new(void);
512 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
513 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
514 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
515 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
517 * Indicates either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
518 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
519 * @param obj object pointer
520 * @param val if true, registration will be engaged
522 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
523 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
524 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
525 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
527 * Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
528 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
529 * @param obj object pointer
530 * @param val if true, publish will be engaged
533 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
534 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
535 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
537 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
538 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
539 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
541 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
542 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
543 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
544 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
545 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
546 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
547 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
548 const char *linphone_proxy_config_get_contact_parameters(const LinphoneProxyConfig *obj);
549 void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, const char *contact_params);
550 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
552 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
553 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
555 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
557 /* destruction is called automatically when removing the proxy config */
558 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
559 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
560 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
561 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
563 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
565 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
567 * attached a user data to a proxy config
569 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
571 * get user data to a proxy config. return null if any
573 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
579 typedef struct _LinphoneAccountCreator{
580 struct _LinphoneCore *lc;
581 struct _SipSetupContext *ssctx;
589 }LinphoneAccountCreator;
591 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
592 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
593 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
594 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
595 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
596 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
597 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
598 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
599 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
600 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
601 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
602 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
603 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
605 struct _LinphoneAuthInfo;
608 * @ingroup authentication
609 * Object holding authentication information.
611 * @note The object's fields should not be accessed directly. Prefer using
612 * the accessor methods.
614 * In most case, authentication information consists of a username and password.
615 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
616 * different SIP domains.
618 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
619 * order to become known and used automatically when needed.
620 * Use linphone_core_add_auth_info() for that purpose.
622 * The LinphoneCore object can take the initiative to request authentication information
623 * when needed to the application through the auth_info_requested callback of the
624 * LinphoneCoreVTable structure.
626 * The application can respond to this information request later using
627 * linphone_core_add_auth_info(). This will unblock all pending authentication
628 * transactions and retry them with authentication headers.
631 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
633 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
634 const char *passwd, const char *ha1,const char *realm);
635 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
636 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
637 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
638 void linphone_auth_info_set_realm(LinphoneAuthInfo *info, const char *realm);
639 void linphone_auth_info_set_ha1(LinphoneAuthInfo *info, const char *ha1);
641 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
642 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
643 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
644 const char *linphone_auth_info_get_realm(const LinphoneAuthInfo *i);
645 const char *linphone_auth_info_get_ha1(const LinphoneAuthInfo *i);
647 /* you don't need those function*/
648 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
649 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
652 struct _LinphoneChatRoom;
654 * @addtogroup chatroom
659 * A chat room message to old content to be sent.
660 * <br> Can be created by linphone_chat_room_create_message().
662 typedef struct _LinphoneChatMessage LinphoneChatMessage;
665 * A chat room is the place where text messages are exchanged.
666 * <br> Can be created by linphone_core_create_chat_room().
668 typedef struct _LinphoneChatRoom LinphoneChatRoom;
671 *LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
673 typedef enum _LinphoneChatMessageStates {
674 LinphoneChatMessageStateIdle, /**<initial state*/
675 LinphoneChatMessageStateInProgress, /**<delivery in progress**/
676 LinphoneChatMessageStateDelivered, /**<message succesffully delivered an acknoleged by remote end point*/
677 LinphoneChatMessageStateNotDelivered /**<message was not delivered*/
678 }LinphoneChatMessageState;
681 * Call back used to notify message delivery status
682 *@param msg #LinphoneChatMessage object
683 *@param status LinphoneChatMessageState
684 *@param ud application user data
686 typedef void (*LinphoneChatMessageStateChangeCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
688 void linphone_core_set_chat_database_path(LinphoneCore *lc, const char *path);
689 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
690 LinphoneChatRoom *linphone_core_get_chat_room(LinphoneCore *lc, const LinphoneAddress *addr);
691 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
692 LinphoneChatMessage* linphone_chat_room_create_message(LinphoneChatRoom *cr,const char* message);
693 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
694 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
695 void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage* msg,LinphoneChatMessageStateChangeCb status_cb,void* ud);
696 MSList *linphone_chat_room_get_history(LinphoneChatRoom *cr,int nb_message);
697 void linphone_chat_room_mark_as_read(LinphoneChatRoom *cr);
698 void linphone_chat_room_delete_history(LinphoneChatRoom *cr);
699 int linphone_chat_room_get_unread_messages_count(LinphoneChatRoom *cr);
700 LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr);
701 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
702 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
704 LinphoneChatMessageState linphone_chat_message_get_state(const LinphoneChatMessage* message);
705 const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
706 LinphoneChatMessage* linphone_chat_message_clone(const LinphoneChatMessage* message);
707 void linphone_chat_message_destroy(LinphoneChatMessage* msg);
708 void linphone_chat_message_set_from(LinphoneChatMessage* message, const LinphoneAddress* from);
709 const LinphoneAddress* linphone_chat_message_get_from(const LinphoneChatMessage* message);
710 const LinphoneAddress* linphone_chat_message_get_to(const LinphoneChatMessage* message);
711 const char* linphone_chat_message_get_external_body_url(const LinphoneChatMessage* message);
712 void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
713 const char * linphone_chat_message_get_text(const LinphoneChatMessage* message);
714 time_t linphone_chat_message_get_time(const LinphoneChatMessage* message);
715 void* linphone_chat_message_get_user_data(const LinphoneChatMessage* message);
716 void linphone_chat_message_set_user_data(LinphoneChatMessage* message,void*);
717 LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
718 const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
719 LinphoneAddress *linphone_chat_message_get_local_address(const LinphoneChatMessage* message);
720 void linphone_chat_message_add_custom_header(LinphoneChatMessage* message, const char *header_name, const char *header_value);
721 const char * linphone_chat_message_get_custom_header(LinphoneChatMessage* message, const char *header_name);
729 * @addtogroup initializing
734 * LinphoneGlobalState describes the global state of the LinphoneCore object.
735 * It is notified via the LinphoneCoreVTable::global_state_changed
737 typedef enum _LinphoneGlobalState{
739 LinphoneGlobalStartup,
741 LinphoneGlobalShutdown
742 }LinphoneGlobalState;
744 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
747 /**Call state notification callback prototype*/
748 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
749 /**Call state notification callback prototype*/
750 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
751 /**Call encryption changed callback prototype*/
752 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
755 * Registration state notification callback prototype
757 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
758 /** Callback prototype */
759 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
760 /** Callback prototype */
761 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
762 /** Callback prototype */
763 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
764 /** Callback prototype */
765 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
766 /** Callback prototype */
767 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
768 /** Callback prototype */
769 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
771 * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
772 * @param lc #LinphoneCore object .
773 * @param lf Updated #LinphoneFriend .
775 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
777 * Reports that a new subscription request has been received and wait for a decision.
778 * <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
779 * @param lc #LinphoneCore object
780 * @param lf #LinphoneFriend corresponding to the subscriber
781 * @param url of the subscriber
784 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
785 /** Callback prototype */
786 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
787 /** Callback prototype */
788 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
791 * @deprecated use #MessageReceived instead.
793 * @param lc #LinphoneCore object
794 * @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.
795 * @param from #LinphoneAddress from
796 * @param message incoming message
798 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
800 * Chat message callback prototype
802 * @param lc #LinphoneCore object
803 * @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.
804 * @param LinphoneChatMessage incoming message
806 typedef void (*MessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
808 /** Callback prototype */
809 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
810 /** Callback prototype */
811 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
812 /** Callback prototype */
813 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
814 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
815 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
816 /** Callback prototype for receiving quality statistics for calls*/
817 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
820 * This structure holds all callbacks that the application should implement.
823 typedef struct _LinphoneVTable{
824 LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
825 LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
826 LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
827 NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
828 NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
829 AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
830 CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
831 TextMessageReceived text_received; /** @deprecated, use #message_received instead <br> A text message has been received */
832 MessageReceived message_received; /** a message is received, can be text or external body*/
833 DtmfReceived dtmf_received; /**< A dtmf has been received received */
834 ReferReceived refer_received; /**< An out of call refer was received */
835 CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
836 LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
837 BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
838 NotifyReceivedCb notify_recv; /**< Other notifications*/
839 CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
840 DisplayStatusCb display_status; /**< DEPRECATED Callback that notifies various events with human readable text.*/
841 DisplayMessageCb display_message;/**< DEPRECATED Callback to display a message to the user */
842 DisplayMessageCb display_warning;/**< DEPRECATED Callback to display a warning to the user */
843 DisplayUrlCb display_url; /**< DEPRECATED */
844 ShowInterfaceCb show; /**< DEPRECATED Notifies the application that it should show up*/
845 } LinphoneCoreVTable;
851 typedef struct _LCCallbackObj
853 LinphoneCoreCbFunc _func;
859 typedef enum _LinphoneFirewallPolicy{
860 LinphonePolicyNoFirewall,
861 LinphonePolicyUseNatAddress,
862 LinphonePolicyUseStun,
863 LinphonePolicyUseIce,
864 LinphonePolicyUseUpnp,
865 } LinphoneFirewallPolicy;
867 typedef enum _LinphoneWaitingState{
868 LinphoneWaitingStart,
869 LinphoneWaitingProgress,
870 LinphoneWaitingFinished
871 } LinphoneWaitingState;
872 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
878 * Define a log handler.
882 * @param logfunc The function pointer of the log handler.
884 void linphone_core_set_log_handler(OrtpLogFunc logfunc);
890 * If the file pointer passed as an argument is NULL, stdout is used instead.
892 * @param file A pointer to the FILE structure of the file to write to.
894 void linphone_core_set_log_file(FILE *file);
896 * Define the log level.
900 * The loglevel parameter is a bitmask parameter. Therefore to enable only warning and error
901 * messages, use ORTP_WARNING | ORTP_ERROR. To disable logs, simply set loglevel to 0.
903 * @param loglevel A bitmask of the log levels to set.
905 void linphone_core_set_log_level(OrtpLogLevel loglevel);
906 void linphone_core_enable_logs(FILE *file);
907 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
908 void linphone_core_disable_logs(void);
909 const char *linphone_core_get_version(void);
910 const char *linphone_core_get_user_agent_name(void);
911 const char *linphone_core_get_user_agent_version(void);
913 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
914 const char *config_path, const char *factory_config, void* userdata);
917 * Instantiates a LinphoneCore object with a given LpConfig.
918 * @ingroup initializing
920 * The LinphoneCore object is the primary handle for doing all phone actions.
921 * It should be unique within your application.
922 * @param vtable a LinphoneCoreVTable structure holding your application callbacks
923 * @param config a pointer to an LpConfig object holding the configuration of the LinphoneCore to be instantiated.
924 * @param userdata an opaque user pointer that can be retrieved at any time (for example in
925 * callbacks) using linphone_core_get_user_data().
926 * @see linphone_core_new
928 LinphoneCore *linphone_core_new_with_config(const LinphoneCoreVTable *vtable, struct _LpConfig *config, void *userdata);
930 /* function to be periodically called in a main loop */
931 /* For ICE to work properly it should be called every 20ms */
932 void linphone_core_iterate(LinphoneCore *lc);
933 #if 0 /*not implemented yet*/
935 * @ingroup initializing
936 * Provide Linphone Core with an unique identifier. This be later used to identified contact address coming from this device.
937 * Value is not saved.
939 * @param string identifying the device, can be EMEI or UDID
942 void linphone_core_set_device_identifier(LinphoneCore *lc,const char* device_id);
944 * @ingroup initializing
945 * get Linphone unique identifier
948 const char* linphone_core_get_device_identifier(const LinphoneCore *lc);
952 /*sets the user-agent string in sip messages, ideally called just after linphone_core_new() or linphone_core_init() */
953 void linphone_core_set_user_agent(LinphoneCore *lc, const char *ua_name, const char *version);
955 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
957 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
959 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
961 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
963 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
965 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
967 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
969 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
971 bool_t linphone_core_in_call(const LinphoneCore *lc);
973 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
975 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
977 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
979 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
981 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
983 int linphone_core_decline_call(LinphoneCore *lc, LinphoneCall * call, LinphoneReason reason);
985 int linphone_core_terminate_all_calls(LinphoneCore *lc);
987 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
989 int linphone_core_pause_all_calls(LinphoneCore *lc);
991 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
993 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
995 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
997 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
999 * @ingroup media_parameters
1000 * Get default call parameters reflecting current linphone core configuration
1001 * @param LinphoneCore object
1002 * @return LinphoneCallParams
1004 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
1006 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
1008 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
1010 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
1012 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
1014 const char * linphone_core_get_identity(LinphoneCore *lc);
1016 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
1017 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
1019 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
1020 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
1022 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
1023 const char * linphone_core_get_identity(LinphoneCore *lc);
1024 /*0= no bandwidth limit*/
1025 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
1026 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
1028 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
1029 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
1031 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
1032 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
1034 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
1035 int linphone_core_get_download_ptime(LinphoneCore *lc);
1037 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
1039 int linphone_core_get_upload_ptime(LinphoneCore *lc);
1041 /* returns a MSList of PayloadType */
1042 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
1044 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
1045 /* returns a MSList of PayloadType */
1046 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
1048 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
1050 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
1052 * Enable payload type
1053 * @param linphone core
1054 * @param pt payload type to enable, can be retrieve from #linphone_core_find_payload_type
1055 * @param TRUE if enabled
1056 * @return 0 if succed
1059 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
1062 * Wildcard value used by #linphone_core_find_payload_type to ignore rate in search algorithm
1063 * @ingroup media_parameters
1065 #define LINPHONE_FIND_PAYLOAD_IGNORE_RATE -1
1067 * Wildcard value used by #linphone_core_find_payload_type to ignore channel in search algorithm
1068 * @ingroup media_parameters
1070 #define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS -1
1072 * Get payload type from mime type and clock rate
1073 * @ingroup media_parameters
1074 * This function searches in audio and video codecs for the given payload type name and clockrate.
1075 * @param lc #LinphoneCore object
1076 * @param type payload mime type (I.E SPEEX, PCMU, VP8)
1077 * @param rate can be #LINPHONE_FIND_PAYLOAD_IGNORE_RATE
1078 * @param channels number of channels, can be #LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
1079 * @return Returns NULL if not found.
1081 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate, int channels) ;
1083 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
1085 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
1087 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
1091 *Create a proxy config with default value from Linphone core.
1092 *@param lc #LinphoneCore object
1093 *@return #LinphoneProxyConfig with defualt value set
1095 LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *lc);
1097 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1099 void linphone_core_clear_proxy_config(LinphoneCore *lc);
1101 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1103 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
1105 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
1107 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
1109 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
1111 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1113 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1115 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
1117 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
1119 void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info);
1121 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
1123 void linphone_core_enable_audio_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1125 bool_t linphone_core_audio_adaptive_jittcomp_enabled(LinphoneCore *lc);
1127 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
1129 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
1131 void linphone_core_enable_video_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1133 bool_t linphone_core_video_adaptive_jittcomp_enabled(LinphoneCore *lc);
1135 int linphone_core_get_video_jittcomp(LinphoneCore *lc);
1137 void linphone_core_set_video_jittcomp(LinphoneCore *lc, int value);
1139 int linphone_core_get_audio_port(const LinphoneCore *lc);
1141 void linphone_core_get_audio_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1143 int linphone_core_get_video_port(const LinphoneCore *lc);
1145 void linphone_core_get_video_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1147 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
1149 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
1151 void linphone_core_set_audio_port_range(LinphoneCore *lc, int min_port, int max_port);
1153 void linphone_core_set_video_port(LinphoneCore *lc, int port);
1155 void linphone_core_set_video_port_range(LinphoneCore *lc, int min_port, int max_port);
1157 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
1159 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
1161 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
1163 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
1165 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
1167 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
1169 int linphone_core_get_sip_port(LinphoneCore *lc);
1171 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
1173 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
1176 * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
1177 * @param lc #LinphoneCore
1178 * @return socket file descriptor
1180 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
1182 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
1184 int linphone_core_get_inc_timeout(LinphoneCore *lc);
1186 void linphone_core_set_in_call_timeout(LinphoneCore *lc, int seconds);
1188 int linphone_core_get_in_call_timeout(LinphoneCore *lc);
1190 void linphone_core_set_delayed_timeout(LinphoneCore *lc, int seconds);
1192 int linphone_core_get_delayed_timeout(LinphoneCore *lc);
1194 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
1196 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
1199 * @ingroup network_parameters
1200 * Return the availability of uPnP.
1202 * @return true if uPnP is available otherwise return false.
1204 bool_t linphone_core_upnp_available();
1207 * @ingroup network_parameters
1208 * Return the internal state of uPnP.
1210 * @param lc #LinphoneCore
1211 * @return an LinphoneUpnpState.
1213 LinphoneUpnpState linphone_core_get_upnp_state(const LinphoneCore *lc);
1216 * @ingroup network_parameters
1217 * Return the external ip address of router.
1218 * In some cases the uPnP can have an external ip address but not a usable uPnP
1219 * (state different of Ok).
1221 * @param lc #LinphoneCore
1222 * @return a null terminated string containing the external ip address. If the
1223 * the external ip address is not available return null.
1225 const char * linphone_core_get_upnp_external_ipaddress(const LinphoneCore *lc);
1227 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
1229 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
1231 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
1233 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
1235 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
1237 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
1239 /* sound functions */
1240 /* returns a null terminated static array of string describing the sound devices */
1241 const char** linphone_core_get_sound_devices(LinphoneCore *lc);
1242 void linphone_core_reload_sound_devices(LinphoneCore *lc);
1243 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
1244 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
1245 int linphone_core_get_ring_level(LinphoneCore *lc);
1246 int linphone_core_get_play_level(LinphoneCore *lc);
1247 int linphone_core_get_rec_level(LinphoneCore *lc);
1248 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
1249 void linphone_core_set_play_level(LinphoneCore *lc, int level);
1251 void linphone_core_set_mic_gain_db(LinphoneCore *lc, float level);
1252 float linphone_core_get_mic_gain_db(LinphoneCore *lc);
1253 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
1254 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
1256 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
1257 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
1258 const char * linphone_core_get_playback_device(LinphoneCore *lc);
1259 const char * linphone_core_get_capture_device(LinphoneCore *lc);
1260 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
1261 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
1262 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
1263 char linphone_core_get_sound_source(LinphoneCore *lc);
1264 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
1265 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
1266 const char *linphone_core_get_ring(const LinphoneCore *lc);
1267 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1268 void linphone_core_verify_server_cn(LinphoneCore *lc, bool_t yesno);
1269 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1270 const char *linphone_core_get_root_ca(LinphoneCore *lc);
1271 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1272 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1274 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1275 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1277 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1278 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1279 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1281 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1282 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1284 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1285 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1287 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1291 * @ingroup media_parameters
1293 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1295 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1297 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1298 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1301 /* returns a list of LinphoneCallLog */
1302 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1303 void linphone_core_clear_call_logs(LinphoneCore *lc);
1304 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1305 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1306 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1309 bool_t linphone_core_video_supported(LinphoneCore *lc);
1310 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1311 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1312 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1313 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1315 typedef struct MSVideoSizeDef{
1319 /* returns a zero terminated table of MSVideoSizeDef*/
1320 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1321 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1322 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1323 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1325 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1326 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1328 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1329 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1332 /* returns a null terminated static array of string describing the webcams */
1333 void linphone_core_reload_video_devices(LinphoneCore *lc);
1334 const char** linphone_core_get_video_devices(const LinphoneCore *lc);
1335 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1336 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1338 /* Set and get static picture to be used when "Static picture" is the video device */
1339 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1340 const char *linphone_core_get_static_picture(LinphoneCore *lc);
1342 /* Set and get frame rate for static picture */
1343 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1344 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1346 /*function to be used for eventually setting window decorations (icons, title...)*/
1347 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1348 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1350 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1351 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1353 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1354 int linphone_core_get_device_rotation(LinphoneCore *lc );
1355 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1358 * @brief Get the camera sensor rotation.
1360 * This is needed on some mobile platforms to get the number of degrees the camera sensor
1361 * is rotated relative to the screen.
1363 * @param lc The linphone core related to the operation
1364 * @return The camera sensor rotation in degrees (0 to 360) or -1 if it could not be retrieved
1366 int linphone_core_get_camera_sensor_rotation(LinphoneCore *lc);
1368 /* start or stop streaming video in case of embedded window */
1369 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1371 /*play/record support: use files instead of soundcard*/
1372 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1373 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1374 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1376 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1377 void linphone_core_stop_dtmf(LinphoneCore *lc);
1379 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1382 int linphone_core_get_mtu(const LinphoneCore *lc);
1383 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1386 * @ingroup network_parameters
1387 * This method is called by the application to notify the linphone core library when network is reachable.
1388 * Calling this method with true trigger linphone to initiate a registration process for all proxies.
1389 * Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
1391 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1393 * @ingroup network_parameters
1394 * return network state either as positioned by the application or by linphone itself.
1396 bool_t linphone_core_is_network_reachable(LinphoneCore* lc);
1399 * @ingroup network_parameters
1400 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1402 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1404 * @ingroup network_parameters
1405 * Is signaling keep alive
1407 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1409 void *linphone_core_get_user_data(LinphoneCore *lc);
1410 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1412 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1413 the config file with your own sections */
1414 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1416 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1417 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1419 /*returns the list of registered SipSetup (linphonecore plugins) */
1420 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1422 void linphone_core_destroy(LinphoneCore *lc);
1424 /*for advanced users:*/
1425 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1426 struct _LinphoneRtpTransportFactories{
1427 LinphoneRtpTransportFactoryFunc audio_rtp_func;
1428 void *audio_rtp_func_data;
1429 LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1430 void *audio_rtcp_func_data;
1431 LinphoneRtpTransportFactoryFunc video_rtp_func;
1432 void *video_rtp_func_data;
1433 LinphoneRtpTransportFactoryFunc video_rtcp_func;
1434 void *video_rtcp_func_data;
1436 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1438 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1440 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1442 int linphone_core_get_calls_nb(const LinphoneCore *lc);
1444 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1446 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1448 * force registration refresh to be initiated upon next iterate
1451 void linphone_core_refresh_registers(LinphoneCore* lc);
1453 /* Path to the file storing secrets cache */
1454 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1455 const char *linphone_core_get_zrtp_secrets_file(LinphoneCore *lc);
1457 * Search from the list of current calls if a remote address match uri
1458 * @ingroup call_control
1460 * @param uri which should match call remote uri
1461 * @return LinphoneCall or NULL is no match is found
1463 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1465 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1466 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1467 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1468 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1469 int linphone_core_enter_conference(LinphoneCore *lc);
1470 int linphone_core_leave_conference(LinphoneCore *lc);
1471 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1473 int linphone_core_terminate_conference(LinphoneCore *lc);
1474 int linphone_core_get_conference_size(LinphoneCore *lc);
1475 int linphone_core_start_conference_recording(LinphoneCore *lc, const char *path);
1476 int linphone_core_stop_conference_recording(LinphoneCore *lc);
1478 * Get the maximum number of simultaneous calls Linphone core can manage at a time. All new call above this limit are declined with a busy answer
1479 * @ingroup initializing
1481 * @return max number of simultaneous calls
1483 int linphone_core_get_max_calls(LinphoneCore *lc);
1485 * Set the maximum number of simultaneous calls Linphone core can manage at a time. All new call above this limit are declined with a busy answer
1486 * @ingroup initializing
1488 * @param max number of simultaneous calls
1490 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1492 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1494 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1497 * Choose media encryption policy to be used for RTP packets
1499 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1500 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1502 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1504 * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1505 * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1507 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1510 * Init call params using LinphoneCore's current configuration
1512 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1515 * True if tunnel support was compiled.
1517 bool_t linphone_core_tunnel_available(void);
1519 typedef struct _LinphoneTunnel LinphoneTunnel;
1521 * get tunnel instance if available
1523 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1525 void linphone_core_set_sip_dscp(LinphoneCore *lc, int dscp);
1526 int linphone_core_get_sip_dscp(const LinphoneCore *lc);
1528 void linphone_core_set_audio_dscp(LinphoneCore *lc, int dscp);
1529 int linphone_core_get_audio_dscp(const LinphoneCore *lc);
1531 void linphone_core_set_video_dscp(LinphoneCore *lc, int dscp);
1532 int linphone_core_get_video_dscp(const LinphoneCore *lc);