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