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