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