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

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