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