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
48 * Object that represents a SIP address.
50 * The LinphoneAddress is an opaque object to represents SIP addresses, ie
51 * the content of SIP's 'from' and 'to' headers.
52 * A SIP address is made of display name, username, domain name, port, and various
53 * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
54 * The LinphoneAddress has methods to extract and manipulate all parts of the address.
55 * When some part of the address (for example the username) is empty, the accessor methods
58 * @ingroup linphone_address
59 * @var LinphoneAddress
61 typedef struct SalAddress LinphoneAddress;
63 LinphoneAddress * linphone_address_new(const char *uri);
64 LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
65 const char *linphone_address_get_scheme(const LinphoneAddress *u);
66 const char *linphone_address_get_display_name(const LinphoneAddress* u);
67 const char *linphone_address_get_username(const LinphoneAddress *u);
68 const char *linphone_address_get_domain(const LinphoneAddress *u);
69 void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
70 void linphone_address_set_username(LinphoneAddress *uri, const char *username);
71 void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
72 void linphone_address_set_port(LinphoneAddress *uri, const char *port);
73 void linphone_address_set_port_int(LinphoneAddress *uri, int port);
74 /*remove tags, params etc... so that it is displayable to the user*/
75 void linphone_address_clean(LinphoneAddress *uri);
76 char *linphone_address_as_string(const LinphoneAddress *u);
77 char *linphone_address_as_string_uri_only(const LinphoneAddress *u);
78 void linphone_address_destroy(LinphoneAddress *u);
80 struct _SipSetupContext;
83 * The LinphoneCall object represents a call issued or received by the LinphoneCore
86 typedef struct _LinphoneCall LinphoneCall;
88 bool_t linphone_call_asked_to_autoanswer(struct _LinphoneCall *call);
91 * Enum representing the direction of a call.
94 enum _LinphoneCallDir {
95 LinphoneCallOutgoing, /**< outgoing calls*/
96 LinphoneCallIncoming /**< incoming calls*/
103 typedef enum _LinphoneCallDir LinphoneCallDir;
106 * Enum representing the status of a call
109 typedef enum _LinphoneCallStatus {
110 LinphoneCallSuccess, /**< The call was sucessful*/
111 LinphoneCallAborted, /**< The call was aborted */
112 LinphoneCallMissed /**< The call was missed (unanswered)*/
113 } LinphoneCallStatus;
116 * Structure representing a call log.
121 typedef struct _LinphoneCallLog{
122 LinphoneCallDir dir; /**< The direction of the call*/
123 LinphoneCallStatus status; /**< The status of the call*/
124 LinphoneAddress *from; /**<Originator of the call as a LinphoneAddress object*/
125 LinphoneAddress *to; /**<Destination of the call as a LinphoneAddress object*/
126 char start_date[128]; /**<Human readable string containg the start date*/
127 int duration; /**<Duration of the call in seconds*/
130 rtp_stats_t local_stats;
131 rtp_stats_t remote_stats;
132 struct _LinphoneCore *lc;
138 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
139 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
140 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
141 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
142 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
143 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
144 char * linphone_call_log_to_str(LinphoneCallLog *cl);
150 }LinphoneSubscribePolicy;
152 typedef enum _LinphoneOnlineStatus{
153 LINPHONE_STATUS_OFFLINE,
154 LINPHONE_STATUS_ONLINE,
155 LINPHONE_STATUS_BUSY,
156 LINPHONE_STATUS_BERIGHTBACK,
157 LINPHONE_STATUS_AWAY,
158 LINPHONE_STATUS_ONTHEPHONE,
159 LINPHONE_STATUS_OUTTOLUNCH,
160 LINPHONE_STATUS_NOT_DISTURB,
161 LINPHONE_STATUS_MOVED,
162 LINPHONE_STATUS_ALT_SERVICE,
163 LINPHONE_STATUS_PENDING,
165 }LinphoneOnlineStatus;
167 const char *linphone_online_status_to_string(LinphoneOnlineStatus ss);
169 struct _LinphoneFriend;
171 typedef struct _LinphoneFriend LinphoneFriend;
173 LinphoneFriend * linphone_friend_new();
174 LinphoneFriend *linphone_friend_new_with_addr(const char *addr);
175 int linphone_friend_set_sip_addr(LinphoneFriend *fr, const char *uri);
176 int linphone_friend_set_name(LinphoneFriend *fr, const char *name);
177 int linphone_friend_send_subscribe(LinphoneFriend *fr, bool_t val);
178 int linphone_friend_set_inc_subscribe_policy(LinphoneFriend *fr, LinphoneSubscribePolicy pol);
179 void linphone_friend_edit(LinphoneFriend *fr);
180 void linphone_friend_done(LinphoneFriend *fr);
181 void linphone_friend_destroy(LinphoneFriend *lf);
182 const LinphoneAddress *linphone_friend_get_address(const LinphoneFriend *lf);
183 bool_t linphone_friend_get_send_subscribe(const LinphoneFriend *lf);
184 LinphoneSubscribePolicy linphone_friend_get_inc_subscribe_policy(const LinphoneFriend *lf);
185 LinphoneOnlineStatus linphone_friend_get_status(const LinphoneFriend *lf);
186 BuddyInfo * linphone_friend_get_info(const LinphoneFriend *lf);
187 void linphone_friend_set_ref_key(LinphoneFriend *lf, const char *key);
188 const char *linphone_friend_get_ref_key(const LinphoneFriend *lf);
189 bool_t linphone_friend_in_list(const LinphoneFriend *lf);
191 #define linphone_friend_url(lf) ((lf)->url)
195 * @addtogroup proxies
199 * The LinphoneProxyConfig object represents a proxy configuration to be used
200 * by the LinphoneCore object.
201 * Its fields must not be used directly in favour of the accessors methods.
202 * Once created and filled properly the LinphoneProxyConfig can be given to
203 * LinphoneCore with linphone_core_add_proxy_config().
204 * This will automatically triggers the registration, if enabled.
206 * The proxy configuration are persistent to restarts because they are saved
207 * in the configuration file. As a consequence, after linphone_core_new() there
208 * might already be a list of configured proxy that can be examined with
209 * linphone_core_get_proxy_config_list().
211 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
212 * that is used by default for calls.
214 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
216 LinphoneProxyConfig *linphone_proxy_config_new(void);
217 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
218 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
219 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
220 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
221 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
222 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
223 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
224 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
225 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
226 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
227 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
229 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
230 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
232 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
233 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
234 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
235 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
236 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
237 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
238 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
240 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
241 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
243 /* destruction is called automatically when removing the proxy config */
244 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
245 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
246 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
247 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
249 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
251 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
253 * attached a user data to a proxy config
255 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
257 * get user data to a proxy config. return null if any
259 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
265 typedef struct _LinphoneAccountCreator{
266 struct _LinphoneCore *lc;
267 struct _SipSetupContext *ssctx;
272 }LinphoneAccountCreator;
274 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
275 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
276 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
277 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
278 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
279 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
280 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
281 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
282 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
284 struct _LinphoneAuthInfo;
287 * @ingroup authentication
288 * Object holding authentication information.
290 * @note The object's fields should not be accessed directly. Prefer using
291 * the accessor methods.
293 * In most case, authentication information consists of a username and password.
294 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
295 * different SIP domains.
297 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
298 * order to become known and used automatically when needed.
299 * Use linphone_core_add_auth_info() for that purpose.
301 * The LinphoneCore object can take the initiative to request authentication information
302 * when needed to the application through the auth_info_requested callback of the
303 * LinphoneCoreVTable structure.
305 * The application can respond to this information request later using
306 * linphone_core_add_auth_info(). This will unblock all pending authentication
307 * transactions and retry them with authentication headers.
310 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
312 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
313 const char *passwd, const char *ha1,const char *realm);
314 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
315 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
316 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
318 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
319 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
320 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
322 /* you don't need those function*/
323 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
324 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
326 struct _LinphoneChatRoom;
327 typedef struct _LinphoneChatRoom LinphoneChatRoom;
329 LinphoneChatRoom * linphone_core_create_chat_room(struct _LinphoneCore *lc, const char *to);
330 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
331 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
332 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
333 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
335 /* describes the different groups of states */
336 typedef enum _gstate_group {
342 typedef enum _gstate {
343 /* states for GSTATE_GROUP_POWER */
344 GSTATE_POWER_OFF = 0, /* initial state */
345 GSTATE_POWER_STARTUP,
347 GSTATE_POWER_SHUTDOWN,
348 /* states for GSTATE_GROUP_REG */
349 GSTATE_REG_NONE = 10, /* initial state */
352 GSTATE_REG_PENDING, /* a registration request is ongoing*/
353 /* states for GSTATE_GROUP_CALL */
354 GSTATE_CALL_IDLE = 20, /* initial state */
355 GSTATE_CALL_OUT_INVITE,
356 GSTATE_CALL_OUT_CONNECTED,
357 GSTATE_CALL_IN_INVITE,
358 GSTATE_CALL_IN_CONNECTED,
362 GSTATE_CALL_OUT_RINGING /*remote ringing*/
365 struct _LinphoneGeneralState {
368 gstate_group_t group;
371 typedef struct _LinphoneGeneralState LinphoneGeneralState;
373 /* private: set a new state */
374 void gstate_new_state(struct _LinphoneCore *lc, gstate_t new_state, const char *message);
376 void gstate_initialize(struct _LinphoneCore *lc) ;
379 * @addtogroup initializing
383 /** Callback prototype */
384 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
385 /** Callback prototype */
386 typedef void (*InviteReceivedCb)(struct _LinphoneCore *lc, const char *from);
387 /** Callback prototype */
388 typedef void (*ByeReceivedCb)(struct _LinphoneCore *lc, const char *from);
389 /** Callback prototype */
390 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
391 /** Callback prototype */
392 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
393 /** Callback prototype */
394 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
395 /** Callback prototype */
396 typedef void (*DisplayQuestionCb)(struct _LinphoneCore *lc, const char *message);
397 /** Callback prototype */
398 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
399 /** Callback prototype */
400 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, const char *from, const char *msg);
401 /** Callback prototype */
402 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * fid);
403 /** Callback prototype */
404 typedef void (*NewUnknownSubscriberCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
405 /** Callback prototype */
406 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
407 /** Callback prototype */
408 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
409 /** Callback prototype */
410 typedef void (*TextMessageReceived)(struct _LinphoneCore *lc, LinphoneChatRoom *room, const char *from, const char *message);
411 /** Callback prototype */
412 typedef void (*GeneralStateChange)(struct _LinphoneCore *lc, LinphoneGeneralState *gstate);
413 /** Callback prototype */
414 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, int dtmf);
415 /** Callback prototype */
416 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
417 /** Callback prototype */
418 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
421 * This structure holds all callbacks that the application should implement.
424 typedef struct _LinphoneVTable
426 ShowInterfaceCb show; /**< Notifies the application that it should show up*/
427 InviteReceivedCb inv_recv; /**< Notifies incoming calls */
428 ByeReceivedCb bye_recv; /**< Notify calls terminated by far end*/
429 NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
430 NewUnknownSubscriberCb new_unknown_subscriber; /**< Notify about unknown subscriber */
431 AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
432 DisplayStatusCb display_status; /**< Callback that notifies various events with human readable text.*/
433 DisplayMessageCb display_message;/**< Callback to display a message to the user */
434 DisplayMessageCb display_warning;/** Callback to display a warning to the user */
435 DisplayUrlCb display_url;
436 DisplayQuestionCb display_question;
437 CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
438 TextMessageReceived text_received; /**< A text message has been received */
439 GeneralStateChange general_state; /**< State notification callback */
440 DtmfReceived dtmf_received; /**< A dtmf has been received received */
441 ReferReceived refer_received; /**< A refer was received */
442 BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
443 NotifyReceivedCb notify_recv; /**< Other notifications*/
444 } LinphoneCoreVTable;
450 typedef struct _LCCallbackObj
452 LinphoneCoreCbFunc _func;
458 typedef enum _LinphoneFirewallPolicy{
459 LINPHONE_POLICY_NO_FIREWALL,
460 LINPHONE_POLICY_USE_NAT_ADDRESS,
461 LINPHONE_POLICY_USE_STUN
462 } LinphoneFirewallPolicy;
464 typedef enum _LinphoneWaitingState{
465 LinphoneWaitingStart,
466 LinphoneWaitingProgress,
467 LinphoneWaitingFinished
468 } LinphoneWaitingState;
469 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
471 typedef struct _LinphoneCore LinphoneCore;
475 void linphone_core_enable_logs(FILE *file);
476 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
477 void linphone_core_disable_logs(void);
478 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
479 void linphone_core_set_user_agent(const char *ua_name, const char *version);
480 const char *linphone_core_get_version(void);
482 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
483 const char *config_path, const char *factory_config, void* userdata);
485 /* function to be periodically called in a main loop */
486 void linphone_core_iterate(LinphoneCore *lc);
488 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
490 int linphone_core_invite(LinphoneCore *lc, const char *url);
492 int linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
494 int linphone_core_refer(LinphoneCore *lc, const char *url);
496 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
498 bool_t linphone_core_in_call(const LinphoneCore *lc);
500 LinphoneCall *linphone_core_get_current_call(LinphoneCore *lc);
502 int linphone_core_accept_call(LinphoneCore *lc, const char *url);
504 int linphone_core_terminate_call(LinphoneCore *lc, const char *url);
506 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
508 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
510 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
512 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
513 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
515 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
516 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
518 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
520 /*0= no bandwidth limit*/
521 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
522 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
524 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
525 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
527 * set audio packetization time linphone expect to received from peer
528 * @ingroup media_parameters
531 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
533 * get audio packetization time linphone expect to received from peer, 0 means unspecified
534 * @ingroup media_parameters
536 int linphone_core_get_download_ptime(LinphoneCore *lc);
538 #ifdef VINCENT_MAURY_RSVP
540 int linphone_core_set_rpc_mode(LinphoneCore *lc, int on); /* on = 1 (RPC_ENABLE = 1) */
541 int linphone_core_set_rsvp_mode(LinphoneCore *lc, int on); /* on = 1 (RSVP_ENABLE = 1) */
542 int linphone_core_change_qos(LinphoneCore *lc, int answer); /* answer = 1 for yes, 0 for no */
545 /* returns a MSList of PayloadType */
546 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
548 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
549 /* returns a MSList of PayloadType */
550 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
552 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
554 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, PayloadType *pt);
556 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
558 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
560 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
562 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
564 void linphone_core_clear_proxy_config(LinphoneCore *lc);
566 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
568 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
570 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
572 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
574 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
576 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
578 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
580 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
582 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
584 void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info);
586 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
588 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
590 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
592 int linphone_core_get_audio_port(const LinphoneCore *lc);
594 int linphone_core_get_video_port(const LinphoneCore *lc);
596 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
598 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
600 void linphone_core_set_video_port(LinphoneCore *lc, int port);
602 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
604 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
606 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
608 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
610 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
612 int linphone_core_get_sip_port(LinphoneCore *lc);
614 void linphone_core_set_sip_port(LinphoneCore *lc,int port);
616 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
618 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
620 int linphone_core_get_inc_timeout(LinphoneCore *lc);
622 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
624 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
626 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
628 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
630 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
632 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
634 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
636 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
638 /* sound functions */
639 /* returns a null terminated static array of string describing the sound devices */
640 const char** linphone_core_get_sound_devices(LinphoneCore *lc);
641 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
642 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
643 int linphone_core_get_ring_level(LinphoneCore *lc);
644 int linphone_core_get_play_level(LinphoneCore *lc);
645 int linphone_core_get_rec_level(LinphoneCore *lc);
646 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
647 void linphone_core_set_play_level(LinphoneCore *lc, int level);
649 * Allow to control play level before entering sound card: level in db
651 * @ingroup media_parameters
653 void linphone_core_set_soft_play_level(LinphoneCore *lc, float level);
655 * get play level before entering sound card: level in db
657 * @ingroup media_parameters
659 float linphone_core_get_soft_play_level(LinphoneCore *lc);
660 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
661 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
662 const char * linphone_core_get_playback_device(LinphoneCore *lc);
663 const char * linphone_core_get_capture_device(LinphoneCore *lc);
664 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
665 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
666 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
667 char linphone_core_get_sound_source(LinphoneCore *lc);
668 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
669 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
670 const char *linphone_core_get_ring(const LinphoneCore *lc);
671 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
672 const char * linphone_core_get_ringback(const LinphoneCore *lc);
673 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
674 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
675 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
677 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
678 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
680 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
681 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
683 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
687 * @ingroup media_parameters
689 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
691 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
692 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
694 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
695 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
697 void linphone_core_set_presence_info(LinphoneCore *lc,int minutes_away,const char *contact,LinphoneOnlineStatus os);
699 LinphoneOnlineStatus linphone_core_get_presence_info(const LinphoneCore *lc);
701 void linphone_core_interpret_friend_uri(LinphoneCore *lc, const char *uri, char **result);
702 void linphone_core_add_friend(LinphoneCore *lc, LinphoneFriend *fr);
703 void linphone_core_remove_friend(LinphoneCore *lc, LinphoneFriend *fr);
704 void linphone_core_reject_subscriber(LinphoneCore *lc, LinphoneFriend *lf);
705 /* a list of LinphoneFriend */
706 const MSList * linphone_core_get_friend_list(const LinphoneCore *lc);
707 /* notify all friends that have subscribed */
708 void linphone_core_notify_all_friends(LinphoneCore *lc, LinphoneOnlineStatus os);
709 LinphoneFriend *linphone_core_get_friend_by_address(const LinphoneCore *lc, const char *addr);
710 LinphoneFriend *linphone_core_get_friend_by_ref_key(const LinphoneCore *lc, const char *key);
712 /* returns a list of LinphoneCallLog */
713 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
714 void linphone_core_clear_call_logs(LinphoneCore *lc);
717 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
718 bool_t linphone_core_video_enabled(LinphoneCore *lc);
720 typedef struct MSVideoSizeDef{
724 /* returns a zero terminated table of MSVideoSizeDef*/
725 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
726 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
727 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
728 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
730 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
731 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
733 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
734 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
737 /* returns a null terminated static array of string describing the webcams */
738 const char** linphone_core_get_video_devices(const LinphoneCore *lc);
739 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
740 const char *linphone_core_get_video_device(const LinphoneCore *lc);
742 /* Set static picture to be used when "Static picture" is the video device */
743 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
745 /*function to be used for eventually setting window decorations (icons, title...)*/
746 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
749 /*play/record support: use files instead of soundcard*/
750 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
751 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
752 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
754 gstate_t linphone_core_get_state(const LinphoneCore *lc, gstate_group_t group);
755 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
756 const LinphoneAddress *linphone_core_get_remote_uri(LinphoneCore *lc);
758 int linphone_core_get_mtu(const LinphoneCore *lc);
759 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
762 * This method is called by the application to notify the linphone core library when network is reachable.
763 * Calling this method with true trigger linphone to initiate a registration process for all proxy
764 * configuration with parameter register set to enable.
765 * This method disable the automatic registration mode. It means you must call this method after each network state changes
768 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
770 * return network state either as positioned by the application or by linphone
772 bool_t linphone_core_is_network_reachabled(LinphoneCore* lc);
775 void *linphone_core_get_user_data(LinphoneCore *lc);
777 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
778 the config file with your own sections */
779 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
781 /* attempts to wake up another linphone engine already running.
782 The "show" callback is called for the other linphone, causing gui to show up.
783 call_addr is an optional sip-uri to call immediately after waking up.
784 The method returns 0 if an already running linphone was found*/
786 int linphone_core_wake_up_possible_already_running_instance(
787 const char * config_file, const char * call_addr);
789 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
790 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
792 /*returns the list of registered SipSetup (linphonecore plugins) */
793 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
795 void linphone_core_destroy(LinphoneCore *lc);
797 /*for advanced users:*/
798 void linphone_core_set_audio_transports(LinphoneCore *lc, RtpTransport *rtp, RtpTransport *rtcp);
800 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);