linphonecore.h 44.7 KB
Newer Older
aymeric's avatar
aymeric committed
1 2
/*
linphone
3
Copyright (C) 2000 - 2010 Simon MORLAT (simon.morlat@linphone.org)
aymeric's avatar
aymeric committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
#ifndef LINPHONECORE_H
#define LINPHONECORE_H

#include "ortp/ortp.h"
#include "ortp/payloadtype.h"
#include "mediastreamer2/mscommon.h"
smorlat's avatar
smorlat committed
25
#include "mediastreamer2/msvideo.h"
26 27

#ifdef IN_LINPHONE
smorlat's avatar
smorlat committed
28
#include "sipsetup.h"
29 30 31
#else
#include "linphone/sipsetup.h"
#endif
aymeric's avatar
aymeric committed
32

smorlat's avatar
smorlat committed
33
#define LINPHONE_IPADDR_SIZE 64
smorlat's avatar
smorlat committed
34
#define LINPHONE_HOSTNAME_SIZE 128
smorlat's avatar
smorlat committed
35

aymeric's avatar
aymeric committed
36 37 38 39 40 41
#ifdef __cplusplus
extern "C" {
#endif

struct _MSSndCard;
struct _LinphoneCore;
jehan's avatar
jehan committed
42 43 44 45 46
/**
 * Linphone core main object created by function linphone_core_new() .
 * @ingroup initializing
 */
typedef struct _LinphoneCore LinphoneCore;
47
struct SalOp;
aymeric's avatar
aymeric committed
48 49 50

struct _LpConfig;

51

52 53 54 55 56 57 58 59 60
struct _LCSipTransports{
	int udp_port;
	int tcp_port;
	int dtls_port;
	int tls_port;
};

typedef struct _LCSipTransports LCSipTransports;

smorlat's avatar
smorlat committed
61 62 63 64 65 66 67 68 69 70
/**
 * Object that represents a SIP address.
 *
 * The LinphoneAddress is an opaque object to represents SIP addresses, ie
 * the content of SIP's 'from' and 'to' headers.
 * A SIP address is made of display name, username, domain name, port, and various
 * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
 * The LinphoneAddress has methods to extract and manipulate all parts of the address.
 * When some part of the address (for example the username) is empty, the accessor methods
 * return NULL.
71
 *
smorlat's avatar
smorlat committed
72 73 74
 * @ingroup linphone_address
 * @var LinphoneAddress
 */
75
typedef struct SalAddress LinphoneAddress;
jehan's avatar
jehan committed
76 77 78 79 80
#ifdef IN_LINPHONE
#include "linphonefriend.h"
#else
#include "linphone/linphonefriend.h"
#endif
81 82 83 84 85 86 87

LinphoneAddress * linphone_address_new(const char *uri);
LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
const char *linphone_address_get_scheme(const LinphoneAddress *u);
const char *linphone_address_get_display_name(const LinphoneAddress* u);
const char *linphone_address_get_username(const LinphoneAddress *u);
const char *linphone_address_get_domain(const LinphoneAddress *u);
jehan's avatar
jehan committed
88 89 90 91 92 93 94 95 96
/**
 * Get port number as an integer value.
 *
 */
int linphone_address_get_port_int(const LinphoneAddress *u);
/**
 * Get port number, null if not present.
 */
const char* linphone_address_get_port(const LinphoneAddress *u);
97 98 99 100 101
void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
void linphone_address_set_username(LinphoneAddress *uri, const char *username);
void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
void linphone_address_set_port(LinphoneAddress *uri, const char *port);
void linphone_address_set_port_int(LinphoneAddress *uri, int port);
102
/*remove tags, params etc... so that it is displayable to the user*/
103 104 105
void linphone_address_clean(LinphoneAddress *uri);
char *linphone_address_as_string(const LinphoneAddress *u);
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);
aymeric's avatar
aymeric committed
108

smorlat's avatar
smorlat committed
109
struct _SipSetupContext;
110

aymeric's avatar
aymeric committed
111

smorlat's avatar
smorlat committed
112 113 114 115 116 117 118 119
/**
 * Enum representing the direction of a call.
 * @ingroup call_logs
**/
enum _LinphoneCallDir {
	LinphoneCallOutgoing, /**< outgoing calls*/
	LinphoneCallIncoming  /**< incoming calls*/
};
aymeric's avatar
aymeric committed
120

smorlat's avatar
smorlat committed
121 122 123 124 125
/**
 * Typedef for enum
 * @ingroup call_logs
**/
typedef enum _LinphoneCallDir LinphoneCallDir;
aymeric's avatar
aymeric committed
126

smorlat's avatar
smorlat committed
127 128 129 130
/**
 * Enum representing the status of a call
 * @ingroup call_logs
**/
131
typedef enum _LinphoneCallStatus {
smorlat's avatar
smorlat committed
132 133
	LinphoneCallSuccess, /**< The call was sucessful*/
	LinphoneCallAborted, /**< The call was aborted */
134 135
	LinphoneCallMissed, /**< The call was missed (unanswered)*/
	LinphoneCallDeclined /**< The call was declined, either locally or by remote end*/
aymeric's avatar
aymeric committed
136 137
} LinphoneCallStatus;

smorlat's avatar
smorlat committed
138 139 140 141
/**
 * Structure representing a call log.
 *
 * @ingroup call_logs
142
 *
smorlat's avatar
smorlat committed
143
**/
aymeric's avatar
aymeric committed
144
typedef struct _LinphoneCallLog{
smorlat's avatar
smorlat committed
145 146 147 148 149 150
	LinphoneCallDir dir; /**< The direction of the call*/
	LinphoneCallStatus status; /**< The status of the call*/
	LinphoneAddress *from; /**<Originator of the call as a LinphoneAddress object*/
	LinphoneAddress *to; /**<Destination of the call as a LinphoneAddress object*/
	char start_date[128]; /**<Human readable string containg the start date*/
	int duration; /**<Duration of the call in seconds*/
151
	char *refkey;
smorlat's avatar
smorlat committed
152
	void *user_pointer;
153 154
	rtp_stats_t local_stats;
	rtp_stats_t remote_stats;
155
	float quality;
156
	struct _LinphoneCore *lc;
aymeric's avatar
aymeric committed
157 158
} LinphoneCallLog;

159 160 161 162 163
enum LinphoneMediaEncryption {
	LinphoneMediaEncryptionNone,
	LinphoneMediaEncryptionSRTP,
	LinphoneMediaEncryptionZRTP
};
smorlat's avatar
smorlat committed
164

165
typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
aymeric's avatar
aymeric committed
166 167

/*public: */
smorlat's avatar
smorlat committed
168 169
void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
170 171
void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
172 173
const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
aymeric's avatar
aymeric committed
174 175
char * linphone_call_log_to_str(LinphoneCallLog *cl);

176

177
/**
Guillaume Beraudo's avatar
Typo  
Guillaume Beraudo committed
178
 * The LinphoneCallParams is an object containing various call related parameters.
179
 * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
180 181 182 183 184
 * dynamically.
**/
struct _LinphoneCallParams;
typedef struct _LinphoneCallParams LinphoneCallParams;

185
LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
186
void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
187
bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
Simon Morlat's avatar
Simon Morlat committed
188 189
LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
190 191
void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
Simon Morlat's avatar
Simon Morlat committed
192
bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
193
void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
194 195
void linphone_call_params_destroy(LinphoneCallParams *cp);

Simon Morlat's avatar
Simon Morlat committed
196 197
/**
 * Enum describing failure reasons.
Simon Morlat's avatar
Simon Morlat committed
198
 * @ingroup initializing
Simon Morlat's avatar
Simon Morlat committed
199
**/
200 201 202 203 204
enum _LinphoneReason{
	LinphoneReasonNone,
	LinphoneReasonNoResponse, /**<No response received from remote*/
	LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
	LinphoneReasonDeclined, /**<The call has been declined*/
205
	LinphoneReasonNotFound,
Simon Morlat's avatar
Simon Morlat committed
206 207
};

208
typedef enum _LinphoneReason LinphoneReason;
Simon Morlat's avatar
Simon Morlat committed
209

210
const char *linphone_reason_to_string(LinphoneReason err);
Simon Morlat's avatar
Simon Morlat committed
211

212 213 214 215 216 217
/**
 * The LinphoneCall object represents a call issued or received by the LinphoneCore
**/
struct _LinphoneCall;
typedef struct _LinphoneCall LinphoneCall;

Simon Morlat's avatar
Simon Morlat committed
218 219 220 221 222
/**
 * LinphoneCallState enum represents the different state a call can reach into.
 * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
 * @ingroup call_control
**/
223
typedef enum _LinphoneCallState{
Simon Morlat's avatar
Simon Morlat committed
224
	LinphoneCallIdle,					/**<Initial call state */
225 226 227 228 229 230 231 232 233 234 235 236 237 238
	LinphoneCallIncomingReceived, /**<This is a new incoming call */
	LinphoneCallOutgoingInit, /**<An outgoing call is started */
	LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
	LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
	LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
	LinphoneCallConnected, /**<Connected, the call is answered */
	LinphoneCallStreamsRunning, /**<The media streams are established and running*/
	LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
	LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
	LinphoneCallResuming, /**<The call is being resumed by local end*/
	LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
	LinphoneCallError, /**<The call encountered an error*/
	LinphoneCallEnd, /**<The call ended normally*/
	LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
239
	LinphoneCallUpdatedByRemote, /**<The call's parameters are updated, used for example when video is asked by remote */
240
	LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
241 242
	LinphoneCallUpdated, /**<The remote accepted the call update initiated by us */
	LinphoneCallReleased /**< The call object is no more retained by the core */
243 244
} LinphoneCallState;

245
const char *linphone_call_state_to_string(LinphoneCallState cs);
246

247
LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
248
LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
249 250 251 252
bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
Simon Morlat's avatar
Simon Morlat committed
253
LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
254
LinphoneCall * linphone_call_ref(LinphoneCall *call);
255 256
void linphone_call_unref(LinphoneCall *call);
LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
Simon Morlat's avatar
Simon Morlat committed
257
const char *linphone_call_get_refer_to(const LinphoneCall *call);
258
bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
259
LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
260
int linphone_call_get_duration(const LinphoneCall *call);
261
const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
Simon Morlat's avatar
Simon Morlat committed
262 263
void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
264
int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
265
LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
266
const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
Simon Morlat's avatar
Simon Morlat committed
267 268
float linphone_call_get_play_volume(LinphoneCall *call);
float linphone_call_get_record_volume(LinphoneCall *call);
269 270
float linphone_call_get_current_quality(LinphoneCall *call);
float linphone_call_get_average_quality(LinphoneCall *call);
Simon Morlat's avatar
Simon Morlat committed
271 272
const char* linphone_call_get_authentication_token(LinphoneCall *call);
bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
Simon Morlat's avatar
Simon Morlat committed
273
void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
Simon Morlat's avatar
Simon Morlat committed
274
void linphone_call_send_vfu_request(LinphoneCall *call);
Simon Morlat's avatar
Simon Morlat committed
275 276
void *linphone_call_get_user_pointer(LinphoneCall *call);
void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
jehan's avatar
jehan committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
/**
 * Enables or disable echo cancellation for this call
 * @param call
 * @param val
 *
 * @ingroup media_parameters
**/
void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
/**
 * Returns TRUE if echo cancellation is enabled.
 *
 * @ingroup media_parameters
**/
bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
/**
 * Enables or disable echo limiter for this call
 * @param call
 * @param val
 *
 * @ingroup media_parameters
**/
void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
/**
 * Returns TRUE if echo limiter is enabled.
 *
 * @ingroup media_parameters
**/
bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
Simon Morlat's avatar
Simon Morlat committed
305 306 307 308

/*keep this in sync with mediastreamer2/msvolume.h*/
#define LINPHONE_VOLUME_DB_LOWEST (-120) /**< Lowest measured that can be returned.*/

smorlat's avatar
smorlat committed
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
/**
 * @addtogroup proxies
 * @{
**/
/**
 * The LinphoneProxyConfig object represents a proxy configuration to be used
 * by the LinphoneCore object.
 * Its fields must not be used directly in favour of the accessors methods.
 * Once created and filled properly the LinphoneProxyConfig can be given to
 * LinphoneCore with linphone_core_add_proxy_config().
 * This will automatically triggers the registration, if enabled.
 *
 * The proxy configuration are persistent to restarts because they are saved
 * in the configuration file. As a consequence, after linphone_core_new() there
 * might already be a list of configured proxy that can be examined with
 * linphone_core_get_proxy_config_list().
 *
 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
 * that is used by default for calls.
**/
329
typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
aymeric's avatar
aymeric committed
330

331 332 333 334
/**
 * LinphoneRegistrationState describes proxy registration states.
**/
typedef enum _LinphoneRegistrationState{
Simon Morlat's avatar
Simon Morlat committed
335 336 337 338 339
	LinphoneRegistrationNone, /**<Initial state for registrations */
	LinphoneRegistrationProgress, /**<Registration is in progress */
	LinphoneRegistrationOk,	/**< Registration is successful */
	LinphoneRegistrationCleared, /**< Unregistration succeeded */
	LinphoneRegistrationFailed	/**<Registration failed */
340 341
}LinphoneRegistrationState;

jehan's avatar
jehan committed
342 343 344 345
/**
 * Human readable version of the #LinphoneRegistrationState
 * @param cs sate
 */
346 347
const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);

aymeric's avatar
aymeric committed
348 349
LinphoneProxyConfig *linphone_proxy_config_new(void);
int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
350 351
int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
Simon Morlat's avatar
Simon Morlat committed
352
void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
jehan's avatar
jehan committed
353 354 355 356 357 358
/**
 * Indicates  either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
 * @param obj object pointer
 * @param val if true, registration will be engaged
 */
aymeric's avatar
aymeric committed
359 360 361 362
void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
#define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
int linphone_proxy_config_done(LinphoneProxyConfig *obj);
jehan's avatar
jehan committed
363 364 365 366 367 368 369
/**
 * Indicates  either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
 * @param obj object pointer
 * @param val if true, publish will be engaged
 *
 */
aymeric's avatar
aymeric committed
370
void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
371 372 373
void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);

374
LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
smorlat's avatar
smorlat committed
375
bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
smorlat's avatar
smorlat committed
376
const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
377 378 379 380 381 382 383

const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
384
void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
385 386
struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);

387 388 389
bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);

390
LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
Simon Morlat's avatar
Simon Morlat committed
391

aymeric's avatar
aymeric committed
392 393
/* destruction is called automatically when removing the proxy config */
void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
smorlat's avatar
smorlat committed
394 395
void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
396
SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
397 398 399 400
/**
 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
 */
int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
jehan's avatar
jehan committed
401 402 403 404 405 406 407 408
/*
 *  attached a user data to a proxy config
 */
void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
/*
 *  get user data to a proxy config. return null if any
 */
void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
smorlat's avatar
smorlat committed
409

smorlat's avatar
smorlat committed
410 411 412 413
/**
 * @}
**/

smorlat's avatar
smorlat committed
414 415 416 417 418 419 420 421 422
typedef struct _LinphoneAccountCreator{
	struct _LinphoneCore *lc;
	struct _SipSetupContext *ssctx;
	char *username;
	char *password;
	char *domain;
	bool_t succeeded;
}LinphoneAccountCreator;

423
LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
smorlat's avatar
smorlat committed
424 425 426
void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
smorlat's avatar
smorlat committed
427 428
const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
429
int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
smorlat's avatar
smorlat committed
430 431 432
LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
void linphone_account_creator_destroy(LinphoneAccountCreator *obj);

433 434
struct _LinphoneAuthInfo;

smorlat's avatar
smorlat committed
435 436 437 438 439 440 441 442 443 444 445 446
/**
 * @ingroup authentication
 * Object holding authentication information.
 *
 * @note The object's fields should not be accessed directly. Prefer using
 * the accessor methods.
 *
 * In most case, authentication information consists of a username and password.
 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
 * different SIP domains.
 *
 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
447
 * order to become known and used automatically when needed.
smorlat's avatar
smorlat committed
448 449 450 451 452 453
 * Use linphone_core_add_auth_info() for that purpose.
 *
 * The LinphoneCore object can take the initiative to request authentication information
 * when needed to the application through the auth_info_requested callback of the
 * LinphoneCoreVTable structure.
 *
454 455
 * The application can respond to this information request later using
 * linphone_core_add_auth_info(). This will unblock all pending authentication
smorlat's avatar
smorlat committed
456 457 458
 * transactions and retry them with authentication headers.
 *
**/
459
typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
aymeric's avatar
aymeric committed
460 461 462 463

LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
		const char *passwd, const char *ha1,const char *realm);
void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
smorlat's avatar
smorlat committed
464
void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
465
void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
466 467 468 469 470

const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);

aymeric's avatar
aymeric committed
471 472 473 474
/* you don't need those function*/
void linphone_auth_info_destroy(LinphoneAuthInfo *info);
LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);

jehan's avatar
jehan committed
475

476
struct _LinphoneChatRoom;
jehan's avatar
jehan committed
477 478 479 480 481 482 483 484
/**
 * @addtogroup chatroom
 * @{
 */
/**
 * A chat room is the place where text messages are exchanged.
 * <br> Can be created by linphone_core_create_chat_room().
 */
aymeric's avatar
aymeric committed
485
typedef struct _LinphoneChatRoom LinphoneChatRoom;
jehan's avatar
jehan committed
486 487 488 489 490 491 492 493 494 495 496 497 498
/**
 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
 * @param lc #LinphoneCore object
 * @param to destination address for messages
 * @return #LinphoneChatRoom where messaging can take place.
 */
LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
/**
 * Destructor
 * @param cr #LinphoneChatRoom object
 */
void linphone_chat_room_destroy(LinphoneChatRoom *cr);

aymeric's avatar
aymeric committed
499

jehan's avatar
jehan committed
500 501 502 503 504 505 506 507 508 509 510
/**
 * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
 * @param cr #LinphoneChatRoom object
 * @return #LinphoneAddress peer address
 */
const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
/**
 * send a message to peer member of this chat room.
 * @param cr #LinphoneChatRoom object
 * @param msg message to be sent
 */
aymeric's avatar
aymeric committed
511
void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
jehan's avatar
jehan committed
512

aymeric's avatar
aymeric committed
513 514 515
void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);

jehan's avatar
jehan committed
516 517 518
/**
 * @}
 */
Simon Morlat's avatar
Simon Morlat committed
519 520 521 522 523 524 525 526 527 528 529


/**
 * @addtogroup initializing
 * @{
**/

/**
 * LinphoneGlobalState describes the global state of the LinphoneCore object.
 * It is notified via the LinphoneCoreVTable::global_state_changed
**/
530 531 532 533 534 535 536
typedef enum _LinphoneGlobalState{
	LinphoneGlobalOff,
	LinphoneGlobalStartup,
	LinphoneGlobalOn,
	LinphoneGlobalShutdown
}LinphoneGlobalState;

537
const char *linphone_global_state_to_string(LinphoneGlobalState gs);
aymeric's avatar
aymeric committed
538

539 540 541 542 543

/**Call state notification callback prototype*/
typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
/**Call state notification callback prototype*/
typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
544 545 546
/**Call encryption changed callback prototype*/
typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);

jehan's avatar
jehan committed
547 548 549
/** @ingroup Proxies
 * Registration state notification callback prototype
 * */
jehan's avatar
jehan committed
550
typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
smorlat's avatar
smorlat committed
551
/** Callback prototype */
aymeric's avatar
aymeric committed
552
typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
smorlat's avatar
smorlat committed
553
/** Callback prototype */
aymeric's avatar
aymeric committed
554
typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
smorlat's avatar
smorlat committed
555
/** Callback prototype */
aymeric's avatar
aymeric committed
556
typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
smorlat's avatar
smorlat committed
557
/** Callback prototype */
aymeric's avatar
aymeric committed
558
typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
smorlat's avatar
smorlat committed
559
/** Callback prototype */
aymeric's avatar
aymeric committed
560
typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
smorlat's avatar
smorlat committed
561
/** Callback prototype */
562
typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
jehan's avatar
jehan committed
563 564 565
/**
 * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
 * @param lc #LinphoneCore object .
jehan's avatar
jehan committed
566 567 568 569 570 571 572 573 574 575 576 577
 * @param lf Updated #LinphoneFriend .
 */
typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
/**
 *  Reports that a new subscription request has been received and wait for a decision.
 *  <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
 *	@param lc #LinphoneCore object
 *	@param lf #LinphoneFriend corresponding to the subscriber
 *	@param url of the subscriber
 *  Callback prototype
 *  */
typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
smorlat's avatar
smorlat committed
578
/** Callback prototype */
aymeric's avatar
aymeric committed
579
typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
smorlat's avatar
smorlat committed
580
/** Callback prototype */
aymeric's avatar
aymeric committed
581
typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
jehan's avatar
jehan committed
582 583 584 585 586 587 588 589 590
/**
 * Callback prototype
 *
 * @param lc #LinphoneCore object
 * @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.
 * @param from #LinphoneAddress from
 * @param message incoming message
 *  */
typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
smorlat's avatar
smorlat committed
591
/** Callback prototype */
592
typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
smorlat's avatar
smorlat committed
593
/** Callback prototype */
594
typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
smorlat's avatar
smorlat committed
595
/** Callback prototype */
596
typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
aymeric's avatar
aymeric committed
597

smorlat's avatar
smorlat committed
598 599
/**
 * This structure holds all callbacks that the application should implement.
600
 *  None is mandatory.
smorlat's avatar
smorlat committed
601
**/
602 603 604 605
typedef struct _LinphoneVTable{
	LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
	LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
	LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
606
	NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
jehan's avatar
jehan committed
607
	NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
smorlat's avatar
smorlat committed
608 609 610 611
	AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
	CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
	TextMessageReceived text_received; /**< A text message has been received */
	DtmfReceived dtmf_received; /**< A dtmf has been received received */
Simon Morlat's avatar
Simon Morlat committed
612
	ReferReceived refer_received; /**< An out of call refer was received */
smorlat's avatar
smorlat committed
613
	BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
614
	NotifyReceivedCb notify_recv; /**< Other notifications*/
Simon Morlat's avatar
Simon Morlat committed
615 616 617 618 619
	DisplayStatusCb display_status; /**< Callback that notifies various events with human readable text.*/
	DisplayMessageCb display_message;/**< Callback to display a message to the user */
	DisplayMessageCb display_warning;/** Callback to display a warning to the user */
	DisplayUrlCb display_url;
	ShowInterfaceCb show; /**< Notifies the application that it should show up*/
620
	CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
aymeric's avatar
aymeric committed
621 622
} LinphoneCoreVTable;

smorlat's avatar
smorlat committed
623 624 625 626
/**
 * @}
**/

aymeric's avatar
aymeric committed
627 628 629 630 631 632 633 634 635
typedef struct _LCCallbackObj
{
  LinphoneCoreCbFunc _func;
  void * _user_data;
}LCCallbackObj;



typedef enum _LinphoneFirewallPolicy{
636 637 638
	LinphonePolicyNoFirewall,
	LinphonePolicyUseNatAddress,
	LinphonePolicyUseStun
aymeric's avatar
aymeric committed
639 640
} LinphoneFirewallPolicy;

smorlat's avatar
smorlat committed
641 642 643 644 645 646
typedef enum _LinphoneWaitingState{
	LinphoneWaitingStart,
	LinphoneWaitingProgress,
	LinphoneWaitingFinished
} LinphoneWaitingState;
typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
jehan's avatar
jehan committed
647

aymeric's avatar
aymeric committed
648 649 650 651 652 653

/* THE main API */

void linphone_core_enable_logs(FILE *file);
void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
void linphone_core_disable_logs(void);
smorlat's avatar
smorlat committed
654 655
/*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
void linphone_core_set_user_agent(const char *ua_name, const char *version);
aymeric's avatar
aymeric committed
656 657 658
const char *linphone_core_get_version(void);

LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
659
						const char *config_path, const char *factory_config, void* userdata);
aymeric's avatar
aymeric committed
660 661 662 663

/* function to be periodically called in a main loop */
void linphone_core_iterate(LinphoneCore *lc);

664 665
LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);

666
LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
aymeric's avatar
aymeric committed
667

668
LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
669

670 671 672 673
LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);

LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);

674
int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
aymeric's avatar
aymeric committed
675

676 677
int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);

aymeric's avatar
aymeric committed
678 679 680 681
bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);

bool_t linphone_core_in_call(const LinphoneCore *lc);

682
LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
683

684 685 686
int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);

int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
687

688 689
int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);

690
int linphone_core_terminate_all_calls(LinphoneCore *lc);
aymeric's avatar
aymeric committed
691

692 693
int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);

Simon Morlat's avatar
Simon Morlat committed
694 695
int linphone_core_pause_all_calls(LinphoneCore *lc);

696
int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
aymeric's avatar
aymeric committed
697

698
int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
699 700 701

LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);

702
LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
aymeric's avatar
aymeric committed
703 704 705 706 707 708 709

void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);

int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);

const char *linphone_core_get_primary_contact(LinphoneCore *lc);

710 711
const char * linphone_core_get_identity(LinphoneCore *lc);

aymeric's avatar
aymeric committed
712 713 714 715 716 717
void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);

bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);

718
LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
jehan's avatar
jehan committed
719
const char * linphone_core_get_identity(LinphoneCore *lc);
aymeric's avatar
aymeric committed
720 721 722 723 724 725
/*0= no bandwidth limit*/
void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);

int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
726 727 728

void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
jehan's avatar
jehan committed
729
/**
730
 * set audio packetization time linphone expect to receive from peer
jehan's avatar
jehan committed
731 732 733 734 735
 * @ingroup media_parameters
 *
 */
void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
/**
736
 * get audio packetization time linphone expect to receive from peer, 0 means unspecified
jehan's avatar
jehan committed
737 738 739
 * @ingroup media_parameters
 */
int  linphone_core_get_download_ptime(LinphoneCore *lc);
aymeric's avatar
aymeric committed
740

Simon Morlat's avatar
Simon Morlat committed
741 742 743 744
void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);

int linphone_core_get_upload_ptime(LinphoneCore *lc);

aymeric's avatar
aymeric committed
745 746 747 748 749 750 751 752 753
/* returns a MSList of PayloadType */
const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);

int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
/* returns a MSList of PayloadType */
const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);

int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);

754 755 756 757
bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, PayloadType *pt);

int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);

jehan's avatar
jehan committed
758 759
PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate) ;

760 761
const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);

aymeric's avatar
aymeric committed
762 763 764 765
bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);

int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);

smorlat's avatar
smorlat committed
766 767
void linphone_core_clear_proxy_config(LinphoneCore *lc);

aymeric's avatar
aymeric committed
768 769 770 771 772 773 774 775 776 777
void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);

const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);

void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);

void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);

int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);

778
void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
aymeric's avatar
aymeric committed
779

780
void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
aymeric's avatar
aymeric committed
781

smorlat's avatar
smorlat committed
782 783
const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);

784
const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
smorlat's avatar
smorlat committed
785

aymeric's avatar
aymeric committed
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
void linphone_core_abort_authentication(LinphoneCore *lc,  LinphoneAuthInfo *info);

void linphone_core_clear_all_auth_info(LinphoneCore *lc);

int linphone_core_get_audio_jittcomp(LinphoneCore *lc);

void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);

int linphone_core_get_audio_port(const LinphoneCore *lc);

int linphone_core_get_video_port(const LinphoneCore *lc);

int linphone_core_get_nortp_timeout(const LinphoneCore *lc);

void linphone_core_set_audio_port(LinphoneCore *lc, int port);

void linphone_core_set_video_port(LinphoneCore *lc, int port);

void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);

void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);

bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);

810 811 812 813
void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);

bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);

814 815
void linphone_core_set_sip_port(LinphoneCore *lc, int port);

aymeric's avatar
aymeric committed
816 817
int linphone_core_get_sip_port(LinphoneCore *lc);

818 819 820
int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);

int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
jehan's avatar
jehan committed
821
/**
822
 *
jehan's avatar
jehan committed
823 824 825 826
 * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
 * @param lc #LinphoneCore
 * @return socket file descriptor
 */
827 828
ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);

aymeric's avatar
aymeric committed
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);

int linphone_core_get_inc_timeout(LinphoneCore *lc);

void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);

const char * linphone_core_get_stun_server(const LinphoneCore *lc);

void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);

const char *linphone_core_get_nat_address(const LinphoneCore *lc);

void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);

LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);

const char * linphone_core_get_relay_addr(const LinphoneCore *lc);

int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);

/* sound functions */
850
/* returns a null terminated static array of string describing the sound devices */
aymeric's avatar
aymeric committed
851
const char**  linphone_core_get_sound_devices(LinphoneCore *lc);
smorlat's avatar
smorlat committed
852 853
bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
aymeric's avatar
aymeric committed
854 855 856 857 858
int linphone_core_get_ring_level(LinphoneCore *lc);
int linphone_core_get_play_level(LinphoneCore *lc);
int linphone_core_get_rec_level(LinphoneCore *lc);
void linphone_core_set_ring_level(LinphoneCore *lc, int level);
void linphone_core_set_play_level(LinphoneCore *lc, int level);
859 860 861 862

void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);

float linphone_core_get_playback_gain_db(LinphoneCore *lc);
aymeric's avatar
aymeric committed
863 864 865 866 867 868 869 870 871 872
void linphone_core_set_rec_level(LinphoneCore *lc, int level);
const char * linphone_core_get_ringer_device(LinphoneCore *lc);
const char * linphone_core_get_playback_device(LinphoneCore *lc);
const char * linphone_core_get_capture_device(LinphoneCore *lc);
int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
char linphone_core_get_sound_source(LinphoneCore *lc);
void linphone_core_set_sound_source(LinphoneCore *lc, char source);
void linphone_core_set_ring(LinphoneCore *lc, const char *path);
873
const char *linphone_core_get_ring(const LinphoneCore *lc);
874
void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
875
void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
876 877
void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
const char * linphone_core_get_ringback(const LinphoneCore *lc);
878

879 880
void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
881

aymeric's avatar
aymeric committed
882
int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
883 884
void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
aymeric's avatar
aymeric committed
885

smorlat's avatar
smorlat committed
886 887 888
void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);

889 890 891
void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
bool_t linphone_core_agc_enabled(const LinphoneCore *lc);

smorlat's avatar
smorlat committed
892
void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
jehan's avatar
jehan committed
893 894 895 896 897 898
/**
 * return mic state.
 *
 * @ingroup media_parameters
**/
bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
smorlat's avatar
smorlat committed
899

Simon Morlat's avatar
Simon Morlat committed
900 901 902 903 904 905
bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);

bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);

aymeric's avatar
aymeric committed
906 907

/* returns a list of LinphoneCallLog */
smorlat's avatar
smorlat committed
908
const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
909
void linphone_core_clear_call_logs(LinphoneCore *lc);
aymeric's avatar
aymeric committed
910 911 912 913 914

/* video support */
void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
bool_t linphone_core_video_enabled(LinphoneCore *lc);

smorlat's avatar
smorlat committed
915 916 917 918 919 920 921 922 923
typedef struct MSVideoSizeDef{
	MSVideoSize vsize;
	const char *name;
}MSVideoSizeDef;
/* returns a zero terminated table of MSVideoSizeDef*/
const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
aymeric's avatar
aymeric committed
924 925 926 927

void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);

smorlat's avatar
smorlat committed
928 929
void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
aymeric's avatar
aymeric committed
930 931


932
/* returns a null terminated static array of string describing the webcams */
aymeric's avatar
aymeric committed
933 934 935 936
const char**  linphone_core_get_video_devices(const LinphoneCore *lc);
int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
const char *linphone_core_get_video_device(const LinphoneCore *lc);

937 938 939
/* Set static picture to be used when "Static picture" is the video device */
int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);

940 941 942 943
/* Set and get frame rate for static picture */
int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
float linphone_core_get_static_picture_fps(LinphoneCore *lc);

944 945
/*function to be used for eventually setting window decorations (icons, title...)*/
unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
946
void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
smorlat's avatar
smorlat committed
947

948 949 950 951
unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);

void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
jehan's avatar
jehan committed
952
int linphone_core_get_device_rotation(LinphoneCore *lc );
953
void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
smorlat's avatar
smorlat committed
954

955 956 957
/* start or stop streaming video in case of embedded window */
void linphone_core_show_video(LinphoneCore *lc, bool_t show);

smorlat's avatar
smorlat committed
958 959 960 961 962
/*play/record support: use files instead of soundcard*/
void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
void linphone_core_set_record_file(LinphoneCore *lc, const char *file);

Guillaume Beraudo's avatar
Guillaume Beraudo committed
963
void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
964 965
void linphone_core_stop_dtmf(LinphoneCore *lc);

smorlat's avatar
smorlat committed
966
int linphone_core_get_current_call_duration(const LinphoneCore *lc);
jehan's avatar
jehan committed
967

smorlat's avatar
smorlat committed
968

aymeric's avatar
aymeric committed
969 970
int linphone_core_get_mtu(const LinphoneCore *lc);
void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
jehan's avatar
jehan committed
971

972
/**
jehan's avatar
jehan committed
973
 * @ingroup network_parameters
974 975
 * This method is called by the application to notify the linphone core library when network is reachable.
 * Calling this method with true trigger linphone to initiate a registration process for all proxy
jehan's avatar
jehan committed
976 977
 * configuration with parameter register set to enable.
 * This method disable the automatic registration mode. It means you must call this method after each network state changes
978 979 980
 *
 */
void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
981
/**
jehan's avatar
jehan committed
982
 * @ingroup network_parameters
983 984 985
 * return network state either as positioned by the application or by linphone
 */
bool_t linphone_core_is_network_reachabled(LinphoneCore* lc);
986

jehan's avatar
jehan committed
987
/**
jehan's avatar
jehan committed
988
 *  @ingroup network_parameters
jehan's avatar
jehan committed
989 990 991 992
 *  enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
 */
void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
/**
jehan's avatar
jehan committed
993
 *  @ingroup network_parameters