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