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 LinphoneCallLog;
 145
 146 /**
 147  * Enum describing type of media encryption types.
 148 **/
 149 enum LinphoneMediaEncryption {
 150         LinphoneMediaEncryptionNone,
 151         LinphoneMediaEncryptionSRTP,
 152         LinphoneMediaEncryptionZRTP
 153 };
 154
 155 /**
 156  * Enum describing type of media encryption types.
 157 **/
 158 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
 159
 160 /*public: */
 161 LinphoneAddress *linphone_call_log_get_from(LinphoneCallLog *cl);
 162 LinphoneAddress *linphone_call_log_get_to(LinphoneCallLog *cl);
 163 LinphoneCallDir linphone_call_log_get_dir(LinphoneCallLog *cl);
 164 LinphoneCallStatus linphone_call_log_get_status(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 char * linphone_call_log_to_str(LinphoneCallLog *cl);
 175
 176 struct _LinphoneCallParams;
 177
 178 /**
 179  * The LinphoneCallParams is an object containing various call related parameters.
 180  * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
 181  * dynamically.
 182 **/
 183 typedef struct _LinphoneCallParams LinphoneCallParams;
 184
 185 const PayloadType* linphone_call_params_get_used_audio_codec(const LinphoneCallParams *cp);
 186 const PayloadType* linphone_call_params_get_used_video_codec(const LinphoneCallParams *cp);
 187 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
 188 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
 189 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
 190 LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
 191 void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
 192 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
 193 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
 194 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
 195 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
 196 void linphone_call_params_destroy(LinphoneCallParams *cp);
 197 bool_t linphone_call_params_low_bandwidth_enabled(const LinphoneCallParams *cp);
 198 void linphone_call_params_enable_low_bandwidth(LinphoneCallParams *cp, bool_t enabled);
 199 void linphone_call_params_set_record_file(LinphoneCallParams *cp, const char *path);
 200 const char *linphone_call_params_get_record_file(const LinphoneCallParams *cp);
 201 void linphone_call_params_add_custom_header(LinphoneCallParams *params, const char *header_name, const char *header_value);
 202 const char *linphone_call_params_get_custom_header(LinphoneCallParams *params, const char *header_name);
 203 /**
 204  * Enum describing failure reasons.
 205  * @ingroup initializing
 206 **/
 207 enum _LinphoneReason{
 208         LinphoneReasonNone,
 209         LinphoneReasonNoResponse, /**<No response received from remote*/
 210         LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
 211         LinphoneReasonDeclined, /**<The call has been declined*/
 212         LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
 213         LinphoneReasonNotAnswered, /**<The call was not answered in time*/
 214         LinphoneReasonBusy /**<Phone line was busy */
 215 };
 216
 217 /**
 218  * Enum describing failure reasons.
 219  * @ingroup initializing
 220 **/
 221 typedef enum _LinphoneReason LinphoneReason;
 222
 223 const char *linphone_reason_to_string(LinphoneReason err);
 224
 225 /**
 226  * Structure describing policy regarding video streams establishments.
 227  * @ingroup media_parameters
 228 **/
 229 struct _LinphoneVideoPolicy{
 230         bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/
 231         bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
 232         bool_t unused[2];
 233 };
 234
 235 /**
 236  * Structure describing policy regarding video streams establishments.
 237  * @ingroup media_parameters
 238 **/
 239 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
 240
 241 /**
 242  * The LinphoneCall object represents a call issued or received by the LinphoneCore
 243  * @ingroup call_control
 244 **/
 245 struct _LinphoneCall;
 246 /**
 247  * The LinphoneCall object represents a call issued or received by the LinphoneCore
 248  * @ingroup call_control
 249 **/
 250 typedef struct _LinphoneCall LinphoneCall;
 251
 252
 253 /**
 254  * @addtogroup call_misc
 255  * @{
 256 **/
 257
 258 #define LINPHONE_CALL_STATS_AUDIO 0
 259 #define LINPHONE_CALL_STATS_VIDEO 1
 260
 261 /**
 262  * Enum describing ICE states.
 263  * @ingroup initializing
 264 **/
 265 enum _LinphoneIceState{
 266         LinphoneIceStateNotActivated, /**< ICE has not been activated for this call */
 267         LinphoneIceStateFailed, /**< ICE processing has failed */
 268         LinphoneIceStateInProgress, /**< ICE process is in progress */
 269         LinphoneIceStateHostConnection, /**< ICE has established a direct connection to the remote host */
 270         LinphoneIceStateReflexiveConnection, /**< ICE has established a connection to the remote host through one or several NATs */
 271         LinphoneIceStateRelayConnection /**< ICE has established a connection through a relay */
 272 };
 273
 274 /**
 275  * Enum describing Ice states.
 276  * @ingroup initializing
 277 **/
 278 typedef enum _LinphoneIceState LinphoneIceState;
 279
 280 /**
 281  * Enum describing uPnP states.
 282  * @ingroup initializing
 283 **/
 284 enum _LinphoneUpnpState{
 285         LinphoneUpnpStateIdle, /**< uPnP is not activate */
 286         LinphoneUpnpStatePending, /**< uPnP process is in progress */
 287         LinphoneUpnpStateAdding,   /**< Internal use: Only used by port binding */
 288         LinphoneUpnpStateRemoving, /**< Internal use: Only used by port binding */
 289         LinphoneUpnpStateNotAvailable,  /**< uPnP is not available */
 290         LinphoneUpnpStateOk, /**< uPnP is enabled */
 291         LinphoneUpnpStateKo, /**< uPnP processing has failed */
 292 };
 293
 294 /**
 295  * Enum describing uPnP states.
 296  * @ingroup initializing
 297 **/
 298 typedef enum _LinphoneUpnpState LinphoneUpnpState;
 299
 300
 301 /**
 302  * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
 303  *
 304  * 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
 305  * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
 306  *
 307  * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
 308 **/
 309 typedef struct _LinphoneCallStats LinphoneCallStats;
 310
 311 /**
 312  * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
 313  *
 314  * 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
 315  * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
 316  *
 317  * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
 318 **/
 319 struct _LinphoneCallStats {
 320         int             type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
 321         jitter_stats_t  jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
 322         mblk_t*         received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
 323         mblk_t*         sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
 324         float           round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
 325         LinphoneIceState        ice_state; /**< State of ICE processing. */
 326         LinphoneUpnpState       upnp_state; /**< State of uPnP processing. */
 327         float download_bandwidth; /**<Download bandwidth measurement of received stream, expressed in kbit/s, including IP/UDP/RTP headers*/
 328         float upload_bandwidth; /**<Download bandwidth measurement of sent stream, expressed in kbit/s, including IP/UDP/RTP headers*/
 329 };
 330
 331 /**
 332  * @}
 333 **/
 334
 335 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
 336 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
 337
 338
 339 /** Callback prototype */
 340 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
 341
 342 /**
 343  * LinphoneCallState enum represents the different state a call can reach into.
 344  * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
 345  * @ingroup call_control
 346 **/
 347 typedef enum _LinphoneCallState{
 348         LinphoneCallIdle,                                       /**<Initial call state */
 349         LinphoneCallIncomingReceived, /**<This is a new incoming call */
 350         LinphoneCallOutgoingInit, /**<An outgoing call is started */
 351         LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
 352         LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
 353         LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
 354         LinphoneCallConnected, /**<Connected, the call is answered */
 355         LinphoneCallStreamsRunning, /**<The media streams are established and running*/
 356         LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
 357         LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
 358         LinphoneCallResuming, /**<The call is being resumed by local end*/
 359         LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
 360         LinphoneCallError, /**<The call encountered an error*/
 361         LinphoneCallEnd, /**<The call ended normally*/
 362         LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
 363         LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
 364         LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
 365         LinphoneCallUpdating, /**<A call update has been initiated by us */
 366         LinphoneCallReleased /**< The call object is no more retained by the core */
 367 } LinphoneCallState;
 368
 369 const char *linphone_call_state_to_string(LinphoneCallState cs);
 370
 371 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
 372 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
 373 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
 374 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
 375 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
 376 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
 377 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
 378 LinphoneCall * linphone_call_ref(LinphoneCall *call);
 379 void linphone_call_unref(LinphoneCall *call);
 380 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
 381 const char *linphone_call_get_refer_to(const LinphoneCall *call);
 382 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
 383 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
 384 int linphone_call_get_duration(const LinphoneCall *call);
 385 const LinphoneCallParams * linphone_call_get_current_params(LinphoneCall *call);
 386 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
 387 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
 388 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
 389 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
 390 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
 391 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
 392 const char *linphone_call_get_remote_contact(LinphoneCall *call);
 393 float linphone_call_get_play_volume(LinphoneCall *call);
 394 float linphone_call_get_record_volume(LinphoneCall *call);
 395 float linphone_call_get_current_quality(LinphoneCall *call);
 396 float linphone_call_get_average_quality(LinphoneCall *call);
 397 const char* linphone_call_get_authentication_token(LinphoneCall *call);
 398 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
 399 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
 400 void linphone_call_send_vfu_request(LinphoneCall *call);
 401 void *linphone_call_get_user_pointer(LinphoneCall *call);
 402 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
 403 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
 404 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
 405 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);
 406 void linphone_call_start_recording(LinphoneCall *call);
 407 void linphone_call_stop_recording(LinphoneCall *call);
 408 /**
 409  * Return TRUE if this call is currently part of a conference
 410  *@param call #LinphoneCall
 411  *@return TRUE if part of a conference.
 412  *
 413  @ingroup call_control
 414  */
 415 bool_t linphone_call_is_in_conference(const LinphoneCall *call);
 416 /**
 417  * Enables or disable echo cancellation for this call
 418  * @param call
 419  * @param val
 420  *
 421  * @ingroup media_parameters
 422 **/
 423 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
 424 /**
 425  * Returns TRUE if echo cancellation is enabled.
 426  *
 427  * @ingroup media_parameters
 428 **/
 429 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
 430 /**
 431  * Enables or disable echo limiter for this call
 432  * @param call
 433  * @param val
 434  *
 435  * @ingroup media_parameters
 436 **/
 437 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
 438 /**
 439  * Returns TRUE if echo limiter is enabled.
 440  *
 441  * @ingroup media_parameters
 442 **/
 443 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
 444
 445 /*keep this in sync with mediastreamer2/msvolume.h*/
 446
 447 /**
 448  * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
 449  * @ingroup call_misc
 450 **/
 451 #define LINPHONE_VOLUME_DB_LOWEST (-120)
 452
 453 /**
 454  * @addtogroup proxies
 455  * @{
 456 **/
 457 /**
 458  * The LinphoneProxyConfig object represents a proxy configuration to be used
 459  * by the LinphoneCore object.
 460  * Its fields must not be used directly in favour of the accessors methods.
 461  * Once created and filled properly the LinphoneProxyConfig can be given to
 462  * LinphoneCore with linphone_core_add_proxy_config().
 463  * This will automatically triggers the registration, if enabled.
 464  *
 465  * The proxy configuration are persistent to restarts because they are saved
 466  * in the configuration file. As a consequence, after linphone_core_new() there
 467  * might already be a list of configured proxy that can be examined with
 468  * linphone_core_get_proxy_config_list().
 469  *
 470  * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
 471  * that is used by default for calls.
 472 **/
 473 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
 474
 475 /**
 476  * LinphoneRegistrationState describes proxy registration states.
 477 **/
 478 typedef enum _LinphoneRegistrationState{
 479         LinphoneRegistrationNone, /**<Initial state for registrations */
 480         LinphoneRegistrationProgress, /**<Registration is in progress */
 481         LinphoneRegistrationOk, /**< Registration is successful */
 482         LinphoneRegistrationCleared, /**< Unregistration succeeded */
 483         LinphoneRegistrationFailed      /**<Registration failed */
 484 }LinphoneRegistrationState;
 485
 486 /**
 487  * Human readable version of the #LinphoneRegistrationState
 488  * @param cs sate
 489  */
 490 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
 491
 492 LinphoneProxyConfig *linphone_proxy_config_new(void);
 493 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
 494 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
 495 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
 496 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
 497 /**
 498  * Indicates  either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
 499  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
 500  * @param obj object pointer
 501  * @param val if true, registration will be engaged
 502  */
 503 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
 504 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
 505 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
 506 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
 507 /**
 508  * Indicates  either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
 509  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
 510  * @param obj object pointer
 511  * @param val if true, publish will be engaged
 512  *
 513  */
 514 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
 515 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
 516 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
 517
 518 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
 519 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
 520 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
 521
 522 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
 523 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
 524 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
 525 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
 526 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
 527 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
 528 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
 529 const char *linphone_proxy_config_get_contact_parameters(const LinphoneProxyConfig *obj);
 530 void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, const char *contact_params);
 531 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
 532
 533 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
 534 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
 535
 536 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
 537
 538 /* destruction is called automatically when removing the proxy config */
 539 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
 540 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
 541 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
 542 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
 543 /**
 544  * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
 545  */
 546 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
 547 /*
 548  *  attached a user data to a proxy config
 549  */
 550 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
 551 /*
 552  *  get user data to a proxy config. return null if any
 553  */
 554 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
 555
 556 /**
 557  * @}
 558 **/
 559
 560 typedef struct _LinphoneAccountCreator{
 561         struct _LinphoneCore *lc;
 562         struct _SipSetupContext *ssctx;
 563         char *username;
 564         char *password;
 565         char *domain;
 566         char *route;
 567         char *email;
 568         int suscribe;
 569         bool_t succeeded;
 570 }LinphoneAccountCreator;
 571
 572 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
 573 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
 574 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
 575 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
 576 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
 577 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
 578 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
 579 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
 580 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
 581 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
 582 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
 583 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
 584 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
 585
 586 struct _LinphoneAuthInfo;
 587
 588 /**
 589  * @ingroup authentication
 590  * Object holding authentication information.
 591  *
 592  * @note The object's fields should not be accessed directly. Prefer using
 593  * the accessor methods.
 594  *
 595  * In most case, authentication information consists of a username and password.
 596  * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
 597  * different SIP domains.
 598  *
 599  * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
 600  * order to become known and used automatically when needed.
 601  * Use linphone_core_add_auth_info() for that purpose.
 602  *
 603  * The LinphoneCore object can take the initiative to request authentication information
 604  * when needed to the application through the auth_info_requested callback of the
 605  * LinphoneCoreVTable structure.
 606  *
 607  * The application can respond to this information request later using
 608  * linphone_core_add_auth_info(). This will unblock all pending authentication
 609  * transactions and retry them with authentication headers.
 610  *
 611 **/
 612 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
 613
 614 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
 615                 const char *passwd, const char *ha1,const char *realm);
 616 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
 617 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
 618 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
 619
 620 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
 621 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
 622 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
 623
 624 /* you don't need those function*/
 625 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
 626 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
 627
 628
 629 struct _LinphoneChatRoom;
 630 /**
 631  * @addtogroup chatroom
 632  * @{
 633  */
 634
 635 /**
 636  * A chat room message to old content to be sent.
 637  * <br> Can be created by linphone_chat_room_create_message().
 638  */
 639 typedef struct _LinphoneChatMessage LinphoneChatMessage;
 640
 641 /**
 642  * A chat room is the place where text messages are exchanged.
 643  * <br> Can be created by linphone_core_create_chat_room().
 644  */
 645 typedef struct _LinphoneChatRoom LinphoneChatRoom;
 646
 647 /**
 648  *LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
 649  */
 650 typedef enum _LinphoneChatMessageStates {
 651         LinphoneChatMessageStateIdle, /**<initial state*/
 652         LinphoneChatMessageStateInProgress, /**<delivery in progress**/
 653         LinphoneChatMessageStateDelivered, /**<message succesffully delivered an acknoleged by remote end point*/
 654         LinphoneChatMessageStateNotDelivered /**<message was not delivered*/
 655 }LinphoneChatMessageState;
 656
 657 /**
 658  * Call back used to notify message delivery status
 659  *@param msg #LinphoneChatMessage object
 660  *@param status LinphoneChatMessageState
 661  *@param ud application user data
 662  */
 663 typedef void (*LinphoneChatMessageStateChangeCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
 664
 665 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
 666 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
 667 LinphoneChatMessage* linphone_chat_room_create_message(LinphoneChatRoom *cr,const char* message);
 668 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
 669 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
 670 void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage* msg,LinphoneChatMessageStateChangeCb status_cb,void* ud);
 671 LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr);
 672 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
 673 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
 674
 675 const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
 676 LinphoneChatMessage* linphone_chat_message_clone(const LinphoneChatMessage* message);
 677 void linphone_chat_message_set_from(LinphoneChatMessage* message, const LinphoneAddress* from);
 678 LinphoneAddress* linphone_chat_message_get_from(const LinphoneChatMessage* message);
 679 const char* linphone_chat_message_get_external_body_url(const LinphoneChatMessage* message);
 680 void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
 681 const char * linphone_chat_message_get_text(const LinphoneChatMessage* message);
 682 time_t linphone_chat_message_get_time(const LinphoneChatMessage* message);
 683 void* linphone_chat_message_get_user_data(const LinphoneChatMessage* message);
 684 void linphone_chat_message_set_user_data(LinphoneChatMessage* message,void*);
 685 LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
 686 const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
 687 void linphone_chat_message_add_custom_header(LinphoneChatMessage* message, const char *header_name, const char *header_value);
 688 const char * linphone_chat_message_get_custom_header(LinphoneChatMessage* message, const char *header_name);
 689
 690 /**
 691  * @}
 692  */
 693
 694
 695 /**
 696  * @addtogroup initializing
 697  * @{
 698 **/
 699
 700 /**
 701  * LinphoneGlobalState describes the global state of the LinphoneCore object.
 702  * It is notified via the LinphoneCoreVTable::global_state_changed
 703 **/
 704 typedef enum _LinphoneGlobalState{
 705         LinphoneGlobalOff,
 706         LinphoneGlobalStartup,
 707         LinphoneGlobalOn,
 708         LinphoneGlobalShutdown
 709 }LinphoneGlobalState;
 710
 711 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
 712
 713
 714 /**Call state notification callback prototype*/
 715 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
 716 /**Call state notification callback prototype*/
 717 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
 718 /**Call encryption changed callback prototype*/
 719 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
 720
 721 /** @ingroup Proxies
 722  * Registration state notification callback prototype
 723  * */
 724 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
 725 /** Callback prototype */
 726 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
 727 /** Callback prototype */
 728 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
 729 /** Callback prototype */
 730 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
 731 /** Callback prototype */
 732 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
 733 /** Callback prototype */
 734 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
 735 /** Callback prototype */
 736 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
 737 /**
 738  * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
 739  * @param lc #LinphoneCore object .
 740  * @param lf Updated #LinphoneFriend .
 741  */
 742 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
 743 /**
 744  *  Reports that a new subscription request has been received and wait for a decision.
 745  *  <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
 746  *      @param lc #LinphoneCore object
 747  *      @param lf #LinphoneFriend corresponding to the subscriber
 748  *      @param url of the subscriber
 749  *  Callback prototype
 750  *  */
 751 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
 752 /** Callback prototype */
 753 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
 754 /** Callback prototype */
 755 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
 756 /**
 757  * Callback prototype
 758  * @deprecated use #MessageReceived instead.
 759  *
 760  * @param lc #LinphoneCore object
 761  * @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.
 762  * @param from #LinphoneAddress from
 763  * @param message incoming message
 764  *  */
 765 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
 766 /**
 767  * Chat message callback prototype
 768  *
 769  * @param lc #LinphoneCore object
 770  * @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.
 771  * @param LinphoneChatMessage incoming message
 772  * */
 773 typedef void (*MessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
 774
 775 /** Callback prototype */
 776 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
 777 /** Callback prototype */
 778 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
 779 /** Callback prototype */
 780 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
 781 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
 782 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
 783 /** Callback prototype for receiving quality statistics for calls*/
 784 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
 785
 786 /**
 787  * This structure holds all callbacks that the application should implement.
 788  *  None is mandatory.
 789 **/
 790 typedef struct _LinphoneVTable{
 791         LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
 792         LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
 793         LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
 794         NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
 795         NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
 796         AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
 797         CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
 798         TextMessageReceived text_received; /** @deprecated, use #message_received instead <br> A text message has been received */
 799         MessageReceived message_received; /** a message is received, can be text or external body*/
 800         DtmfReceived dtmf_received; /**< A dtmf has been received received */
 801         ReferReceived refer_received; /**< An out of call refer was received */
 802         CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
 803         LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
 804         BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
 805         NotifyReceivedCb notify_recv; /**< Other notifications*/
 806         CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
 807         DisplayStatusCb display_status; /**< DEPRECATED Callback that notifies various events with human readable text.*/
 808         DisplayMessageCb display_message;/**< DEPRECATED Callback to display a message to the user */
 809         DisplayMessageCb display_warning;/**< DEPRECATED Callback to display a warning to the user */
 810         DisplayUrlCb display_url; /**< DEPRECATED */
 811         ShowInterfaceCb show; /**< DEPRECATED Notifies the application that it should show up*/
 812 } LinphoneCoreVTable;
 813
 814 /**
 815  * @}
 816 **/
 817
 818 typedef struct _LCCallbackObj
 819 {
 820   LinphoneCoreCbFunc _func;
 821   void * _user_data;
 822 }LCCallbackObj;
 823
 824
 825
 826 typedef enum _LinphoneFirewallPolicy{
 827         LinphonePolicyNoFirewall,
 828         LinphonePolicyUseNatAddress,
 829         LinphonePolicyUseStun,
 830         LinphonePolicyUseIce,
 831         LinphonePolicyUseUpnp,
 832 } LinphoneFirewallPolicy;
 833
 834 typedef enum _LinphoneWaitingState{
 835         LinphoneWaitingStart,
 836         LinphoneWaitingProgress,
 837         LinphoneWaitingFinished
 838 } LinphoneWaitingState;
 839 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
 840
 841
 842 /* THE main API */
 843
 844 void linphone_core_enable_logs(FILE *file);
 845 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
 846 void linphone_core_disable_logs(void);
 847 const char *linphone_core_get_version(void);
 848 const char *linphone_core_get_user_agent_name(void);
 849 const char *linphone_core_get_user_agent_version(void);
 850
 851 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
 852                                                 const char *config_path, const char *factory_config, void* userdata);
 853
 854 /* function to be periodically called in a main loop */
 855 /* For ICE to work properly it should be called every 20ms */
 856 void linphone_core_iterate(LinphoneCore *lc);
 857 #if 0 /*not implemented yet*/
 858 /**
 859  * @ingroup initializing
 860  * Provide Linphone Core with an unique identifier. This be later used to identified contact address coming from this device.
 861  * Value is not saved.
 862  * @param lc object
 863  * @param string identifying the device, can be EMEI or UDID
 864  *
 865  */
 866 void linphone_core_set_device_identifier(LinphoneCore *lc,const char* device_id);
 867 /**
 868  * @ingroup initializing
 869  * get Linphone unique identifier
 870  *
 871  */
 872 const char*  linphone_core_get_device_identifier(const LinphoneCore *lc);
 873
 874 #endif
 875
 876 /*sets the user-agent string in sip messages, ideally called just after linphone_core_new() or linphone_core_init() */
 877 void linphone_core_set_user_agent(LinphoneCore *lc, const char *ua_name, const char *version);
 878
 879 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
 880
 881 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
 882
 883 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
 884
 885 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
 886
 887 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
 888
 889 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
 890
 891 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
 892
 893 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
 894
 895 bool_t linphone_core_in_call(const LinphoneCore *lc);
 896
 897 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
 898
 899 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
 900
 901 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
 902
 903 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
 904
 905 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
 906
 907 int linphone_core_decline_call(LinphoneCore *lc, LinphoneCall * call, LinphoneReason reason);
 908
 909 int linphone_core_terminate_all_calls(LinphoneCore *lc);
 910
 911 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
 912
 913 int linphone_core_pause_all_calls(LinphoneCore *lc);
 914
 915 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
 916
 917 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
 918
 919 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
 920
 921 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
 922
 923 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
 924
 925 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
 926
 927 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
 928
 929 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
 930
 931 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
 932
 933 const char * linphone_core_get_identity(LinphoneCore *lc);
 934
 935 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
 936 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
 937
 938 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
 939 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
 940
 941 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
 942 const char * linphone_core_get_identity(LinphoneCore *lc);
 943 /*0= no bandwidth limit*/
 944 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
 945 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
 946
 947 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
 948 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
 949
 950 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
 951 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
 952
 953 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
 954 int  linphone_core_get_download_ptime(LinphoneCore *lc);
 955
 956 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
 957
 958 int linphone_core_get_upload_ptime(LinphoneCore *lc);
 959
 960 /* returns a MSList of PayloadType */
 961 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
 962
 963 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
 964 /* returns a MSList of PayloadType */
 965 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
 966
 967 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
 968
 969 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
 970
 971 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
 972
 973 /**
 974  * Wildcard value used by #linphone_core_find_payload_type to ignore rate in search algirithm
 975  * @ingroup media_parameters
 976  */
 977 #define LINPHONE_FIND_PAYLOAD_IGNORE_RATE -1
 978 /**
 979  * Wildcard value used by #linphone_core_find_payload_type to ignore channel in search algirithm
 980  * @ingroup media_parameters
 981  */
 982 #define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS -1
 983 /**
 984  * Get payload type from mime type and clock rate
 985  * @ingroup media_parameters
 986  * This function searches in audio and video codecs for the given payload type name and clockrate.
 987  * @param lc #LinphoneCore object
 988  * @param type payload mime type (I.E SPEEX, PCMU, VP8)
 989  * @param rate can be #LINPHONE_FIND_PAYLOAD_IGNORE_RATE
 990  * @param channels  number of channels, can be #LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
 991  * @return Returns NULL if not found.
 992  */
 993 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate, int channels) ;
 994
 995 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
 996
 997 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
 998
 999 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
1000
1001 /**
1002  * @ingroup proxy
1003  *Create a proxy config with default value from Linphone core.
1004  *@param lc #LinphoneCore object
1005  *@return #LinphoneProxyConfig with defualt value set
1006  */
1007 LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *lc);
1008
1009 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1010
1011 void linphone_core_clear_proxy_config(LinphoneCore *lc);
1012
1013 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1014
1015 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
1016
1017 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
1018
1019 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
1020
1021 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
1022
1023 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1024
1025 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1026
1027 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
1028
1029 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
1030
1031 void linphone_core_abort_authentication(LinphoneCore *lc,  LinphoneAuthInfo *info);
1032
1033 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
1034
1035 void linphone_core_enable_audio_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1036
1037 bool_t linphone_core_audio_adaptive_jittcomp_enabled(LinphoneCore *lc);
1038
1039 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
1040
1041 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
1042
1043 void linphone_core_enable_video_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1044
1045 bool_t linphone_core_video_adaptive_jittcomp_enabled(LinphoneCore *lc);
1046
1047 int linphone_core_get_video_jittcomp(LinphoneCore *lc);
1048
1049 void linphone_core_set_video_jittcomp(LinphoneCore *lc, int value);
1050
1051 int linphone_core_get_audio_port(const LinphoneCore *lc);
1052
1053 void linphone_core_get_audio_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1054
1055 int linphone_core_get_video_port(const LinphoneCore *lc);
1056
1057 void linphone_core_get_video_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1058
1059 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
1060
1061 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
1062
1063 void linphone_core_set_audio_port_range(LinphoneCore *lc, int min_port, int max_port);
1064
1065 void linphone_core_set_video_port(LinphoneCore *lc, int port);
1066
1067 void linphone_core_set_video_port_range(LinphoneCore *lc, int min_port, int max_port);
1068
1069 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
1070
1071 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
1072
1073 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
1074
1075 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
1076
1077 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
1078
1079 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
1080
1081 int linphone_core_get_sip_port(LinphoneCore *lc);
1082
1083 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
1084
1085 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
1086 /**
1087  *
1088  * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
1089  * @param lc #LinphoneCore
1090  * @return socket file descriptor
1091  */
1092 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
1093
1094 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
1095
1096 int linphone_core_get_inc_timeout(LinphoneCore *lc);
1097
1098 void linphone_core_set_in_call_timeout(LinphoneCore *lc, int seconds);
1099
1100 int linphone_core_get_in_call_timeout(LinphoneCore *lc);
1101
1102 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
1103
1104 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
1105
1106 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
1107
1108 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
1109
1110 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
1111
1112 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
1113
1114 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
1115
1116 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
1117
1118 /* sound functions */
1119 /* returns a null terminated static array of string describing the sound devices */
1120 const char**  linphone_core_get_sound_devices(LinphoneCore *lc);
1121 void linphone_core_reload_sound_devices(LinphoneCore *lc);
1122 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
1123 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
1124 int linphone_core_get_ring_level(LinphoneCore *lc);
1125 int linphone_core_get_play_level(LinphoneCore *lc);
1126 int linphone_core_get_rec_level(LinphoneCore *lc);
1127 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
1128 void linphone_core_set_play_level(LinphoneCore *lc, int level);
1129
1130 void linphone_core_set_mic_gain_db(LinphoneCore *lc, float level);
1131 float linphone_core_get_mic_gain_db(LinphoneCore *lc);
1132 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
1133 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
1134
1135 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
1136 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
1137 const char * linphone_core_get_playback_device(LinphoneCore *lc);
1138 const char * linphone_core_get_capture_device(LinphoneCore *lc);
1139 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
1140 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
1141 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
1142 char linphone_core_get_sound_source(LinphoneCore *lc);
1143 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
1144 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
1145 const char *linphone_core_get_ring(const LinphoneCore *lc);
1146 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1147 void linphone_core_verify_server_cn(LinphoneCore *lc, bool_t yesno);
1148 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1149 const char *linphone_core_get_root_ca(LinphoneCore *lc);
1150 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1151 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1152
1153 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1154 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1155
1156 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1157 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1158 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1159
1160 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1161 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1162
1163 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1164 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1165
1166 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1167 /**
1168  * return mic state.
1169  *
1170  * @ingroup media_parameters
1171 **/
1172 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1173
1174 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1175
1176 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1177 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1178
1179
1180 /* returns a list of LinphoneCallLog */
1181 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1182 void linphone_core_clear_call_logs(LinphoneCore *lc);
1183 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1184 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1185 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1186
1187 /* video support */
1188 bool_t linphone_core_video_supported(LinphoneCore *lc);
1189 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1190 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1191 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1192 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1193
1194 typedef struct MSVideoSizeDef{
1195         MSVideoSize vsize;
1196         const char *name;
1197 }MSVideoSizeDef;
1198 /* returns a zero terminated table of MSVideoSizeDef*/
1199 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1200 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1201 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1202 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1203
1204 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1205 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1206
1207 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1208 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1209
1210
1211 /* returns a null terminated static array of string describing the webcams */
1212 void linphone_core_reload_video_devices(LinphoneCore *lc);
1213 const char**  linphone_core_get_video_devices(const LinphoneCore *lc);
1214 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1215 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1216
1217 /* Set and get static picture to be used when "Static picture" is the video device */
1218 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1219 const char *linphone_core_get_static_picture(LinphoneCore *lc);
1220
1221 /* Set and get frame rate for static picture */
1222 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1223 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1224
1225 /*function to be used for eventually setting window decorations (icons, title...)*/
1226 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1227 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1228
1229 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1230 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1231
1232 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1233 int linphone_core_get_device_rotation(LinphoneCore *lc );
1234 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1235
1236 /* start or stop streaming video in case of embedded window */
1237 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1238
1239 /*play/record support: use files instead of soundcard*/
1240 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1241 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1242 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1243
1244 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1245 void linphone_core_stop_dtmf(LinphoneCore *lc);
1246
1247 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1248
1249
1250 int linphone_core_get_mtu(const LinphoneCore *lc);
1251 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1252
1253 /**
1254  * @ingroup network_parameters
1255  * This method is called by the application to notify the linphone core library when network is reachable.
1256  * Calling this method with true trigger linphone to initiate a registration process for all proxies.
1257  * Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
1258  */
1259 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1260 /**
1261  * @ingroup network_parameters
1262  * return network state either as positioned by the application or by linphone itself.
1263  */
1264 bool_t linphone_core_is_network_reachable(LinphoneCore* lc);
1265
1266 /**
1267  *  @ingroup network_parameters
1268  *  enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1269  */
1270 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1271 /**
1272  *  @ingroup network_parameters
1273  * Is signaling keep alive
1274  */
1275 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1276
1277 void *linphone_core_get_user_data(LinphoneCore *lc);
1278 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1279
1280 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1281 the config file with your own sections */
1282 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1283
1284 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1285 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1286
1287 /*returns the list of registered SipSetup (linphonecore plugins) */
1288 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1289
1290 void linphone_core_destroy(LinphoneCore *lc);
1291
1292 /*for advanced users:*/
1293 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1294 struct _LinphoneRtpTransportFactories{
1295         LinphoneRtpTransportFactoryFunc audio_rtp_func;
1296         void *audio_rtp_func_data;
1297         LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1298         void *audio_rtcp_func_data;
1299         LinphoneRtpTransportFactoryFunc video_rtp_func;
1300         void *video_rtp_func_data;
1301         LinphoneRtpTransportFactoryFunc video_rtcp_func;
1302         void *video_rtcp_func_data;
1303 };
1304 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1305
1306 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1307
1308 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1309
1310 int linphone_core_get_calls_nb(const LinphoneCore *lc);
1311
1312 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1313
1314 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1315 /**
1316  * force registration refresh to be initiated upon next iterate
1317  * @ingroup proxies
1318  */
1319 void linphone_core_refresh_registers(LinphoneCore* lc);
1320
1321 /* Path to the file storing secrets cache */
1322 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1323 const char *linphone_core_get_zrtp_secrets_file(LinphoneCore *lc);
1324
1325 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1326
1327 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1328 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1329 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1330 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1331 int linphone_core_enter_conference(LinphoneCore *lc);
1332 int linphone_core_leave_conference(LinphoneCore *lc);
1333 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1334
1335 int linphone_core_terminate_conference(LinphoneCore *lc);
1336 int linphone_core_get_conference_size(LinphoneCore *lc);
1337
1338 int linphone_core_get_max_calls(LinphoneCore *lc);
1339 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1340
1341 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1342
1343 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1344
1345 /**
1346  * Choose media encryption policy to be used for RTP packets
1347  */
1348 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1349 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1350
1351 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1352 /**
1353  * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1354  * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1355  */
1356 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1357
1358 /**
1359  * Init call params using LinphoneCore's current configuration
1360  */
1361 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1362
1363 /**
1364  * True if tunnel support was compiled.
1365  */
1366 bool_t linphone_core_tunnel_available(void);
1367
1368 typedef struct _LinphoneTunnel LinphoneTunnel;
1369 /**
1370 * get tunnel instance if available
1371 */
1372 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1373
1374 void linphone_core_set_sip_dscp(LinphoneCore *lc, int dscp);
1375 int linphone_core_get_sip_dscp(const LinphoneCore *lc);
1376
1377 void linphone_core_set_audio_dscp(LinphoneCore *lc, int dscp);
1378 int linphone_core_get_audio_dscp(const LinphoneCore *lc);
1379
1380 void linphone_core_set_video_dscp(LinphoneCore *lc, int dscp);
1381 int linphone_core_get_video_dscp(const LinphoneCore *lc);
1382
1383
1384
1385 #ifdef __cplusplus
1386 }
1387 #endif
1388
1389
1390 #endif