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