]> sjero.net Git - linphone/blob - coreapi/linphonecore.h
linphone_call_log_video_enabled, update MS2 to fix IOS display orientation for Linph...
[linphone] / 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 _LinphoneCore;
41 /**
42  * Linphone core main object created by function linphone_core_new() .
43  * @ingroup initializing
44  */
45 typedef struct _LinphoneCore LinphoneCore;
46
47 struct _LpConfig;
48
49
50 struct _LCSipTransports{
51         int udp_port;
52         int tcp_port;
53         int dtls_port;
54         int tls_port;
55 };
56
57 typedef struct _LCSipTransports LCSipTransports;
58
59 /**
60  * Object that represents a SIP address.
61  *
62  * The LinphoneAddress is an opaque object to represents SIP addresses, ie
63  * the content of SIP's 'from' and 'to' headers.
64  * A SIP address is made of display name, username, domain name, port, and various
65  * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
66  * The LinphoneAddress has methods to extract and manipulate all parts of the address.
67  * When some part of the address (for example the username) is empty, the accessor methods
68  * return NULL.
69  *
70  * @ingroup linphone_address
71  * @var LinphoneAddress
72  */
73 typedef struct SalAddress LinphoneAddress;
74 #ifdef IN_LINPHONE
75 #include "linphonefriend.h"
76 #else
77 #include "linphone/linphonefriend.h"
78 #endif
79
80 LinphoneAddress * linphone_address_new(const char *uri);
81 LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
82 const char *linphone_address_get_scheme(const LinphoneAddress *u);
83 const char *linphone_address_get_display_name(const LinphoneAddress* u);
84 const char *linphone_address_get_username(const LinphoneAddress *u);
85 const char *linphone_address_get_domain(const LinphoneAddress *u);
86 /**
87  * Get port number as an integer value.
88  *
89  */
90 int linphone_address_get_port_int(const LinphoneAddress *u);
91 /**
92  * Get port number, null if not present.
93  */
94 const char* linphone_address_get_port(const LinphoneAddress *u);
95 void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
96 void linphone_address_set_username(LinphoneAddress *uri, const char *username);
97 void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
98 void linphone_address_set_port(LinphoneAddress *uri, const char *port);
99 void linphone_address_set_port_int(LinphoneAddress *uri, int port);
100 /*remove tags, params etc... so that it is displayable to the user*/
101 void linphone_address_clean(LinphoneAddress *uri);
102 char *linphone_address_as_string(const LinphoneAddress *u);
103 char *linphone_address_as_string_uri_only(const LinphoneAddress *u);
104 bool_t linphone_address_weak_equal(const LinphoneAddress *a1, const LinphoneAddress *a2);
105 void linphone_address_destroy(LinphoneAddress *u);
106
107 struct _SipSetupContext;
108
109
110 /**
111  * Enum representing the direction of a call.
112  * @ingroup call_logs
113 **/
114 enum _LinphoneCallDir {
115         LinphoneCallOutgoing, /**< outgoing calls*/
116         LinphoneCallIncoming  /**< incoming calls*/
117 };
118
119 /**
120  * Typedef for enum
121  * @ingroup call_logs
122 **/
123 typedef enum _LinphoneCallDir LinphoneCallDir;
124
125 /**
126  * Enum representing the status of a call
127  * @ingroup call_logs
128 **/
129 typedef enum _LinphoneCallStatus {
130         LinphoneCallSuccess, /**< The call was sucessful*/
131         LinphoneCallAborted, /**< The call was aborted */
132         LinphoneCallMissed, /**< The call was missed (unanswered)*/
133         LinphoneCallDeclined /**< The call was declined, either locally or by remote end*/
134 } LinphoneCallStatus;
135
136 /**
137  * Structure representing a call log.
138  *
139  * @ingroup call_logs
140  *
141 **/
142 typedef struct _LinphoneCallLog LinphoneCallLog;
143
144 /**
145  * Enum describing type of media encryption types.
146 **/
147 enum LinphoneMediaEncryption {
148         LinphoneMediaEncryptionNone,
149         LinphoneMediaEncryptionSRTP,
150         LinphoneMediaEncryptionZRTP
151 };
152
153 /**
154  * Enum describing type of media encryption types.
155 **/
156 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
157
158 /*public: */
159 LinphoneAddress *linphone_call_log_get_from(LinphoneCallLog *cl);
160 LinphoneAddress *linphone_call_log_get_to(LinphoneCallLog *cl);
161 LinphoneAddress *linphone_call_log_get_remote_address(LinphoneCallLog *cl);
162 LinphoneCallDir linphone_call_log_get_dir(LinphoneCallLog *cl);
163 LinphoneCallStatus linphone_call_log_get_status(LinphoneCallLog *cl);
164 LinphoneCallStatus linphone_call_log_video_enabled(LinphoneCallLog *cl);
165 time_t linphone_call_log_get_start_date(LinphoneCallLog *cl);
166 int linphone_call_log_get_duration(LinphoneCallLog *cl);
167 float linphone_call_log_get_quality(LinphoneCallLog *cl);
168 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
169 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
170 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
171 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
172 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
173 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
174 const char *linphone_call_log_get_call_id(const LinphoneCallLog *cl);
175 char * linphone_call_log_to_str(LinphoneCallLog *cl);
176
177 struct _LinphoneCallParams;
178
179 /**
180  * The LinphoneCallParams is an object containing various call related parameters.
181  * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
182  * dynamically.
183 **/
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 bool_t linphone_call_params_low_bandwidth_enabled(const LinphoneCallParams *cp);
199 void linphone_call_params_enable_low_bandwidth(LinphoneCallParams *cp, bool_t enabled);
200 void linphone_call_params_set_record_file(LinphoneCallParams *cp, const char *path);
201 const char *linphone_call_params_get_record_file(const LinphoneCallParams *cp);
202 void linphone_call_params_add_custom_header(LinphoneCallParams *params, const char *header_name, const char *header_value);
203 const char *linphone_call_params_get_custom_header(const LinphoneCallParams *params, const char *header_name);
204 /**
205  * Enum describing failure reasons.
206  * @ingroup initializing
207 **/
208 enum _LinphoneReason{
209         LinphoneReasonNone,
210         LinphoneReasonNoResponse, /**<No response received from remote*/
211         LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
212         LinphoneReasonDeclined, /**<The call has been declined*/
213         LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
214         LinphoneReasonNotAnswered, /**<The call was not answered in time*/
215         LinphoneReasonBusy /**<Phone line was busy */
216 };
217
218 /**
219  * Enum describing failure reasons.
220  * @ingroup initializing
221 **/
222 typedef enum _LinphoneReason LinphoneReason;
223
224 const char *linphone_reason_to_string(LinphoneReason err);
225
226 /**
227  * Structure describing policy regarding video streams establishments.
228  * @ingroup media_parameters
229 **/
230 struct _LinphoneVideoPolicy{
231         bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/ 
232         bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
233         bool_t unused[2];
234 };
235
236 /**
237  * Structure describing policy regarding video streams establishments.
238  * @ingroup media_parameters
239 **/
240 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
241
242 /**
243  * The LinphoneCall object represents a call issued or received by the LinphoneCore
244  * @ingroup call_control
245 **/
246 struct _LinphoneCall;
247 /**
248  * The LinphoneCall object represents a call issued or received by the LinphoneCore
249  * @ingroup call_control
250 **/
251 typedef struct _LinphoneCall LinphoneCall;
252
253
254 /**
255  * @addtogroup call_misc
256  * @{
257 **/
258
259 #define LINPHONE_CALL_STATS_AUDIO 0
260 #define LINPHONE_CALL_STATS_VIDEO 1
261
262 /**
263  * Enum describing ICE states.
264  * @ingroup initializing
265 **/
266 enum _LinphoneIceState{
267         LinphoneIceStateNotActivated, /**< ICE has not been activated for this call */
268         LinphoneIceStateFailed, /**< ICE processing has failed */
269         LinphoneIceStateInProgress, /**< ICE process is in progress */
270         LinphoneIceStateHostConnection, /**< ICE has established a direct connection to the remote host */
271         LinphoneIceStateReflexiveConnection, /**< ICE has established a connection to the remote host through one or several NATs */
272         LinphoneIceStateRelayConnection /**< ICE has established a connection through a relay */
273 };
274
275 /**
276  * Enum describing Ice states.
277  * @ingroup initializing
278 **/
279 typedef enum _LinphoneIceState LinphoneIceState;
280
281 /**
282  * Enum describing uPnP states.
283  * @ingroup initializing
284 **/
285 enum _LinphoneUpnpState{
286         LinphoneUpnpStateIdle, /**< uPnP is not activate */
287         LinphoneUpnpStatePending, /**< uPnP process is in progress */
288         LinphoneUpnpStateAdding,   /**< Internal use: Only used by port binding */
289         LinphoneUpnpStateRemoving, /**< Internal use: Only used by port binding */
290         LinphoneUpnpStateNotAvailable,  /**< uPnP is not available */
291         LinphoneUpnpStateOk, /**< uPnP is enabled */
292         LinphoneUpnpStateKo, /**< uPnP processing has failed */
293 };
294
295 /**
296  * Enum describing uPnP states.
297  * @ingroup initializing
298 **/
299 typedef enum _LinphoneUpnpState LinphoneUpnpState;
300
301
302 /**
303  * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
304  *
305  * To receive these informations periodically and as soon as they are computed, the application is invited to place a #CallStatsUpdated callback in the LinphoneCoreVTable structure
306  * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
307  *
308  * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
309 **/
310 typedef struct _LinphoneCallStats LinphoneCallStats;
311
312 /**
313  * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
314  *
315  * To receive these informations periodically and as soon as they are computed, the application is invited to place a #CallStatsUpdated callback in the LinphoneCoreVTable structure
316  * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
317  *
318  * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
319 **/
320 struct _LinphoneCallStats {
321         int             type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
322         jitter_stats_t  jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
323         mblk_t*         received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
324         mblk_t*         sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
325         float           round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
326         LinphoneIceState        ice_state; /**< State of ICE processing. */
327         LinphoneUpnpState       upnp_state; /**< State of uPnP processing. */
328         float download_bandwidth; /**<Download bandwidth measurement of received stream, expressed in kbit/s, including IP/UDP/RTP headers*/
329         float upload_bandwidth; /**<Download bandwidth measurement of sent stream, expressed in kbit/s, including IP/UDP/RTP headers*/
330 };
331
332 /**
333  * @}
334 **/
335
336 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
337 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
338
339
340 /** Callback prototype */
341 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
342
343 /**
344  * LinphoneCallState enum represents the different state a call can reach into.
345  * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
346  * @ingroup call_control
347 **/
348 typedef enum _LinphoneCallState{
349         LinphoneCallIdle,                                       /**<Initial call state */
350         LinphoneCallIncomingReceived, /**<This is a new incoming call */
351         LinphoneCallOutgoingInit, /**<An outgoing call is started */
352         LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
353         LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
354         LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
355         LinphoneCallConnected, /**<Connected, the call is answered */
356         LinphoneCallStreamsRunning, /**<The media streams are established and running*/
357         LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
358         LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
359         LinphoneCallResuming, /**<The call is being resumed by local end*/
360         LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
361         LinphoneCallError, /**<The call encountered an error*/
362         LinphoneCallEnd, /**<The call ended normally*/
363         LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
364         LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
365         LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
366         LinphoneCallUpdating, /**<A call update has been initiated by us */
367         LinphoneCallReleased /**< The call object is no more retained by the core */
368 } LinphoneCallState;
369
370 const char *linphone_call_state_to_string(LinphoneCallState cs);
371
372 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
373 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
374 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
375 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
376 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
377 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
378 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
379 LinphoneCall * linphone_call_ref(LinphoneCall *call);
380 void linphone_call_unref(LinphoneCall *call);
381 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
382 const char *linphone_call_get_refer_to(const LinphoneCall *call);
383 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
384 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
385 int linphone_call_get_duration(const LinphoneCall *call);
386 const LinphoneCallParams * linphone_call_get_current_params(LinphoneCall *call);
387 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
388 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
389 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
390 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
391 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
392 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
393 const char *linphone_call_get_remote_contact(LinphoneCall *call);
394 float linphone_call_get_play_volume(LinphoneCall *call);
395 float linphone_call_get_record_volume(LinphoneCall *call);
396 float linphone_call_get_current_quality(LinphoneCall *call);
397 float linphone_call_get_average_quality(LinphoneCall *call);
398 const char* linphone_call_get_authentication_token(LinphoneCall *call);
399 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
400 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
401 void linphone_call_send_vfu_request(LinphoneCall *call);
402 void *linphone_call_get_user_pointer(LinphoneCall *call);
403 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
404 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
405 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
406 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);
407 void linphone_call_start_recording(LinphoneCall *call);
408 void linphone_call_stop_recording(LinphoneCall *call);
409 /**
410  * Return TRUE if this call is currently part of a conference
411  *@param call #LinphoneCall
412  *@return TRUE if part of a conference.
413  *
414  @ingroup call_control
415  */
416 bool_t linphone_call_is_in_conference(const LinphoneCall *call);
417 /**
418  * Enables or disable echo cancellation for this call
419  * @param call
420  * @param val
421  *
422  * @ingroup media_parameters
423 **/
424 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
425 /**
426  * Returns TRUE if echo cancellation is enabled.
427  *
428  * @ingroup media_parameters
429 **/
430 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
431 /**
432  * Enables or disable echo limiter for this call
433  * @param call
434  * @param val
435  *
436  * @ingroup media_parameters
437 **/
438 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
439 /**
440  * Returns TRUE if echo limiter is enabled.
441  *
442  * @ingroup media_parameters
443 **/
444 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
445
446 /*keep this in sync with mediastreamer2/msvolume.h*/
447
448 /**
449  * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
450  * @ingroup call_misc
451 **/
452 #define LINPHONE_VOLUME_DB_LOWEST (-120)
453
454 /**
455  * @addtogroup proxies
456  * @{
457 **/
458 /**
459  * The LinphoneProxyConfig object represents a proxy configuration to be used
460  * by the LinphoneCore object.
461  * Its fields must not be used directly in favour of the accessors methods.
462  * Once created and filled properly the LinphoneProxyConfig can be given to
463  * LinphoneCore with linphone_core_add_proxy_config().
464  * This will automatically triggers the registration, if enabled.
465  *
466  * The proxy configuration are persistent to restarts because they are saved
467  * in the configuration file. As a consequence, after linphone_core_new() there
468  * might already be a list of configured proxy that can be examined with
469  * linphone_core_get_proxy_config_list().
470  *
471  * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
472  * that is used by default for calls.
473 **/
474 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
475
476 /**
477  * LinphoneRegistrationState describes proxy registration states.
478 **/
479 typedef enum _LinphoneRegistrationState{
480         LinphoneRegistrationNone, /**<Initial state for registrations */
481         LinphoneRegistrationProgress, /**<Registration is in progress */
482         LinphoneRegistrationOk, /**< Registration is successful */
483         LinphoneRegistrationCleared, /**< Unregistration succeeded */
484         LinphoneRegistrationFailed      /**<Registration failed */
485 }LinphoneRegistrationState;
486
487 /**
488  * Human readable version of the #LinphoneRegistrationState
489  * @param cs sate
490  */
491 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
492
493 LinphoneProxyConfig *linphone_proxy_config_new(void);
494 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
495 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
496 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
497 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
498 /**
499  * Indicates  either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
500  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
501  * @param obj object pointer
502  * @param val if true, registration will be engaged
503  */
504 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
505 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
506 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
507 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
508 /**
509  * Indicates  either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
510  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
511  * @param obj object pointer
512  * @param val if true, publish will be engaged
513  *
514  */
515 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
516 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
517 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
518
519 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
520 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
521 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
522
523 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
524 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
525 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
526 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
527 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
528 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
529 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
530 const char *linphone_proxy_config_get_contact_parameters(const LinphoneProxyConfig *obj);
531 void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, const char *contact_params);
532 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
533
534 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
535 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
536
537 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
538
539 /* destruction is called automatically when removing the proxy config */
540 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
541 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
542 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
543 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
544 /**
545  * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
546  */
547 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
548 /*
549  *  attached a user data to a proxy config
550  */
551 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
552 /*
553  *  get user data to a proxy config. return null if any
554  */
555 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
556
557 /**
558  * @}
559 **/
560
561 typedef struct _LinphoneAccountCreator{
562         struct _LinphoneCore *lc;
563         struct _SipSetupContext *ssctx;
564         char *username;
565         char *password;
566         char *domain;
567         char *route;
568         char *email;
569         int suscribe;
570         bool_t succeeded;
571 }LinphoneAccountCreator;
572
573 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
574 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
575 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
576 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
577 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
578 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
579 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
580 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
581 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
582 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
583 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
584 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
585 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
586
587 struct _LinphoneAuthInfo;
588
589 /**
590  * @ingroup authentication
591  * Object holding authentication information.
592  *
593  * @note The object's fields should not be accessed directly. Prefer using
594  * the accessor methods.
595  *
596  * In most case, authentication information consists of a username and password.
597  * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
598  * different SIP domains.
599  *
600  * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
601  * order to become known and used automatically when needed.
602  * Use linphone_core_add_auth_info() for that purpose.
603  *
604  * The LinphoneCore object can take the initiative to request authentication information
605  * when needed to the application through the auth_info_requested callback of the
606  * LinphoneCoreVTable structure.
607  *
608  * The application can respond to this information request later using
609  * linphone_core_add_auth_info(). This will unblock all pending authentication
610  * transactions and retry them with authentication headers.
611  *
612 **/
613 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
614
615 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
616                 const char *passwd, const char *ha1,const char *realm);
617 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
618 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
619 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
620
621 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
622 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
623 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
624
625 /* you don't need those function*/
626 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
627 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
628
629
630 struct _LinphoneChatRoom;
631 /**
632  * @addtogroup chatroom
633  * @{
634  */
635
636 /**
637  * A chat room message to old content to be sent.
638  * <br> Can be created by linphone_chat_room_create_message().
639  */
640 typedef struct _LinphoneChatMessage LinphoneChatMessage;
641         
642 /**
643  * A chat room is the place where text messages are exchanged.
644  * <br> Can be created by linphone_core_create_chat_room().
645  */
646 typedef struct _LinphoneChatRoom LinphoneChatRoom;
647
648 /**
649  *LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
650  */
651 typedef enum _LinphoneChatMessageStates {
652         LinphoneChatMessageStateIdle, /**<initial state*/
653         LinphoneChatMessageStateInProgress, /**<delivery in progress**/
654         LinphoneChatMessageStateDelivered, /**<message succesffully delivered an acknoleged by remote end point*/
655         LinphoneChatMessageStateNotDelivered /**<message was not delivered*/
656 }LinphoneChatMessageState;
657
658 /**
659  * Call back used to notify message delivery status
660  *@param msg #LinphoneChatMessage object
661  *@param status LinphoneChatMessageState
662  *@param ud application user data
663  */
664 typedef void (*LinphoneChatMessageStateChangeCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
665
666 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
667 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
668 LinphoneChatMessage* linphone_chat_room_create_message(LinphoneChatRoom *cr,const char* message);
669 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
670 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
671 void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage* msg,LinphoneChatMessageStateChangeCb status_cb,void* ud);
672 LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr);
673 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
674 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
675
676 const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
677 LinphoneChatMessage* linphone_chat_message_clone(const LinphoneChatMessage* message);
678 void linphone_chat_message_set_from(LinphoneChatMessage* message, const LinphoneAddress* from);
679 LinphoneAddress* linphone_chat_message_get_from(const LinphoneChatMessage* message);
680 const char* linphone_chat_message_get_external_body_url(const LinphoneChatMessage* message);
681 void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
682 const char * linphone_chat_message_get_text(const LinphoneChatMessage* message);
683 time_t linphone_chat_message_get_time(const LinphoneChatMessage* message);
684 void* linphone_chat_message_get_user_data(const LinphoneChatMessage* message);
685 void linphone_chat_message_set_user_data(LinphoneChatMessage* message,void*);
686 LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
687 const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
688 void linphone_chat_message_add_custom_header(LinphoneChatMessage* message, const char *header_name, const char *header_value);
689 const char * linphone_chat_message_get_custom_header(LinphoneChatMessage* message, const char *header_name);
690
691 /**
692  * @}
693  */
694
695
696 /**
697  * @addtogroup initializing
698  * @{
699 **/
700
701 /**
702  * LinphoneGlobalState describes the global state of the LinphoneCore object.
703  * It is notified via the LinphoneCoreVTable::global_state_changed
704 **/
705 typedef enum _LinphoneGlobalState{
706         LinphoneGlobalOff,
707         LinphoneGlobalStartup,
708         LinphoneGlobalOn,
709         LinphoneGlobalShutdown
710 }LinphoneGlobalState;
711
712 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
713
714
715 /**Call state notification callback prototype*/
716 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
717 /**Call state notification callback prototype*/
718 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
719 /**Call encryption changed callback prototype*/
720 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
721
722 /** @ingroup Proxies
723  * Registration state notification callback prototype
724  * */
725 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
726 /** Callback prototype */
727 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
728 /** Callback prototype */
729 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
730 /** Callback prototype */
731 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
732 /** Callback prototype */
733 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
734 /** Callback prototype */
735 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
736 /** Callback prototype */
737 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
738 /**
739  * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
740  * @param lc #LinphoneCore object .
741  * @param lf Updated #LinphoneFriend .
742  */
743 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
744 /**
745  *  Reports that a new subscription request has been received and wait for a decision.
746  *  <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
747  *      @param lc #LinphoneCore object
748  *      @param lf #LinphoneFriend corresponding to the subscriber
749  *      @param url of the subscriber
750  *  Callback prototype
751  *  */
752 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
753 /** Callback prototype */
754 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
755 /** Callback prototype */
756 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
757 /**
758  * Callback prototype
759  * @deprecated use #MessageReceived instead.
760  *
761  * @param lc #LinphoneCore object
762  * @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.
763  * @param from #LinphoneAddress from
764  * @param message incoming message
765  *  */
766 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
767 /**
768  * Chat message callback prototype
769  *
770  * @param lc #LinphoneCore object
771  * @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.
772  * @param LinphoneChatMessage incoming message
773  * */
774 typedef void (*MessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
775         
776 /** Callback prototype */
777 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
778 /** Callback prototype */
779 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
780 /** Callback prototype */
781 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
782 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
783 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
784 /** Callback prototype for receiving quality statistics for calls*/
785 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
786
787 /**
788  * This structure holds all callbacks that the application should implement.
789  *  None is mandatory.
790 **/
791 typedef struct _LinphoneVTable{
792         LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
793         LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
794         LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
795         NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
796         NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
797         AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
798         CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
799         TextMessageReceived text_received; /** @deprecated, use #message_received instead <br> A text message has been received */
800         MessageReceived message_received; /** a message is received, can be text or external body*/
801         DtmfReceived dtmf_received; /**< A dtmf has been received received */
802         ReferReceived refer_received; /**< An out of call refer was received */
803         CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
804         LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
805         BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
806         NotifyReceivedCb notify_recv; /**< Other notifications*/
807         CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
808         DisplayStatusCb display_status; /**< DEPRECATED Callback that notifies various events with human readable text.*/
809         DisplayMessageCb display_message;/**< DEPRECATED Callback to display a message to the user */
810         DisplayMessageCb display_warning;/**< DEPRECATED Callback to display a warning to the user */
811         DisplayUrlCb display_url; /**< DEPRECATED */
812         ShowInterfaceCb show; /**< DEPRECATED Notifies the application that it should show up*/
813 } LinphoneCoreVTable;
814
815 /**
816  * @}
817 **/
818
819 typedef struct _LCCallbackObj
820 {
821   LinphoneCoreCbFunc _func;
822   void * _user_data;
823 }LCCallbackObj;
824
825
826
827 typedef enum _LinphoneFirewallPolicy{
828         LinphonePolicyNoFirewall,
829         LinphonePolicyUseNatAddress,
830         LinphonePolicyUseStun,
831         LinphonePolicyUseIce,
832         LinphonePolicyUseUpnp,
833 } LinphoneFirewallPolicy;
834
835 typedef enum _LinphoneWaitingState{
836         LinphoneWaitingStart,
837         LinphoneWaitingProgress,
838         LinphoneWaitingFinished
839 } LinphoneWaitingState;
840 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
841
842
843 /* THE main API */
844
845 void linphone_core_enable_logs(FILE *file);
846 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
847 void linphone_core_disable_logs(void);
848 const char *linphone_core_get_version(void);
849 const char *linphone_core_get_user_agent_name(void);
850 const char *linphone_core_get_user_agent_version(void);
851
852 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
853                                                 const char *config_path, const char *factory_config, void* userdata);
854
855 /* function to be periodically called in a main loop */
856 /* For ICE to work properly it should be called every 20ms */
857 void linphone_core_iterate(LinphoneCore *lc);
858 #if 0 /*not implemented yet*/
859 /**
860  * @ingroup initializing
861  * Provide Linphone Core with an unique identifier. This be later used to identified contact address coming from this device.
862  * Value is not saved.
863  * @param lc object
864  * @param string identifying the device, can be EMEI or UDID
865  *
866  */
867 void linphone_core_set_device_identifier(LinphoneCore *lc,const char* device_id);
868 /**
869  * @ingroup initializing
870  * get Linphone unique identifier
871  *
872  */
873 const char*  linphone_core_get_device_identifier(const LinphoneCore *lc);
874
875 #endif
876
877 /*sets the user-agent string in sip messages, ideally called just after linphone_core_new() or linphone_core_init() */
878 void linphone_core_set_user_agent(LinphoneCore *lc, const char *ua_name, const char *version);
879
880 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
881
882 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
883
884 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
885
886 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
887
888 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
889
890 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
891
892 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
893
894 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
895
896 bool_t linphone_core_in_call(const LinphoneCore *lc);
897
898 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
899
900 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
901
902 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
903
904 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
905
906 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
907
908 int linphone_core_decline_call(LinphoneCore *lc, LinphoneCall * call, LinphoneReason reason);
909
910 int linphone_core_terminate_all_calls(LinphoneCore *lc);
911
912 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
913
914 int linphone_core_pause_all_calls(LinphoneCore *lc);
915
916 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
917
918 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
919
920 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
921
922 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
923
924 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
925
926 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
927
928 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
929
930 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
931
932 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
933
934 const char * linphone_core_get_identity(LinphoneCore *lc);
935
936 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
937 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
938
939 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
940 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
941
942 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
943 const char * linphone_core_get_identity(LinphoneCore *lc);
944 /*0= no bandwidth limit*/
945 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
946 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
947
948 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
949 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
950
951 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
952 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
953
954 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
955 int  linphone_core_get_download_ptime(LinphoneCore *lc);
956
957 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
958
959 int linphone_core_get_upload_ptime(LinphoneCore *lc);
960
961 /* returns a MSList of PayloadType */
962 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
963
964 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
965 /* returns a MSList of PayloadType */
966 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
967
968 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
969
970 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
971
972 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
973
974 /**
975  * Wildcard value used by #linphone_core_find_payload_type to ignore rate in search algirithm
976  * @ingroup media_parameters
977  */
978 #define LINPHONE_FIND_PAYLOAD_IGNORE_RATE -1
979 /**
980  * Wildcard value used by #linphone_core_find_payload_type to ignore channel in search algirithm
981  * @ingroup media_parameters
982  */
983 #define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS -1
984 /**
985  * Get payload type from mime type and clock rate
986  * @ingroup media_parameters
987  * This function searches in audio and video codecs for the given payload type name and clockrate.
988  * @param lc #LinphoneCore object
989  * @param type payload mime type (I.E SPEEX, PCMU, VP8)
990  * @param rate can be #LINPHONE_FIND_PAYLOAD_IGNORE_RATE
991  * @param channels  number of channels, can be #LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
992  * @return Returns NULL if not found.
993  */     
994 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate, int channels) ;
995
996 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
997
998 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
999
1000 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
1001
1002 /**
1003  * @ingroup proxy 
1004  *Create a proxy config with default value from Linphone core.
1005  *@param lc #LinphoneCore object
1006  *@return #LinphoneProxyConfig with defualt value set 
1007  */
1008 LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *lc);
1009         
1010 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1011
1012 void linphone_core_clear_proxy_config(LinphoneCore *lc);
1013
1014 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1015
1016 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
1017
1018 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
1019
1020 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
1021
1022 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
1023
1024 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1025
1026 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1027
1028 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
1029
1030 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
1031
1032 void linphone_core_abort_authentication(LinphoneCore *lc,  LinphoneAuthInfo *info);
1033
1034 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
1035
1036 void linphone_core_enable_audio_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1037
1038 bool_t linphone_core_audio_adaptive_jittcomp_enabled(LinphoneCore *lc);
1039
1040 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
1041
1042 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
1043
1044 void linphone_core_enable_video_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1045
1046 bool_t linphone_core_video_adaptive_jittcomp_enabled(LinphoneCore *lc);
1047
1048 int linphone_core_get_video_jittcomp(LinphoneCore *lc);
1049
1050 void linphone_core_set_video_jittcomp(LinphoneCore *lc, int value);
1051
1052 int linphone_core_get_audio_port(const LinphoneCore *lc);
1053
1054 void linphone_core_get_audio_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1055
1056 int linphone_core_get_video_port(const LinphoneCore *lc);
1057
1058 void linphone_core_get_video_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1059
1060 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
1061
1062 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
1063
1064 void linphone_core_set_audio_port_range(LinphoneCore *lc, int min_port, int max_port);
1065
1066 void linphone_core_set_video_port(LinphoneCore *lc, int port);
1067
1068 void linphone_core_set_video_port_range(LinphoneCore *lc, int min_port, int max_port);
1069
1070 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
1071
1072 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
1073
1074 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
1075
1076 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
1077
1078 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
1079
1080 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
1081
1082 int linphone_core_get_sip_port(LinphoneCore *lc);
1083
1084 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
1085
1086 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
1087 /**
1088  *
1089  * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
1090  * @param lc #LinphoneCore
1091  * @return socket file descriptor
1092  */
1093 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
1094
1095 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
1096
1097 int linphone_core_get_inc_timeout(LinphoneCore *lc);
1098
1099 void linphone_core_set_in_call_timeout(LinphoneCore *lc, int seconds);
1100
1101 int linphone_core_get_in_call_timeout(LinphoneCore *lc);
1102
1103 void linphone_core_set_delayed_timeout(LinphoneCore *lc, int seconds);
1104
1105 int linphone_core_get_delayed_timeout(LinphoneCore *lc);
1106
1107 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
1108
1109 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
1110
1111 /**
1112  * @ingroup network_parameters
1113  * Return the availability of uPnP.
1114  *
1115  * @param lc #LinphoneCore
1116  * @return true if uPnP is available otherwise return false. 
1117  */
1118 bool_t linphone_core_upnp_available(const LinphoneCore *lc);
1119
1120 /**
1121  * @ingroup network_parameters
1122  * Return the internal state of uPnP. 
1123  *
1124  * @param lc #LinphoneCore
1125  * @return an LinphoneUpnpState. 
1126  */
1127 LinphoneUpnpState linphone_core_get_upnp_state(const LinphoneCore *lc);
1128
1129 /**
1130  * @ingroup network_parameters
1131  * Return the external ip address of router. 
1132  * In some cases the uPnP can have an external ip address but not a usable uPnP
1133  * (state different of Ok). 
1134  *
1135  * @param lc #LinphoneCore
1136  * @return a null terminated string containing the external ip address. If the
1137  * the external ip address is not available return null. 
1138  */
1139 const char * linphone_core_get_upnp_external_ipaddress(const LinphoneCore *lc);
1140
1141 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
1142
1143 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
1144
1145 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
1146
1147 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
1148
1149 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
1150
1151 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
1152
1153 /* sound functions */
1154 /* returns a null terminated static array of string describing the sound devices */
1155 const char**  linphone_core_get_sound_devices(LinphoneCore *lc);
1156 void linphone_core_reload_sound_devices(LinphoneCore *lc);
1157 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
1158 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
1159 int linphone_core_get_ring_level(LinphoneCore *lc);
1160 int linphone_core_get_play_level(LinphoneCore *lc);
1161 int linphone_core_get_rec_level(LinphoneCore *lc);
1162 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
1163 void linphone_core_set_play_level(LinphoneCore *lc, int level);
1164
1165 void linphone_core_set_mic_gain_db(LinphoneCore *lc, float level);
1166 float linphone_core_get_mic_gain_db(LinphoneCore *lc);
1167 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
1168 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
1169
1170 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
1171 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
1172 const char * linphone_core_get_playback_device(LinphoneCore *lc);
1173 const char * linphone_core_get_capture_device(LinphoneCore *lc);
1174 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
1175 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
1176 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
1177 char linphone_core_get_sound_source(LinphoneCore *lc);
1178 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
1179 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
1180 const char *linphone_core_get_ring(const LinphoneCore *lc);
1181 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1182 void linphone_core_verify_server_cn(LinphoneCore *lc, bool_t yesno);
1183 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1184 const char *linphone_core_get_root_ca(LinphoneCore *lc);
1185 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1186 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1187
1188 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1189 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1190
1191 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1192 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1193 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1194
1195 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1196 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1197
1198 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1199 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1200
1201 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1202 /**
1203  * return mic state.
1204  *
1205  * @ingroup media_parameters
1206 **/
1207 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1208
1209 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1210
1211 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1212 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1213
1214
1215 /* returns a list of LinphoneCallLog */
1216 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1217 void linphone_core_clear_call_logs(LinphoneCore *lc);
1218 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1219 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1220 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1221
1222 /* video support */
1223 bool_t linphone_core_video_supported(LinphoneCore *lc);
1224 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1225 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1226 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1227 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1228
1229 typedef struct MSVideoSizeDef{
1230         MSVideoSize vsize;
1231         const char *name;
1232 }MSVideoSizeDef;
1233 /* returns a zero terminated table of MSVideoSizeDef*/
1234 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1235 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1236 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1237 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1238
1239 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1240 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1241
1242 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1243 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1244
1245
1246 /* returns a null terminated static array of string describing the webcams */
1247 void linphone_core_reload_video_devices(LinphoneCore *lc);
1248 const char**  linphone_core_get_video_devices(const LinphoneCore *lc);
1249 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1250 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1251
1252 /* Set and get static picture to be used when "Static picture" is the video device */
1253 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1254 const char *linphone_core_get_static_picture(LinphoneCore *lc);
1255
1256 /* Set and get frame rate for static picture */
1257 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1258 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1259
1260 /*function to be used for eventually setting window decorations (icons, title...)*/
1261 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1262 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1263
1264 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1265 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1266
1267 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1268 int linphone_core_get_device_rotation(LinphoneCore *lc );
1269 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1270
1271 /* start or stop streaming video in case of embedded window */
1272 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1273
1274 /*play/record support: use files instead of soundcard*/
1275 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1276 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1277 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1278
1279 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1280 void linphone_core_stop_dtmf(LinphoneCore *lc);
1281
1282 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1283
1284
1285 int linphone_core_get_mtu(const LinphoneCore *lc);
1286 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1287
1288 /**
1289  * @ingroup network_parameters
1290  * This method is called by the application to notify the linphone core library when network is reachable.
1291  * Calling this method with true trigger linphone to initiate a registration process for all proxies.
1292  * Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
1293  */
1294 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1295 /**
1296  * @ingroup network_parameters
1297  * return network state either as positioned by the application or by linphone itself.
1298  */
1299 bool_t linphone_core_is_network_reachable(LinphoneCore* lc);
1300
1301 /**
1302  *  @ingroup network_parameters
1303  *  enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1304  */
1305 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1306 /**
1307  *  @ingroup network_parameters
1308  * Is signaling keep alive
1309  */
1310 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1311
1312 void *linphone_core_get_user_data(LinphoneCore *lc);
1313 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1314
1315 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1316 the config file with your own sections */
1317 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1318
1319 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1320 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1321
1322 /*returns the list of registered SipSetup (linphonecore plugins) */
1323 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1324
1325 void linphone_core_destroy(LinphoneCore *lc);
1326
1327 /*for advanced users:*/
1328 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1329 struct _LinphoneRtpTransportFactories{
1330         LinphoneRtpTransportFactoryFunc audio_rtp_func;
1331         void *audio_rtp_func_data;
1332         LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1333         void *audio_rtcp_func_data;
1334         LinphoneRtpTransportFactoryFunc video_rtp_func;
1335         void *video_rtp_func_data;
1336         LinphoneRtpTransportFactoryFunc video_rtcp_func;
1337         void *video_rtcp_func_data;
1338 };
1339 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1340
1341 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1342
1343 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1344
1345 int linphone_core_get_calls_nb(const LinphoneCore *lc);
1346
1347 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1348
1349 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1350 /**
1351  * force registration refresh to be initiated upon next iterate
1352  * @ingroup proxies
1353  */
1354 void linphone_core_refresh_registers(LinphoneCore* lc);
1355
1356 /* Path to the file storing secrets cache */
1357 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1358 const char *linphone_core_get_zrtp_secrets_file(LinphoneCore *lc);
1359
1360 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1361
1362 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1363 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1364 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1365 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1366 int linphone_core_enter_conference(LinphoneCore *lc);
1367 int linphone_core_leave_conference(LinphoneCore *lc);
1368 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1369
1370 int linphone_core_terminate_conference(LinphoneCore *lc);
1371 int linphone_core_get_conference_size(LinphoneCore *lc);
1372 int linphone_core_start_conference_recording(LinphoneCore *lc, const char *path);
1373 int linphone_core_stop_conference_recording(LinphoneCore *lc);
1374
1375 int linphone_core_get_max_calls(LinphoneCore *lc);
1376 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1377
1378 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1379
1380 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1381
1382 /**
1383  * Choose media encryption policy to be used for RTP packets
1384  */
1385 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1386 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1387
1388 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1389 /**
1390  * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1391  * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1392  */
1393 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1394
1395 /**
1396  * Init call params using LinphoneCore's current configuration
1397  */
1398 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1399
1400 /**
1401  * True if tunnel support was compiled.
1402  */
1403 bool_t linphone_core_tunnel_available(void);
1404
1405 typedef struct _LinphoneTunnel LinphoneTunnel;
1406 /**
1407 * get tunnel instance if available
1408 */
1409 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1410
1411 void linphone_core_set_sip_dscp(LinphoneCore *lc, int dscp);
1412 int linphone_core_get_sip_dscp(const LinphoneCore *lc);
1413
1414 void linphone_core_set_audio_dscp(LinphoneCore *lc, int dscp);
1415 int linphone_core_get_audio_dscp(const LinphoneCore *lc);
1416
1417 void linphone_core_set_video_dscp(LinphoneCore *lc, int dscp);
1418 int linphone_core_get_video_dscp(const LinphoneCore *lc);
1419
1420
1421
1422 #ifdef __cplusplus
1423 }
1424 #endif
1425
1426
1427 #endif