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