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

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