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;
50 struct _LCSipTransports{
57 typedef struct _LCSipTransports LCSipTransports;
60 * Object that represents a SIP address.
62 * The LinphoneAddress is an opaque object to represents SIP addresses, ie
63 * the content of SIP's 'from' and 'to' headers.
64 * A SIP address is made of display name, username, domain name, port, and various
65 * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
66 * The LinphoneAddress has methods to extract and manipulate all parts of the address.
67 * When some part of the address (for example the username) is empty, the accessor methods
70 * @ingroup linphone_address
71 * @var LinphoneAddress
73 typedef struct SalAddress LinphoneAddress;
75 #include "linphonefriend.h"
77 #include "linphone/linphonefriend.h"
80 LinphoneAddress * linphone_address_new(const char *uri);
81 LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
82 const char *linphone_address_get_scheme(const LinphoneAddress *u);
83 const char *linphone_address_get_display_name(const LinphoneAddress* u);
84 const char *linphone_address_get_username(const LinphoneAddress *u);
85 const char *linphone_address_get_domain(const LinphoneAddress *u);
87 * Get port number as an integer value.
90 int linphone_address_get_port_int(const LinphoneAddress *u);
92 * Get port number, null if not present.
94 const char* linphone_address_get_port(const LinphoneAddress *u);
95 void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
96 void linphone_address_set_username(LinphoneAddress *uri, const char *username);
97 void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
98 void linphone_address_set_port(LinphoneAddress *uri, const char *port);
99 void linphone_address_set_port_int(LinphoneAddress *uri, int port);
100 /*remove tags, params etc... so that it is displayable to the user*/
101 void linphone_address_clean(LinphoneAddress *uri);
102 char *linphone_address_as_string(const LinphoneAddress *u);
103 char *linphone_address_as_string_uri_only(const LinphoneAddress *u);
104 bool_t linphone_address_weak_equal(const LinphoneAddress *a1, const LinphoneAddress *a2);
105 void linphone_address_destroy(LinphoneAddress *u);
107 struct _SipSetupContext;
111 * Enum representing the direction of a call.
114 enum _LinphoneCallDir {
115 LinphoneCallOutgoing, /**< outgoing calls*/
116 LinphoneCallIncoming /**< incoming calls*/
123 typedef enum _LinphoneCallDir LinphoneCallDir;
126 * Enum representing the status of a call
129 typedef enum _LinphoneCallStatus {
130 LinphoneCallSuccess, /**< The call was sucessful*/
131 LinphoneCallAborted, /**< The call was aborted */
132 LinphoneCallMissed, /**< The call was missed (unanswered)*/
133 LinphoneCallDeclined /**< The call was declined, either locally or by remote end*/
134 } LinphoneCallStatus;
137 * Structure representing a call log.
142 typedef struct _LinphoneCallLog LinphoneCallLog;
145 * Enum describing type of media encryption types.
147 enum LinphoneMediaEncryption {
148 LinphoneMediaEncryptionNone,
149 LinphoneMediaEncryptionSRTP,
150 LinphoneMediaEncryptionZRTP
154 * Enum describing type of media encryption types.
156 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
159 LinphoneAddress *linphone_call_log_get_from(LinphoneCallLog *cl);
160 LinphoneAddress *linphone_call_log_get_to(LinphoneCallLog *cl);
161 LinphoneAddress *linphone_call_log_get_remote_address(LinphoneCallLog *cl);
162 LinphoneCallDir linphone_call_log_get_dir(LinphoneCallLog *cl);
163 LinphoneCallStatus linphone_call_log_get_status(LinphoneCallLog *cl);
164 LinphoneCallStatus linphone_call_log_video_enabled(LinphoneCallLog *cl);
165 time_t linphone_call_log_get_start_date(LinphoneCallLog *cl);
166 int linphone_call_log_get_duration(LinphoneCallLog *cl);
167 float linphone_call_log_get_quality(LinphoneCallLog *cl);
168 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
169 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
170 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
171 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
172 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
173 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
174 const char *linphone_call_log_get_call_id(const LinphoneCallLog *cl);
175 char * linphone_call_log_to_str(LinphoneCallLog *cl);
177 struct _LinphoneCallParams;
180 * The LinphoneCallParams is an object containing various call related parameters.
181 * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
184 typedef struct _LinphoneCallParams LinphoneCallParams;
186 const PayloadType* linphone_call_params_get_used_audio_codec(const LinphoneCallParams *cp);
187 const PayloadType* linphone_call_params_get_used_video_codec(const LinphoneCallParams *cp);
188 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
189 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
190 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
191 LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
192 void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
193 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
194 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
195 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
196 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
197 void linphone_call_params_destroy(LinphoneCallParams *cp);
198 bool_t linphone_call_params_low_bandwidth_enabled(const LinphoneCallParams *cp);
199 void linphone_call_params_enable_low_bandwidth(LinphoneCallParams *cp, bool_t enabled);
200 void linphone_call_params_set_record_file(LinphoneCallParams *cp, const char *path);
201 const char *linphone_call_params_get_record_file(const LinphoneCallParams *cp);
202 void linphone_call_params_add_custom_header(LinphoneCallParams *params, const char *header_name, const char *header_value);
203 const char *linphone_call_params_get_custom_header(const LinphoneCallParams *params, const char *header_name);
205 * Enum describing failure reasons.
206 * @ingroup initializing
208 enum _LinphoneReason{
210 LinphoneReasonNoResponse, /**<No response received from remote*/
211 LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
212 LinphoneReasonDeclined, /**<The call has been declined*/
213 LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
214 LinphoneReasonNotAnswered, /**<The call was not answered in time*/
215 LinphoneReasonBusy /**<Phone line was busy */
219 * Enum describing failure reasons.
220 * @ingroup initializing
222 typedef enum _LinphoneReason LinphoneReason;
224 const char *linphone_reason_to_string(LinphoneReason err);
227 * Structure describing policy regarding video streams establishments.
228 * @ingroup media_parameters
230 struct _LinphoneVideoPolicy{
231 bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/
232 bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
237 * Structure describing policy regarding video streams establishments.
238 * @ingroup media_parameters
240 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
243 * The LinphoneCall object represents a call issued or received by the LinphoneCore
244 * @ingroup call_control
246 struct _LinphoneCall;
248 * The LinphoneCall object represents a call issued or received by the LinphoneCore
249 * @ingroup call_control
251 typedef struct _LinphoneCall LinphoneCall;
255 * @addtogroup call_misc
259 #define LINPHONE_CALL_STATS_AUDIO 0
260 #define LINPHONE_CALL_STATS_VIDEO 1
263 * Enum describing ICE states.
264 * @ingroup initializing
266 enum _LinphoneIceState{
267 LinphoneIceStateNotActivated, /**< ICE has not been activated for this call */
268 LinphoneIceStateFailed, /**< ICE processing has failed */
269 LinphoneIceStateInProgress, /**< ICE process is in progress */
270 LinphoneIceStateHostConnection, /**< ICE has established a direct connection to the remote host */
271 LinphoneIceStateReflexiveConnection, /**< ICE has established a connection to the remote host through one or several NATs */
272 LinphoneIceStateRelayConnection /**< ICE has established a connection through a relay */
276 * Enum describing Ice states.
277 * @ingroup initializing
279 typedef enum _LinphoneIceState LinphoneIceState;
282 * Enum describing uPnP states.
283 * @ingroup initializing
285 enum _LinphoneUpnpState{
286 LinphoneUpnpStateIdle, /**< uPnP is not activate */
287 LinphoneUpnpStatePending, /**< uPnP process is in progress */
288 LinphoneUpnpStateAdding, /**< Internal use: Only used by port binding */
289 LinphoneUpnpStateRemoving, /**< Internal use: Only used by port binding */
290 LinphoneUpnpStateNotAvailable, /**< uPnP is not available */
291 LinphoneUpnpStateOk, /**< uPnP is enabled */
292 LinphoneUpnpStateKo, /**< uPnP processing has failed */
296 * Enum describing uPnP states.
297 * @ingroup initializing
299 typedef enum _LinphoneUpnpState LinphoneUpnpState;
303 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
305 * 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
306 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
308 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
310 typedef struct _LinphoneCallStats LinphoneCallStats;
313 * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
315 * 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
316 * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
318 * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
320 struct _LinphoneCallStats {
321 int type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
322 jitter_stats_t jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
323 mblk_t* received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
324 mblk_t* sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
325 float round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
326 LinphoneIceState ice_state; /**< State of ICE processing. */
327 LinphoneUpnpState upnp_state; /**< State of uPnP processing. */
328 float download_bandwidth; /**<Download bandwidth measurement of received stream, expressed in kbit/s, including IP/UDP/RTP headers*/
329 float upload_bandwidth; /**<Download bandwidth measurement of sent stream, expressed in kbit/s, including IP/UDP/RTP headers*/
336 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
337 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
340 /** Callback prototype */
341 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
344 * LinphoneCallState enum represents the different state a call can reach into.
345 * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
346 * @ingroup call_control
348 typedef enum _LinphoneCallState{
349 LinphoneCallIdle, /**<Initial call state */
350 LinphoneCallIncomingReceived, /**<This is a new incoming call */
351 LinphoneCallOutgoingInit, /**<An outgoing call is started */
352 LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
353 LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
354 LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
355 LinphoneCallConnected, /**<Connected, the call is answered */
356 LinphoneCallStreamsRunning, /**<The media streams are established and running*/
357 LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
358 LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
359 LinphoneCallResuming, /**<The call is being resumed by local end*/
360 LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
361 LinphoneCallError, /**<The call encountered an error*/
362 LinphoneCallEnd, /**<The call ended normally*/
363 LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
364 LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
365 LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
366 LinphoneCallUpdating, /**<A call update has been initiated by us */
367 LinphoneCallReleased /**< The call object is no more retained by the core */
370 const char *linphone_call_state_to_string(LinphoneCallState cs);
372 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
373 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
374 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
375 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
376 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
377 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
378 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
379 LinphoneCall * linphone_call_ref(LinphoneCall *call);
380 void linphone_call_unref(LinphoneCall *call);
381 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
382 const char *linphone_call_get_refer_to(const LinphoneCall *call);
383 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
384 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
385 int linphone_call_get_duration(const LinphoneCall *call);
386 const LinphoneCallParams * linphone_call_get_current_params(LinphoneCall *call);
387 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
388 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
389 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
390 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
391 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
392 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
393 const char *linphone_call_get_remote_contact(LinphoneCall *call);
394 float linphone_call_get_play_volume(LinphoneCall *call);
395 float linphone_call_get_record_volume(LinphoneCall *call);
396 float linphone_call_get_current_quality(LinphoneCall *call);
397 float linphone_call_get_average_quality(LinphoneCall *call);
398 const char* linphone_call_get_authentication_token(LinphoneCall *call);
399 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
400 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
401 void linphone_call_send_vfu_request(LinphoneCall *call);
402 void *linphone_call_get_user_pointer(LinphoneCall *call);
403 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
404 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
405 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
406 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);
407 void linphone_call_start_recording(LinphoneCall *call);
408 void linphone_call_stop_recording(LinphoneCall *call);
410 * Return TRUE if this call is currently part of a conference
411 *@param call #LinphoneCall
412 *@return TRUE if part of a conference.
414 @ingroup call_control
416 bool_t linphone_call_is_in_conference(const LinphoneCall *call);
418 * Enables or disable echo cancellation for this call
422 * @ingroup media_parameters
424 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
426 * Returns TRUE if echo cancellation is enabled.
428 * @ingroup media_parameters
430 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
432 * Enables or disable echo limiter for this call
436 * @ingroup media_parameters
438 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
440 * Returns TRUE if echo limiter is enabled.
442 * @ingroup media_parameters
444 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
446 /*keep this in sync with mediastreamer2/msvolume.h*/
449 * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
452 #define LINPHONE_VOLUME_DB_LOWEST (-120)
455 * @addtogroup proxies
459 * The LinphoneProxyConfig object represents a proxy configuration to be used
460 * by the LinphoneCore object.
461 * Its fields must not be used directly in favour of the accessors methods.
462 * Once created and filled properly the LinphoneProxyConfig can be given to
463 * LinphoneCore with linphone_core_add_proxy_config().
464 * This will automatically triggers the registration, if enabled.
466 * The proxy configuration are persistent to restarts because they are saved
467 * in the configuration file. As a consequence, after linphone_core_new() there
468 * might already be a list of configured proxy that can be examined with
469 * linphone_core_get_proxy_config_list().
471 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
472 * that is used by default for calls.
474 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
477 * LinphoneRegistrationState describes proxy registration states.
479 typedef enum _LinphoneRegistrationState{
480 LinphoneRegistrationNone, /**<Initial state for registrations */
481 LinphoneRegistrationProgress, /**<Registration is in progress */
482 LinphoneRegistrationOk, /**< Registration is successful */
483 LinphoneRegistrationCleared, /**< Unregistration succeeded */
484 LinphoneRegistrationFailed /**<Registration failed */
485 }LinphoneRegistrationState;
488 * Human readable version of the #LinphoneRegistrationState
491 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
493 LinphoneProxyConfig *linphone_proxy_config_new(void);
494 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
495 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
496 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
497 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
499 * Indicates either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
500 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
501 * @param obj object pointer
502 * @param val if true, registration will be engaged
504 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
505 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
506 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
507 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
509 * Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
510 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
511 * @param obj object pointer
512 * @param val if true, publish will be engaged
515 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
516 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
517 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
519 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
520 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
521 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
523 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
524 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
525 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
526 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
527 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
528 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
529 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
530 const char *linphone_proxy_config_get_contact_parameters(const LinphoneProxyConfig *obj);
531 void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, const char *contact_params);
532 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
534 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
535 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
537 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
539 /* destruction is called automatically when removing the proxy config */
540 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
541 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
542 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
543 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
545 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
547 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
549 * attached a user data to a proxy config
551 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
553 * get user data to a proxy config. return null if any
555 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
561 typedef struct _LinphoneAccountCreator{
562 struct _LinphoneCore *lc;
563 struct _SipSetupContext *ssctx;
571 }LinphoneAccountCreator;
573 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
574 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
575 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
576 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
577 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
578 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
579 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
580 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
581 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
582 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
583 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
584 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
585 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
587 struct _LinphoneAuthInfo;
590 * @ingroup authentication
591 * Object holding authentication information.
593 * @note The object's fields should not be accessed directly. Prefer using
594 * the accessor methods.
596 * In most case, authentication information consists of a username and password.
597 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
598 * different SIP domains.
600 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
601 * order to become known and used automatically when needed.
602 * Use linphone_core_add_auth_info() for that purpose.
604 * The LinphoneCore object can take the initiative to request authentication information
605 * when needed to the application through the auth_info_requested callback of the
606 * LinphoneCoreVTable structure.
608 * The application can respond to this information request later using
609 * linphone_core_add_auth_info(). This will unblock all pending authentication
610 * transactions and retry them with authentication headers.
613 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
615 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
616 const char *passwd, const char *ha1,const char *realm);
617 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
618 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
619 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
621 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
622 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
623 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
625 /* you don't need those function*/
626 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
627 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
630 struct _LinphoneChatRoom;
632 * @addtogroup chatroom
637 * A chat room message to old content to be sent.
638 * <br> Can be created by linphone_chat_room_create_message().
640 typedef struct _LinphoneChatMessage LinphoneChatMessage;
643 * A chat room is the place where text messages are exchanged.
644 * <br> Can be created by linphone_core_create_chat_room().
646 typedef struct _LinphoneChatRoom LinphoneChatRoom;
649 *LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
651 typedef enum _LinphoneChatMessageStates {
652 LinphoneChatMessageStateIdle, /**<initial state*/
653 LinphoneChatMessageStateInProgress, /**<delivery in progress**/
654 LinphoneChatMessageStateDelivered, /**<message succesffully delivered an acknoleged by remote end point*/
655 LinphoneChatMessageStateNotDelivered /**<message was not delivered*/
656 }LinphoneChatMessageState;
659 * Call back used to notify message delivery status
660 *@param msg #LinphoneChatMessage object
661 *@param status LinphoneChatMessageState
662 *@param ud application user data
664 typedef void (*LinphoneChatMessageStateChangeCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
666 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
667 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
668 LinphoneChatMessage* linphone_chat_room_create_message(LinphoneChatRoom *cr,const char* message);
669 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
670 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
671 void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage* msg,LinphoneChatMessageStateChangeCb status_cb,void* ud);
672 LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr);
673 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
674 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
676 LinphoneChatMessageState linphone_chat_message_get_state(const LinphoneChatMessage* message);
677 const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
678 LinphoneChatMessage* linphone_chat_message_clone(const LinphoneChatMessage* message);
679 void linphone_chat_message_set_from(LinphoneChatMessage* message, const LinphoneAddress* from);
680 LinphoneAddress* linphone_chat_message_get_from(const LinphoneChatMessage* message);
681 const char* linphone_chat_message_get_external_body_url(const LinphoneChatMessage* message);
682 void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
683 const char * linphone_chat_message_get_text(const LinphoneChatMessage* message);
684 time_t linphone_chat_message_get_time(const LinphoneChatMessage* message);
685 void* linphone_chat_message_get_user_data(const LinphoneChatMessage* message);
686 void linphone_chat_message_set_user_data(LinphoneChatMessage* message,void*);
687 LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
688 const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
689 void linphone_chat_message_add_custom_header(LinphoneChatMessage* message, const char *header_name, const char *header_value);
690 const char * linphone_chat_message_get_custom_header(LinphoneChatMessage* message, const char *header_name);
698 * @addtogroup initializing
703 * LinphoneGlobalState describes the global state of the LinphoneCore object.
704 * It is notified via the LinphoneCoreVTable::global_state_changed
706 typedef enum _LinphoneGlobalState{
708 LinphoneGlobalStartup,
710 LinphoneGlobalShutdown
711 }LinphoneGlobalState;
713 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
716 /**Call state notification callback prototype*/
717 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
718 /**Call state notification callback prototype*/
719 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
720 /**Call encryption changed callback prototype*/
721 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
724 * Registration state notification callback prototype
726 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
727 /** Callback prototype */
728 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
729 /** Callback prototype */
730 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
731 /** Callback prototype */
732 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
733 /** Callback prototype */
734 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
735 /** Callback prototype */
736 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
737 /** Callback prototype */
738 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
740 * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
741 * @param lc #LinphoneCore object .
742 * @param lf Updated #LinphoneFriend .
744 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
746 * Reports that a new subscription request has been received and wait for a decision.
747 * <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
748 * @param lc #LinphoneCore object
749 * @param lf #LinphoneFriend corresponding to the subscriber
750 * @param url of the subscriber
753 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
754 /** Callback prototype */
755 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
756 /** Callback prototype */
757 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
760 * @deprecated use #MessageReceived instead.
762 * @param lc #LinphoneCore object
763 * @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.
764 * @param from #LinphoneAddress from
765 * @param message incoming message
767 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
769 * Chat message callback prototype
771 * @param lc #LinphoneCore object
772 * @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.
773 * @param LinphoneChatMessage incoming message
775 typedef void (*MessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
777 /** Callback prototype */
778 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
779 /** Callback prototype */
780 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
781 /** Callback prototype */
782 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
783 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
784 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
785 /** Callback prototype for receiving quality statistics for calls*/
786 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
789 * This structure holds all callbacks that the application should implement.
792 typedef struct _LinphoneVTable{
793 LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
794 LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
795 LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
796 NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
797 NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
798 AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
799 CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
800 TextMessageReceived text_received; /** @deprecated, use #message_received instead <br> A text message has been received */
801 MessageReceived message_received; /** a message is received, can be text or external body*/
802 DtmfReceived dtmf_received; /**< A dtmf has been received received */
803 ReferReceived refer_received; /**< An out of call refer was received */
804 CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
805 LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
806 BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
807 NotifyReceivedCb notify_recv; /**< Other notifications*/
808 CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
809 DisplayStatusCb display_status; /**< DEPRECATED Callback that notifies various events with human readable text.*/
810 DisplayMessageCb display_message;/**< DEPRECATED Callback to display a message to the user */
811 DisplayMessageCb display_warning;/**< DEPRECATED Callback to display a warning to the user */
812 DisplayUrlCb display_url; /**< DEPRECATED */
813 ShowInterfaceCb show; /**< DEPRECATED Notifies the application that it should show up*/
814 } LinphoneCoreVTable;
820 typedef struct _LCCallbackObj
822 LinphoneCoreCbFunc _func;
828 typedef enum _LinphoneFirewallPolicy{
829 LinphonePolicyNoFirewall,
830 LinphonePolicyUseNatAddress,
831 LinphonePolicyUseStun,
832 LinphonePolicyUseIce,
833 LinphonePolicyUseUpnp,
834 } LinphoneFirewallPolicy;
836 typedef enum _LinphoneWaitingState{
837 LinphoneWaitingStart,
838 LinphoneWaitingProgress,
839 LinphoneWaitingFinished
840 } LinphoneWaitingState;
841 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
846 void linphone_core_enable_logs(FILE *file);
847 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
848 void linphone_core_disable_logs(void);
849 const char *linphone_core_get_version(void);
850 const char *linphone_core_get_user_agent_name(void);
851 const char *linphone_core_get_user_agent_version(void);
853 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
854 const char *config_path, const char *factory_config, void* userdata);
856 /* function to be periodically called in a main loop */
857 /* For ICE to work properly it should be called every 20ms */
858 void linphone_core_iterate(LinphoneCore *lc);
859 #if 0 /*not implemented yet*/
861 * @ingroup initializing
862 * Provide Linphone Core with an unique identifier. This be later used to identified contact address coming from this device.
863 * Value is not saved.
865 * @param string identifying the device, can be EMEI or UDID
868 void linphone_core_set_device_identifier(LinphoneCore *lc,const char* device_id);
870 * @ingroup initializing
871 * get Linphone unique identifier
874 const char* linphone_core_get_device_identifier(const LinphoneCore *lc);
878 /*sets the user-agent string in sip messages, ideally called just after linphone_core_new() or linphone_core_init() */
879 void linphone_core_set_user_agent(LinphoneCore *lc, const char *ua_name, const char *version);
881 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
883 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
885 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
887 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
889 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
891 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
893 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
895 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
897 bool_t linphone_core_in_call(const LinphoneCore *lc);
899 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
901 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
903 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
905 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
907 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
909 int linphone_core_decline_call(LinphoneCore *lc, LinphoneCall * call, LinphoneReason reason);
911 int linphone_core_terminate_all_calls(LinphoneCore *lc);
913 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
915 int linphone_core_pause_all_calls(LinphoneCore *lc);
917 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
919 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
921 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
923 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
925 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
927 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
929 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
931 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
933 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
935 const char * linphone_core_get_identity(LinphoneCore *lc);
937 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
938 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
940 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
941 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
943 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
944 const char * linphone_core_get_identity(LinphoneCore *lc);
945 /*0= no bandwidth limit*/
946 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
947 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
949 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
950 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
952 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
953 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
955 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
956 int linphone_core_get_download_ptime(LinphoneCore *lc);
958 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
960 int linphone_core_get_upload_ptime(LinphoneCore *lc);
962 /* returns a MSList of PayloadType */
963 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
965 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
966 /* returns a MSList of PayloadType */
967 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
969 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
971 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
973 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
976 * Wildcard value used by #linphone_core_find_payload_type to ignore rate in search algirithm
977 * @ingroup media_parameters
979 #define LINPHONE_FIND_PAYLOAD_IGNORE_RATE -1
981 * Wildcard value used by #linphone_core_find_payload_type to ignore channel in search algirithm
982 * @ingroup media_parameters
984 #define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS -1
986 * Get payload type from mime type and clock rate
987 * @ingroup media_parameters
988 * This function searches in audio and video codecs for the given payload type name and clockrate.
989 * @param lc #LinphoneCore object
990 * @param type payload mime type (I.E SPEEX, PCMU, VP8)
991 * @param rate can be #LINPHONE_FIND_PAYLOAD_IGNORE_RATE
992 * @param channels number of channels, can be #LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
993 * @return Returns NULL if not found.
995 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate, int channels) ;
997 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
999 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
1001 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
1005 *Create a proxy config with default value from Linphone core.
1006 *@param lc #LinphoneCore object
1007 *@return #LinphoneProxyConfig with defualt value set
1009 LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *lc);
1011 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1013 void linphone_core_clear_proxy_config(LinphoneCore *lc);
1015 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1017 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
1019 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
1021 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
1023 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
1025 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1027 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1029 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
1031 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
1033 void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info);
1035 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
1037 void linphone_core_enable_audio_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1039 bool_t linphone_core_audio_adaptive_jittcomp_enabled(LinphoneCore *lc);
1041 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
1043 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
1045 void linphone_core_enable_video_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1047 bool_t linphone_core_video_adaptive_jittcomp_enabled(LinphoneCore *lc);
1049 int linphone_core_get_video_jittcomp(LinphoneCore *lc);
1051 void linphone_core_set_video_jittcomp(LinphoneCore *lc, int value);
1053 int linphone_core_get_audio_port(const LinphoneCore *lc);
1055 void linphone_core_get_audio_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1057 int linphone_core_get_video_port(const LinphoneCore *lc);
1059 void linphone_core_get_video_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1061 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
1063 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
1065 void linphone_core_set_audio_port_range(LinphoneCore *lc, int min_port, int max_port);
1067 void linphone_core_set_video_port(LinphoneCore *lc, int port);
1069 void linphone_core_set_video_port_range(LinphoneCore *lc, int min_port, int max_port);
1071 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
1073 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
1075 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
1077 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
1079 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
1081 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
1083 int linphone_core_get_sip_port(LinphoneCore *lc);
1085 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
1087 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
1090 * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
1091 * @param lc #LinphoneCore
1092 * @return socket file descriptor
1094 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
1096 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
1098 int linphone_core_get_inc_timeout(LinphoneCore *lc);
1100 void linphone_core_set_in_call_timeout(LinphoneCore *lc, int seconds);
1102 int linphone_core_get_in_call_timeout(LinphoneCore *lc);
1104 void linphone_core_set_delayed_timeout(LinphoneCore *lc, int seconds);
1106 int linphone_core_get_delayed_timeout(LinphoneCore *lc);
1108 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
1110 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
1113 * @ingroup network_parameters
1114 * Return the availability of uPnP.
1116 * @param lc #LinphoneCore
1117 * @return true if uPnP is available otherwise return false.
1119 bool_t linphone_core_upnp_available(const LinphoneCore *lc);
1122 * @ingroup network_parameters
1123 * Return the internal state of uPnP.
1125 * @param lc #LinphoneCore
1126 * @return an LinphoneUpnpState.
1128 LinphoneUpnpState linphone_core_get_upnp_state(const LinphoneCore *lc);
1131 * @ingroup network_parameters
1132 * Return the external ip address of router.
1133 * In some cases the uPnP can have an external ip address but not a usable uPnP
1134 * (state different of Ok).
1136 * @param lc #LinphoneCore
1137 * @return a null terminated string containing the external ip address. If the
1138 * the external ip address is not available return null.
1140 const char * linphone_core_get_upnp_external_ipaddress(const LinphoneCore *lc);
1142 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
1144 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
1146 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
1148 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
1150 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
1152 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
1154 /* sound functions */
1155 /* returns a null terminated static array of string describing the sound devices */
1156 const char** linphone_core_get_sound_devices(LinphoneCore *lc);
1157 void linphone_core_reload_sound_devices(LinphoneCore *lc);
1158 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
1159 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
1160 int linphone_core_get_ring_level(LinphoneCore *lc);
1161 int linphone_core_get_play_level(LinphoneCore *lc);
1162 int linphone_core_get_rec_level(LinphoneCore *lc);
1163 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
1164 void linphone_core_set_play_level(LinphoneCore *lc, int level);
1166 void linphone_core_set_mic_gain_db(LinphoneCore *lc, float level);
1167 float linphone_core_get_mic_gain_db(LinphoneCore *lc);
1168 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
1169 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
1171 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
1172 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
1173 const char * linphone_core_get_playback_device(LinphoneCore *lc);
1174 const char * linphone_core_get_capture_device(LinphoneCore *lc);
1175 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
1176 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
1177 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
1178 char linphone_core_get_sound_source(LinphoneCore *lc);
1179 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
1180 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
1181 const char *linphone_core_get_ring(const LinphoneCore *lc);
1182 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1183 void linphone_core_verify_server_cn(LinphoneCore *lc, bool_t yesno);
1184 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1185 const char *linphone_core_get_root_ca(LinphoneCore *lc);
1186 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1187 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1189 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1190 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1192 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1193 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1194 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1196 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1197 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1199 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1200 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1202 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1206 * @ingroup media_parameters
1208 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1210 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1212 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1213 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1216 /* returns a list of LinphoneCallLog */
1217 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1218 void linphone_core_clear_call_logs(LinphoneCore *lc);
1219 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1220 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1221 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1224 bool_t linphone_core_video_supported(LinphoneCore *lc);
1225 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1226 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1227 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1228 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1230 typedef struct MSVideoSizeDef{
1234 /* returns a zero terminated table of MSVideoSizeDef*/
1235 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1236 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1237 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1238 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1240 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1241 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1243 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1244 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1247 /* returns a null terminated static array of string describing the webcams */
1248 void linphone_core_reload_video_devices(LinphoneCore *lc);
1249 const char** linphone_core_get_video_devices(const LinphoneCore *lc);
1250 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1251 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1253 /* Set and get static picture to be used when "Static picture" is the video device */
1254 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1255 const char *linphone_core_get_static_picture(LinphoneCore *lc);
1257 /* Set and get frame rate for static picture */
1258 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1259 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1261 /*function to be used for eventually setting window decorations (icons, title...)*/
1262 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1263 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1265 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1266 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1268 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1269 int linphone_core_get_device_rotation(LinphoneCore *lc );
1270 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1272 /* start or stop streaming video in case of embedded window */
1273 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1275 /*play/record support: use files instead of soundcard*/
1276 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1277 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1278 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1280 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1281 void linphone_core_stop_dtmf(LinphoneCore *lc);
1283 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1286 int linphone_core_get_mtu(const LinphoneCore *lc);
1287 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1290 * @ingroup network_parameters
1291 * This method is called by the application to notify the linphone core library when network is reachable.
1292 * Calling this method with true trigger linphone to initiate a registration process for all proxies.
1293 * Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
1295 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1297 * @ingroup network_parameters
1298 * return network state either as positioned by the application or by linphone itself.
1300 bool_t linphone_core_is_network_reachable(LinphoneCore* lc);
1303 * @ingroup network_parameters
1304 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1306 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1308 * @ingroup network_parameters
1309 * Is signaling keep alive
1311 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1313 void *linphone_core_get_user_data(LinphoneCore *lc);
1314 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1316 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1317 the config file with your own sections */
1318 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1320 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1321 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1323 /*returns the list of registered SipSetup (linphonecore plugins) */
1324 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1326 void linphone_core_destroy(LinphoneCore *lc);
1328 /*for advanced users:*/
1329 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1330 struct _LinphoneRtpTransportFactories{
1331 LinphoneRtpTransportFactoryFunc audio_rtp_func;
1332 void *audio_rtp_func_data;
1333 LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1334 void *audio_rtcp_func_data;
1335 LinphoneRtpTransportFactoryFunc video_rtp_func;
1336 void *video_rtp_func_data;
1337 LinphoneRtpTransportFactoryFunc video_rtcp_func;
1338 void *video_rtcp_func_data;
1340 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1342 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1344 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1346 int linphone_core_get_calls_nb(const LinphoneCore *lc);
1348 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1350 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1352 * force registration refresh to be initiated upon next iterate
1355 void linphone_core_refresh_registers(LinphoneCore* lc);
1357 /* Path to the file storing secrets cache */
1358 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1359 const char *linphone_core_get_zrtp_secrets_file(LinphoneCore *lc);
1361 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1363 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1364 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1365 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1366 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1367 int linphone_core_enter_conference(LinphoneCore *lc);
1368 int linphone_core_leave_conference(LinphoneCore *lc);
1369 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1371 int linphone_core_terminate_conference(LinphoneCore *lc);
1372 int linphone_core_get_conference_size(LinphoneCore *lc);
1373 int linphone_core_start_conference_recording(LinphoneCore *lc, const char *path);
1374 int linphone_core_stop_conference_recording(LinphoneCore *lc);
1376 int linphone_core_get_max_calls(LinphoneCore *lc);
1377 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1379 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1381 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1384 * Choose media encryption policy to be used for RTP packets
1386 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1387 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1389 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1391 * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1392 * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1394 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1397 * Init call params using LinphoneCore's current configuration
1399 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1402 * True if tunnel support was compiled.
1404 bool_t linphone_core_tunnel_available(void);
1406 typedef struct _LinphoneTunnel LinphoneTunnel;
1408 * get tunnel instance if available
1410 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1412 void linphone_core_set_sip_dscp(LinphoneCore *lc, int dscp);
1413 int linphone_core_get_sip_dscp(const LinphoneCore *lc);
1415 void linphone_core_set_audio_dscp(LinphoneCore *lc, int dscp);
1416 int linphone_core_get_audio_dscp(const LinphoneCore *lc);
1418 void linphone_core_set_video_dscp(LinphoneCore *lc, int dscp);
1419 int linphone_core_get_video_dscp(const LinphoneCore *lc);
1421 MSList *linphone_chat_room_get_history(const char *to,LinphoneChatRoom *cr,int nb_message);
1422 void linphone_core_set_messages_flag_read(LinphoneChatRoom *cr,const char *from, int read);
1423 void linphone_core_delete_history(LinphoneCore *lc,const char *from);