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