sjero.net Git - linphone/blob - coreapi/linphonecore.h

   1 /*
   2 linphone
   3 Copyright (C) 2000 - 2010 Simon MORLAT (simon.morlat@linphone.org)
   4
   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.
   9
  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.
  14
  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.
  18 */
  19 #ifndef LINPHONECORE_H
  20 #define LINPHONECORE_H
  21
  22 #include "ortp/ortp.h"
  23 #include "ortp/payloadtype.h"
  24 #include "mediastreamer2/mscommon.h"
  25 #include "mediastreamer2/msvideo.h"
  26
  27 #ifdef IN_LINPHONE
  28 #include "sipsetup.h"
  29 #else
  30 #include "linphone/sipsetup.h"
  31 #endif
  32
  33 #define LINPHONE_IPADDR_SIZE 64
  34 #define LINPHONE_HOSTNAME_SIZE 128
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 struct _MSSndCard;
  41 struct _LinphoneCore;
  42 /**
  43  * Linphone core main object created by function linphone_core_new() .
  44  * @ingroup initializing
  45  */
  46 typedef struct _LinphoneCore LinphoneCore;
  47 struct SalOp;
  48
  49 struct _LpConfig;
  50
  51
  52 struct _LCSipTransports{
  53         int udp_port;
  54         int tcp_port;
  55         int dtls_port;
  56         int tls_port;
  57 };
  58
  59 typedef struct _LCSipTransports LCSipTransports;
  60
  61 /**
  62  * Object that represents a SIP address.
  63  *
  64  * The LinphoneAddress is an opaque object to represents SIP addresses, ie
  65  * the content of SIP's 'from' and 'to' headers.
  66  * A SIP address is made of display name, username, domain name, port, and various
  67  * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
  68  * The LinphoneAddress has methods to extract and manipulate all parts of the address.
  69  * When some part of the address (for example the username) is empty, the accessor methods
  70  * return NULL.
  71  *
  72  * @ingroup linphone_address
  73  * @var LinphoneAddress
  74  */
  75 typedef struct SalAddress LinphoneAddress;
  76 #ifdef IN_LINPHONE
  77 #include "linphonefriend.h"
  78 #else
  79 #include "linphone/linphonefriend.h"
  80 #endif
  81
  82 LinphoneAddress * linphone_address_new(const char *uri);
  83 LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
  84 const char *linphone_address_get_scheme(const LinphoneAddress *u);
  85 const char *linphone_address_get_display_name(const LinphoneAddress* u);
  86 const char *linphone_address_get_username(const LinphoneAddress *u);
  87 const char *linphone_address_get_domain(const LinphoneAddress *u);
  88 /**
  89  * Get port number as an integer value.
  90  *
  91  */
  92 int linphone_address_get_port_int(const LinphoneAddress *u);
  93 /**
  94  * Get port number, null if not present.
  95  */
  96 const char* linphone_address_get_port(const LinphoneAddress *u);
  97 void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
  98 void linphone_address_set_username(LinphoneAddress *uri, const char *username);
  99 void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
 100 void linphone_address_set_port(LinphoneAddress *uri, const char *port);
 101 void linphone_address_set_port_int(LinphoneAddress *uri, int port);
 102 /*remove tags, params etc... so that it is displayable to the user*/
 103 void linphone_address_clean(LinphoneAddress *uri);
 104 char *linphone_address_as_string(const LinphoneAddress *u);
 105 char *linphone_address_as_string_uri_only(const LinphoneAddress *u);
 106 bool_t linphone_address_weak_equal(const LinphoneAddress *a1, const LinphoneAddress *a2);
 107 void linphone_address_destroy(LinphoneAddress *u);
 108
 109 struct _SipSetupContext;
 110
 111
 112 /**
 113  * Enum representing the direction of a call.
 114  * @ingroup call_logs
 115 **/
 116 enum _LinphoneCallDir {
 117         LinphoneCallOutgoing, /**< outgoing calls*/
 118         LinphoneCallIncoming  /**< incoming calls*/
 119 };
 120
 121 /**
 122  * Typedef for enum
 123  * @ingroup call_logs
 124 **/
 125 typedef enum _LinphoneCallDir LinphoneCallDir;
 126
 127 /**
 128  * Enum representing the status of a call
 129  * @ingroup call_logs
 130 **/
 131 typedef enum _LinphoneCallStatus {
 132         LinphoneCallSuccess, /**< The call was sucessful*/
 133         LinphoneCallAborted, /**< The call was aborted */
 134         LinphoneCallMissed, /**< The call was missed (unanswered)*/
 135         LinphoneCallDeclined /**< The call was declined, either locally or by remote end*/
 136 } LinphoneCallStatus;
 137
 138 /**
 139  * Structure representing a call log.
 140  *
 141  * @ingroup call_logs
 142  *
 143 **/
 144 typedef struct _LinphoneCallLog{
 145         LinphoneCallDir dir; /**< The direction of the call*/
 146         LinphoneCallStatus status; /**< The status of the call*/
 147         LinphoneAddress *from; /**<Originator of the call as a LinphoneAddress object*/
 148         LinphoneAddress *to; /**<Destination of the call as a LinphoneAddress object*/
 149         char start_date[128]; /**<Human readable string containg the start date*/
 150         int duration; /**<Duration of the call in seconds*/
 151         char *refkey;
 152         void *user_pointer;
 153         rtp_stats_t local_stats;
 154         rtp_stats_t remote_stats;
 155         float quality;
 156         struct _LinphoneCore *lc;
 157 } LinphoneCallLog;
 158
 159
 160
 161 /*public: */
 162 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
 163 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
 164 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
 165 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
 166 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
 167 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
 168 char * linphone_call_log_to_str(LinphoneCallLog *cl);
 169
 170
 171 /**
 172  * The LinphoneCallParams is an object containing various call related parameters.
 173  * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
 174  * dynamically.
 175 **/
 176 struct _LinphoneCallParams;
 177 typedef struct _LinphoneCallParams LinphoneCallParams;
 178
 179 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
 180 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
 181 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
 182 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
 183 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
 184 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
 185 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
 186 void linphone_call_params_destroy(LinphoneCallParams *cp);
 187
 188 /**
 189  * Enum describing failure reasons.
 190  * @ingroup initializing
 191 **/
 192 enum _LinphoneReason{
 193         LinphoneReasonNone,
 194         LinphoneReasonNoResponse, /**<No response received from remote*/
 195         LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
 196         LinphoneReasonDeclined, /**<The call has been declined*/
 197 };
 198
 199 typedef enum _LinphoneReason LinphoneReason;
 200
 201 const char *linphone_reason_to_string(LinphoneReason err);
 202
 203 /**
 204  * The LinphoneCall object represents a call issued or received by the LinphoneCore
 205 **/
 206 struct _LinphoneCall;
 207 typedef struct _LinphoneCall LinphoneCall;
 208
 209 /**
 210  * LinphoneCallState enum represents the different state a call can reach into.
 211  * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
 212  * @ingroup call_control
 213 **/
 214 typedef enum _LinphoneCallState{
 215         LinphoneCallIdle,                                       /**<Initial call state */
 216         LinphoneCallIncomingReceived, /**<This is a new incoming call */
 217         LinphoneCallOutgoingInit, /**<An outgoing call is started */
 218         LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
 219         LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
 220         LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
 221         LinphoneCallConnected, /**<Connected, the call is answered */
 222         LinphoneCallStreamsRunning, /**<The media streams are established and running*/
 223         LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
 224         LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
 225         LinphoneCallResuming, /**<The call is being resumed by local end*/
 226         LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
 227         LinphoneCallError, /**<The call encountered an error*/
 228         LinphoneCallEnd, /**<The call ended normally*/
 229         LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
 230         LinphoneCallUpdatedByRemote, /**<The call's parameters are updated, used for example when video is asked by remote */
 231         LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
 232         LinphoneCallUpdated, /**<The remote accepted the call update initiated by us */
 233         LinphoneCallReleased /**< The call object is no more retained by the core */
 234 } LinphoneCallState;
 235
 236 const char *linphone_call_state_to_string(LinphoneCallState cs);
 237
 238
 239 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
 240 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
 241 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
 242 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
 243 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
 244 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
 245 void linphone_call_ref(LinphoneCall *call);
 246 void linphone_call_unref(LinphoneCall *call);
 247 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
 248 const char *linphone_call_get_refer_to(const LinphoneCall *call);
 249 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
 250 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
 251 int linphone_call_get_duration(const LinphoneCall *call);
 252 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
 253 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
 254 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
 255 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
 256 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
 257 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
 258 float linphone_call_get_play_volume(LinphoneCall *call);
 259 float linphone_call_get_record_volume(LinphoneCall *call);
 260 float linphone_call_get_current_quality(LinphoneCall *call);
 261 float linphone_call_get_average_quality(LinphoneCall *call);
 262 void *linphone_call_get_user_pointer(LinphoneCall *call);
 263 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
 264 /**
 265  * Enables or disable echo cancellation for this call
 266  * @param call
 267  * @param val
 268  *
 269  * @ingroup media_parameters
 270 **/
 271 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
 272 /**
 273  * Returns TRUE if echo cancellation is enabled.
 274  *
 275  * @ingroup media_parameters
 276 **/
 277 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
 278 /**
 279  * Enables or disable echo limiter for this call
 280  * @param call
 281  * @param val
 282  *
 283  * @ingroup media_parameters
 284 **/
 285 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
 286 /**
 287  * Returns TRUE if echo limiter is enabled.
 288  *
 289  * @ingroup media_parameters
 290 **/
 291 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
 292
 293 /*keep this in sync with mediastreamer2/msvolume.h*/
 294 #define LINPHONE_VOLUME_DB_LOWEST (-120) /**< Lowest measured that can be returned.*/
 295
 296 /**
 297  * @addtogroup proxies
 298  * @{
 299 **/
 300 /**
 301  * The LinphoneProxyConfig object represents a proxy configuration to be used
 302  * by the LinphoneCore object.
 303  * Its fields must not be used directly in favour of the accessors methods.
 304  * Once created and filled properly the LinphoneProxyConfig can be given to
 305  * LinphoneCore with linphone_core_add_proxy_config().
 306  * This will automatically triggers the registration, if enabled.
 307  *
 308  * The proxy configuration are persistent to restarts because they are saved
 309  * in the configuration file. As a consequence, after linphone_core_new() there
 310  * might already be a list of configured proxy that can be examined with
 311  * linphone_core_get_proxy_config_list().
 312  *
 313  * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
 314  * that is used by default for calls.
 315 **/
 316 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
 317
 318 /**
 319  * LinphoneRegistrationState describes proxy registration states.
 320 **/
 321 typedef enum _LinphoneRegistrationState{
 322         LinphoneRegistrationNone, /**<Initial state for registrations */
 323         LinphoneRegistrationProgress, /**<Registration is in progress */
 324         LinphoneRegistrationOk, /**< Registration is successful */
 325         LinphoneRegistrationCleared, /**< Unregistration succeeded */
 326         LinphoneRegistrationFailed      /**<Registration failed */
 327 }LinphoneRegistrationState;
 328
 329 /**
 330  * Human readable version of the #LinphoneRegistrationState
 331  * @param cs sate
 332  */
 333 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
 334
 335 LinphoneProxyConfig *linphone_proxy_config_new(void);
 336 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
 337 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
 338 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
 339 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
 340 /**
 341  * Indicates  either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
 342  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
 343  * @param obj object pointer
 344  * @param val if true, registration will be engaged
 345  */
 346 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
 347 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
 348 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
 349 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
 350 /**
 351  * Indicates  either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
 352  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
 353  * @param obj object pointer
 354  * @param val if true, publish will be engaged
 355  *
 356  */
 357 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
 358 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
 359 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
 360
 361 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
 362 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
 363 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
 364
 365 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
 366 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
 367 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
 368 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
 369 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
 370 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
 371 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
 372 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
 373
 374 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
 375 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
 376
 377 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
 378
 379 /* destruction is called automatically when removing the proxy config */
 380 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
 381 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
 382 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
 383 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
 384 /**
 385  * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
 386  */
 387 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
 388 /*
 389  *  attached a user data to a proxy config
 390  */
 391 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
 392 /*
 393  *  get user data to a proxy config. return null if any
 394  */
 395 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
 396
 397 /**
 398  * @}
 399 **/
 400
 401 typedef struct _LinphoneAccountCreator{
 402         struct _LinphoneCore *lc;
 403         struct _SipSetupContext *ssctx;
 404         char *username;
 405         char *password;
 406         char *domain;
 407         bool_t succeeded;
 408 }LinphoneAccountCreator;
 409
 410 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
 411 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
 412 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
 413 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
 414 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
 415 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
 416 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
 417 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
 418 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
 419
 420 struct _LinphoneAuthInfo;
 421
 422 /**
 423  * @ingroup authentication
 424  * Object holding authentication information.
 425  *
 426  * @note The object's fields should not be accessed directly. Prefer using
 427  * the accessor methods.
 428  *
 429  * In most case, authentication information consists of a username and password.
 430  * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
 431  * different SIP domains.
 432  *
 433  * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
 434  * order to become known and used automatically when needed.
 435  * Use linphone_core_add_auth_info() for that purpose.
 436  *
 437  * The LinphoneCore object can take the initiative to request authentication information
 438  * when needed to the application through the auth_info_requested callback of the
 439  * LinphoneCoreVTable structure.
 440  *
 441  * The application can respond to this information request later using
 442  * linphone_core_add_auth_info(). This will unblock all pending authentication
 443  * transactions and retry them with authentication headers.
 444  *
 445 **/
 446 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
 447
 448 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
 449                 const char *passwd, const char *ha1,const char *realm);
 450 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
 451 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
 452 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
 453
 454 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
 455 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
 456 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
 457
 458 /* you don't need those function*/
 459 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
 460 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
 461
 462
 463 struct _LinphoneChatRoom;
 464 /**
 465  * @addtogroup chatroom
 466  * @{
 467  */
 468 /**
 469  * A chat room is the place where text messages are exchanged.
 470  * <br> Can be created by linphone_core_create_chat_room().
 471  */
 472 typedef struct _LinphoneChatRoom LinphoneChatRoom;
 473 /**
 474  * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
 475  * @param lc #LinphoneCore object
 476  * @param to destination address for messages
 477  * @return #LinphoneChatRoom where messaging can take place.
 478  */
 479 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
 480 /**
 481  * Destructor
 482  * @param cr #LinphoneChatRoom object
 483  */
 484 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
 485
 486
 487 /**
 488  * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
 489  * @param cr #LinphoneChatRoom object
 490  * @return #LinphoneAddress peer address
 491  */
 492 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
 493 /**
 494  * send a message to peer member of this chat room.
 495  * @param cr #LinphoneChatRoom object
 496  * @param msg message to be sent
 497  */
 498 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
 499
 500 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
 501 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
 502
 503 /**
 504  * @}
 505  */
 506
 507
 508 /**
 509  * @addtogroup initializing
 510  * @{
 511 **/
 512
 513 /**
 514  * LinphoneGlobalState describes the global state of the LinphoneCore object.
 515  * It is notified via the LinphoneCoreVTable::global_state_changed
 516 **/
 517 typedef enum _LinphoneGlobalState{
 518         LinphoneGlobalOff,
 519         LinphoneGlobalStartup,
 520         LinphoneGlobalOn,
 521         LinphoneGlobalShutdown
 522 }LinphoneGlobalState;
 523
 524 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
 525
 526
 527 /**Call state notification callback prototype*/
 528 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
 529 /**Call state notification callback prototype*/
 530 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
 531 /**Call encryption changed callback prototype*/
 532 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
 533
 534 /** @ingroup Proxies
 535  * Registration state notification callback prototype
 536  * */
 537 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
 538 /** Callback prototype */
 539 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
 540 /** Callback prototype */
 541 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
 542 /** Callback prototype */
 543 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
 544 /** Callback prototype */
 545 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
 546 /** Callback prototype */
 547 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
 548 /** Callback prototype */
 549 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
 550 /**
 551  * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
 552  * @param lc #LinphoneCore object .
 553  * @param lf Updated #LinphoneFriend .
 554  */
 555 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
 556 /**
 557  *  Reports that a new subscription request has been received and wait for a decision.
 558  *  <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
 559  *      @param lc #LinphoneCore object
 560  *      @param lf #LinphoneFriend corresponding to the subscriber
 561  *      @param url of the subscriber
 562  *  Callback prototype
 563  *  */
 564 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
 565 /** Callback prototype */
 566 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
 567 /** Callback prototype */
 568 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
 569 /**
 570  * Callback prototype
 571  *
 572  * @param lc #LinphoneCore object
 573  * @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.
 574  * @param from #LinphoneAddress from
 575  * @param message incoming message
 576  *  */
 577 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
 578 /** Callback prototype */
 579 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
 580 /** Callback prototype */
 581 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
 582 /** Callback prototype */
 583 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
 584
 585 /**
 586  * This structure holds all callbacks that the application should implement.
 587  *  None is mandatory.
 588 **/
 589 typedef struct _LinphoneVTable{
 590         LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
 591         LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
 592         LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
 593         NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
 594         NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
 595         AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
 596         CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
 597         TextMessageReceived text_received; /**< A text message has been received */
 598         DtmfReceived dtmf_received; /**< A dtmf has been received received */
 599         ReferReceived refer_received; /**< An out of call refer was received */
 600         BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
 601         NotifyReceivedCb notify_recv; /**< Other notifications*/
 602         DisplayStatusCb display_status; /**< Callback that notifies various events with human readable text.*/
 603         DisplayMessageCb display_message;/**< Callback to display a message to the user */
 604         DisplayMessageCb display_warning;/** Callback to display a warning to the user */
 605         DisplayUrlCb display_url;
 606         ShowInterfaceCb show; /**< Notifies the application that it should show up*/
 607         CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
 608 } LinphoneCoreVTable;
 609
 610 /**
 611  * @}
 612 **/
 613
 614 typedef struct _LCCallbackObj
 615 {
 616   LinphoneCoreCbFunc _func;
 617   void * _user_data;
 618 }LCCallbackObj;
 619
 620
 621
 622 typedef enum _LinphoneFirewallPolicy{
 623         LinphonePolicyNoFirewall,
 624         LinphonePolicyUseNatAddress,
 625         LinphonePolicyUseStun
 626 } LinphoneFirewallPolicy;
 627
 628 typedef enum _LinphoneWaitingState{
 629         LinphoneWaitingStart,
 630         LinphoneWaitingProgress,
 631         LinphoneWaitingFinished
 632 } LinphoneWaitingState;
 633 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
 634
 635
 636 /* THE main API */
 637
 638 void linphone_core_enable_logs(FILE *file);
 639 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
 640 void linphone_core_disable_logs(void);
 641 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
 642 void linphone_core_set_user_agent(const char *ua_name, const char *version);
 643 const char *linphone_core_get_version(void);
 644
 645 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
 646                                                 const char *config_path, const char *factory_config, void* userdata);
 647
 648 /* function to be periodically called in a main loop */
 649 void linphone_core_iterate(LinphoneCore *lc);
 650
 651 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
 652
 653 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
 654
 655 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
 656
 657 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
 658
 659 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
 660
 661 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
 662
 663 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
 664
 665 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
 666
 667 bool_t linphone_core_in_call(const LinphoneCore *lc);
 668
 669 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
 670
 671 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
 672
 673 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
 674
 675 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
 676
 677 int linphone_core_terminate_all_calls(LinphoneCore *lc);
 678
 679 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
 680
 681 int linphone_core_pause_all_calls(LinphoneCore *lc);
 682
 683 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
 684
 685 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
 686
 687 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
 688
 689 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
 690
 691 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
 692
 693 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
 694
 695 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
 696
 697 const char * linphone_core_get_identity(LinphoneCore *lc);
 698
 699 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
 700 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
 701
 702 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
 703 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
 704
 705 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
 706 const char * linphone_core_get_identity(LinphoneCore *lc);
 707 /*0= no bandwidth limit*/
 708 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
 709 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
 710
 711 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
 712 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
 713
 714 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
 715 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
 716 /**
 717  * set audio packetization time linphone expect to receive from peer
 718  * @ingroup media_parameters
 719  *
 720  */
 721 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
 722 /**
 723  * get audio packetization time linphone expect to receive from peer, 0 means unspecified
 724  * @ingroup media_parameters
 725  */
 726 int  linphone_core_get_download_ptime(LinphoneCore *lc);
 727
 728 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
 729
 730 int linphone_core_get_upload_ptime(LinphoneCore *lc);
 731
 732 /* returns a MSList of PayloadType */
 733 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
 734
 735 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
 736 /* returns a MSList of PayloadType */
 737 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
 738
 739 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
 740
 741 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, PayloadType *pt);
 742
 743 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
 744
 745 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate) ;
 746
 747 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
 748
 749 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
 750
 751 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
 752
 753 void linphone_core_clear_proxy_config(LinphoneCore *lc);
 754
 755 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
 756
 757 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
 758
 759 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
 760
 761 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
 762
 763 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
 764
 765 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
 766
 767 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
 768
 769 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
 770
 771 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
 772
 773 void linphone_core_abort_authentication(LinphoneCore *lc,  LinphoneAuthInfo *info);
 774
 775 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
 776
 777 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
 778
 779 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
 780
 781 int linphone_core_get_audio_port(const LinphoneCore *lc);
 782
 783 int linphone_core_get_video_port(const LinphoneCore *lc);
 784
 785 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
 786
 787 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
 788
 789 void linphone_core_set_video_port(LinphoneCore *lc, int port);
 790
 791 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
 792
 793 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
 794
 795 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
 796
 797 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
 798
 799 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
 800
 801 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
 802
 803 int linphone_core_get_sip_port(LinphoneCore *lc);
 804
 805 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
 806
 807 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
 808 /**
 809  * @ingroup IOS
 810  * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
 811  * @param lc #LinphoneCore
 812  * @return socket file descriptor
 813  */
 814 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
 815
 816 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
 817
 818 int linphone_core_get_inc_timeout(LinphoneCore *lc);
 819
 820 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
 821
 822 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
 823
 824 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
 825
 826 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
 827
 828 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
 829
 830 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
 831
 832 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
 833
 834 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
 835
 836 /* sound functions */
 837 /* returns a null terminated static array of string describing the sound devices */
 838 const char**  linphone_core_get_sound_devices(LinphoneCore *lc);
 839 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
 840 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
 841 int linphone_core_get_ring_level(LinphoneCore *lc);
 842 int linphone_core_get_play_level(LinphoneCore *lc);
 843 int linphone_core_get_rec_level(LinphoneCore *lc);
 844 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
 845 void linphone_core_set_play_level(LinphoneCore *lc, int level);
 846
 847 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
 848
 849 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
 850 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
 851 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
 852 const char * linphone_core_get_playback_device(LinphoneCore *lc);
 853 const char * linphone_core_get_capture_device(LinphoneCore *lc);
 854 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
 855 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
 856 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
 857 char linphone_core_get_sound_source(LinphoneCore *lc);
 858 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
 859 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
 860 const char *linphone_core_get_ring(const LinphoneCore *lc);
 861 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
 862 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
 863 const char * linphone_core_get_ringback(const LinphoneCore *lc);
 864
 865 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
 866 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
 867
 868 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
 869 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
 870 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
 871
 872 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
 873 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
 874
 875 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
 876 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
 877
 878 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
 879 /**
 880  * return mic state.
 881  *
 882  * @ingroup media_parameters
 883 **/
 884 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
 885
 886 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
 887 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
 888
 889 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
 890 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
 891
 892
 893 /* returns a list of LinphoneCallLog */
 894 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
 895 void linphone_core_clear_call_logs(LinphoneCore *lc);
 896
 897 /* video support */
 898 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
 899 bool_t linphone_core_video_enabled(LinphoneCore *lc);
 900
 901 typedef struct MSVideoSizeDef{
 902         MSVideoSize vsize;
 903         const char *name;
 904 }MSVideoSizeDef;
 905 /* returns a zero terminated table of MSVideoSizeDef*/
 906 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
 907 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
 908 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
 909 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
 910
 911 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
 912 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
 913
 914 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
 915 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
 916
 917
 918 /* returns a null terminated static array of string describing the webcams */
 919 const char**  linphone_core_get_video_devices(const LinphoneCore *lc);
 920 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
 921 const char *linphone_core_get_video_device(const LinphoneCore *lc);
 922
 923 /* Set static picture to be used when "Static picture" is the video device */
 924 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
 925
 926 /* Set and get frame rate for static picture */
 927 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
 928 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
 929
 930 /*function to be used for eventually setting window decorations (icons, title...)*/
 931 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
 932 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
 933
 934 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
 935 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
 936
 937 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
 938
 939 /*play/record support: use files instead of soundcard*/
 940 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
 941 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
 942 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
 943
 944 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
 945 void linphone_core_stop_dtmf(LinphoneCore *lc);
 946
 947 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
 948
 949
 950 int linphone_core_get_mtu(const LinphoneCore *lc);
 951 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
 952
 953 /**
 954  * @ingroup network_parameters
 955  * This method is called by the application to notify the linphone core library when network is reachable.
 956  * Calling this method with true trigger linphone to initiate a registration process for all proxy
 957  * configuration with parameter register set to enable.
 958  * This method disable the automatic registration mode. It means you must call this method after each network state changes
 959  *
 960  */
 961 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
 962 /**
 963  * @ingroup network_parameters
 964  * return network state either as positioned by the application or by linphone
 965  */
 966 bool_t linphone_core_is_network_reachabled(LinphoneCore* lc);
 967
 968 /**
 969  *  @ingroup network_parameters
 970  *  enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
 971  */
 972 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
 973 /**
 974  *  @ingroup network_parameters
 975  * Is signaling keep alive
 976  */
 977 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
 978
 979 void *linphone_core_get_user_data(LinphoneCore *lc);
 980
 981 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
 982 the config file with your own sections */
 983 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
 984
 985 /* attempts to wake up another linphone engine already running.
 986 The "show" callback is called for the other linphone, causing gui to show up.
 987 call_addr is an optional sip-uri to call immediately after waking up.
 988 The method returns 0 if an already running linphone was found*/
 989
 990 int linphone_core_wake_up_possible_already_running_instance(
 991     const char * config_file, const char * call_addr);
 992
 993 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
 994 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
 995
 996 /*returns the list of registered SipSetup (linphonecore plugins) */
 997 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
 998
 999 void linphone_core_destroy(LinphoneCore *lc);
1000
1001 /*for advanced users:*/
1002 void linphone_core_set_audio_transports(LinphoneCore *lc, RtpTransport *rtp, RtpTransport *rtcp);
1003 void linphone_core_set_video_transports(LinphoneCore *lc, RtpTransport *rtp, RtpTransport *rtcp);
1004
1005
1006 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1007
1008 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1009
1010 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1011 /**
1012  * force registration refresh to be initiated upon next iterate
1013  * @ingroup proxies
1014  */
1015 void linphone_core_refresh_registers(LinphoneCore* lc);
1016
1017
1018 void linphone_call_send_vfu_request(LinphoneCall *call);
1019
1020 /* Path to the file storing secrets cache */
1021 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1022
1023 bool_t linphone_call_are_all_streams_encrypted(LinphoneCall *call);
1024 const char* linphone_call_get_authentication_token(LinphoneCall *call);
1025 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
1026
1027 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1028 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1029 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1030 int linphone_core_enter_conference(LinphoneCore *lc);
1031 int linphone_core_leave_conference(LinphoneCore *lc);
1032
1033
1034 #ifdef __cplusplus
1035 }
1036 #endif
1037
1038
1039 #endif