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