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