liblinphone  3.7.0
Data Structures | Macros | Typedefs | Enumerations | Functions
Initializing liblinphone

Data Structures

struct  _LCSipTransports
 
struct  _LinphoneCoreVTable
 

Macros

#define LC_SIP_TRANSPORT_DISABLED   0
 
#define LC_SIP_TRANSPORT_RANDOM   -1
 

Typedefs

typedef struct _LinphoneCore LinphoneCore
 
typedef struct _LCSipTransports LCSipTransports
 
typedef enum _LinphoneIceState LinphoneIceState
 
typedef enum _LinphoneUpnpState LinphoneUpnpState
 
typedef enum _LinphoneGlobalState LinphoneGlobalState
 
typedef void(* LinphoneCoreGlobalStateChangedCb )(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message)
 
typedef void(* LinphoneCoreCallStateChangedCb )(LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message)
 
typedef void(* LinphoneCoreCallEncryptionChangedCb )(LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token)
 
typedef void(* LinphoneCoreRegistrationStateChangedCb )(LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message)
 
typedef void(* ShowInterfaceCb )(LinphoneCore *lc)
 
typedef void(* DisplayStatusCb )(LinphoneCore *lc, const char *message)
 
typedef void(* DisplayMessageCb )(LinphoneCore *lc, const char *message)
 
typedef void(* DisplayUrlCb )(LinphoneCore *lc, const char *message, const char *url)
 
typedef void(* LinphoneCoreCbFunc )(LinphoneCore *lc, void *user_data)
 
typedef void(* LinphoneCoreNotifyPresenceReceivedCb )(LinphoneCore *lc, LinphoneFriend *lf)
 
typedef void(* LinphoneCoreNewSubscriptionRequestedCb )(LinphoneCore *lc, LinphoneFriend *lf, const char *url)
 
typedef void(* LinphoneCoreAuthInfoRequestedCb )(LinphoneCore *lc, const char *realm, const char *username, const char *domain)
 
typedef void(* LinphoneCoreCallLogUpdatedCb )(LinphoneCore *lc, LinphoneCallLog *newcl)
 
typedef void(* LinphoneCoreTextMessageReceivedCb )(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message)
 
typedef void(* LinphoneCoreMessageReceivedCb )(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message)
 
typedef void(* LinphoneCoreIsComposingReceivedCb )(LinphoneCore *lc, LinphoneChatRoom *room)
 
typedef void(* LinphoneCoreDtmfReceivedCb )(LinphoneCore *lc, LinphoneCall *call, int dtmf)
 
typedef void(* LinphoneCoreReferReceivedCb )(LinphoneCore *lc, const char *refer_to)
 
typedef void(* LinphoneCoreBuddyInfoUpdatedCb )(LinphoneCore *lc, LinphoneFriend *lf)
 
typedef void(* LinphoneCoreTransferStateChangedCb )(LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state)
 
typedef void(* LinphoneCoreCallStatsUpdatedCb )(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats)
 
typedef void(* LinphoneCoreInfoReceivedCb )(LinphoneCore *lc, LinphoneCall *call, const LinphoneInfoMessage *msg)
 
typedef enum
_LinphoneConfiguringState 
LinphoneConfiguringState
 
typedef void(* LinphoneCoreConfiguringStatusCb )(LinphoneCore *lc, LinphoneConfiguringState status, const char *message)
 
typedef struct _LinphoneCoreVTable LinphoneCoreVTable
 

Enumerations

enum  _LinphoneIceState {
  LinphoneIceStateNotActivated,
  LinphoneIceStateFailed,
  LinphoneIceStateInProgress,
  LinphoneIceStateHostConnection,
  LinphoneIceStateReflexiveConnection,
  LinphoneIceStateRelayConnection
}
 
enum  _LinphoneUpnpState {
  LinphoneUpnpStateIdle,
  LinphoneUpnpStatePending,
  LinphoneUpnpStateAdding,
  LinphoneUpnpStateRemoving,
  LinphoneUpnpStateNotAvailable,
  LinphoneUpnpStateOk,
  LinphoneUpnpStateKo,
  LinphoneUpnpStateBlacklisted
}
 
enum  _LinphoneGlobalState
 
enum  _LinphoneConfiguringState
 

Functions

LinphoneCorelinphone_core_new (const LinphoneCoreVTable *vtable, const char *config_path, const char *factory_config_path, void *userdata)
 
void linphone_core_iterate (LinphoneCore *lc)
 
void linphone_core_set_root_ca (LinphoneCore *lc, const char *path)
 
const char * linphone_core_get_root_ca (LinphoneCore *lc)
 
void linphone_core_verify_server_certificates (LinphoneCore *lc, bool_t yesno)
 
void linphone_core_verify_server_cn (LinphoneCore *lc, bool_t yesno)
 
void * linphone_core_get_user_data (LinphoneCore *lc)
 
void linphone_core_set_user_data (LinphoneCore *lc, void *userdata)
 
void linphone_core_destroy (LinphoneCore *lc)
 
void linphone_core_set_chat_database_path (LinphoneCore *lc, const char *path)
 
LinphoneCorelinphone_core_new_with_config (const LinphoneCoreVTable *vtable, LpConfig *config, void *userdata)
 
void linphone_core_set_zrtp_secrets_file (LinphoneCore *lc, const char *file)
 
const char * linphone_core_get_zrtp_secrets_file (LinphoneCore *lc)
 
int linphone_core_get_max_calls (LinphoneCore *lc)
 
void linphone_core_set_max_calls (LinphoneCore *lc, int max)
 
void linphone_core_set_provisioning_uri (LinphoneCore *lc, const char *uri)
 
const char * linphone_core_get_provisioning_uri (const LinphoneCore *lc)
 
int linphone_core_migrate_to_multi_transport (LinphoneCore *lc)
 

Detailed Description

Macro Definition Documentation

#define LC_SIP_TRANSPORT_DISABLED   0

Disable a sip transport Use with LCSipTransports

#define LC_SIP_TRANSPORT_RANDOM   -1

Randomly chose a sip port for this transport Use with LCSipTransports

Typedef Documentation

typedef struct _LinphoneCore LinphoneCore

Linphone core main object created by function linphone_core_new() .

Linphone core SIP transport ports. Use with linphone_core_set_sip_transports

Enum describing Ice states.

Enum describing uPnP states.

LinphoneGlobalState describes the global state of the LinphoneCore object. It is notified via the LinphoneCoreVTable::global_state_changed

typedef void(* LinphoneCoreGlobalStateChangedCb)(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message)

Global state notification callback.

Parameters
lc
gstatethe global state
messageinformational message.
typedef void(* LinphoneCoreCallStateChangedCb)(LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message)

Call state notification callback.

Parameters
lcthe LinphoneCore
callthe call object whose state is changed.
cstatethe new state of the call
messagean informational message about the state.
typedef void(* LinphoneCoreCallEncryptionChangedCb)(LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token)

Call encryption changed callback.

Parameters
lcthe LinphoneCore
callthe call on which encryption is changed.
onwhether encryption is activated.
authentication_tokenan authentication_token, currently set for ZRTP kind of encryption only.
typedef void(* LinphoneCoreRegistrationStateChangedCb)(LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message)

Registration state notification callback prototype

typedef void(* ShowInterfaceCb)(LinphoneCore *lc)

Callback prototype

Deprecated:
typedef void(* DisplayStatusCb)(LinphoneCore *lc, const char *message)

Callback prototype

Deprecated:
typedef void(* DisplayMessageCb)(LinphoneCore *lc, const char *message)

Callback prototype

Deprecated:
typedef void(* DisplayUrlCb)(LinphoneCore *lc, const char *message, const char *url)

Callback prototype

Deprecated:
typedef void(* LinphoneCoreCbFunc)(LinphoneCore *lc, void *user_data)

Callback prototype

typedef void(* LinphoneCoreNotifyPresenceReceivedCb)(LinphoneCore *lc, LinphoneFriend *lf)

Report status change for a friend previously added to LinphoneCore.

Parameters
lcLinphoneCore object .
lfUpdated LinphoneFriend .
typedef void(* LinphoneCoreNewSubscriptionRequestedCb)(LinphoneCore *lc, LinphoneFriend *lf, const char *url)

Reports that a new subscription request has been received and wait for a decision. Status on this subscription request is notified by changing policy for this friend

Parameters
lcLinphoneCore object
lfLinphoneFriend corresponding to the subscriber
urlof the subscriber Callback prototype
typedef void(* LinphoneCoreAuthInfoRequestedCb)(LinphoneCore *lc, const char *realm, const char *username, const char *domain)

Callback for requesting authentication information to application or user.

Parameters
lcthe LinphoneCore
realmthe realm (domain) on which authentication is required.
usernamethe username that needs to be authenticated. Application shall reply to this callback using linphone_core_add_auth_info().
typedef void(* LinphoneCoreCallLogUpdatedCb)(LinphoneCore *lc, LinphoneCallLog *newcl)

Callback to notify a new call-log entry has been added. This is done typically when a call terminates.

Parameters
lcthe LinphoneCore
newclthe new call log entry added.
typedef void(* LinphoneCoreTextMessageReceivedCb)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message)

Callback prototype

Deprecated:
use #LinphoneMessageReceived instead.
Parameters
lcLinphoneCore object
roomLinphoneChatRoom involved in this conversation. Can be be created by the framework in case the from is not present in any chat room.
fromLinphoneAddress from
messageincoming message
typedef void(* LinphoneCoreMessageReceivedCb)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message)

Chat message callback prototype

Parameters
lcLinphoneCore object
roomLinphoneChatRoom involved in this conversation. Can be be created by the framework in case the from is not present in any chat room.
LinphoneChatMessageincoming message
typedef void(* LinphoneCoreIsComposingReceivedCb)(LinphoneCore *lc, LinphoneChatRoom *room)

Is composing notification callback prototype.

Parameters
[in]lcLinphoneCore object
[in]roomLinphoneChatRoom involved in the conversation.
typedef void(* LinphoneCoreDtmfReceivedCb)(LinphoneCore *lc, LinphoneCall *call, int dtmf)

Callback for being notified of DTMFs received.

Parameters
lcthe linphone core
callthe call that received the dtmf
dtmfthe ascii code of the dtmf
typedef void(* LinphoneCoreReferReceivedCb)(LinphoneCore *lc, const char *refer_to)

Callback prototype

typedef void(* LinphoneCoreBuddyInfoUpdatedCb)(LinphoneCore *lc, LinphoneFriend *lf)

Callback prototype

typedef void(* LinphoneCoreTransferStateChangedCb)(LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state)

Callback for notifying progresses of transfers.

Parameters
lcthe LinphoneCore
transferedthe call that was transfered
new_call_statethe state of the call to transfer target at the far end.
typedef void(* LinphoneCoreCallStatsUpdatedCb)(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats)

Callback for receiving quality statistics for calls.

Parameters
lcthe LinphoneCore
callthe call
statsthe call statistics.
typedef void(* LinphoneCoreInfoReceivedCb)(LinphoneCore *lc, LinphoneCall *call, const LinphoneInfoMessage *msg)

Callback prototype for receiving info messages.

Parameters
lcthe LinphoneCore
callthe call whose info message belongs to.
msgthe info message.

LinphoneGlobalState describes the global state of the LinphoneCore object. It is notified via the LinphoneCoreVTable::global_state_changed

typedef void(* LinphoneCoreConfiguringStatusCb)(LinphoneCore *lc, LinphoneConfiguringState status, const char *message)

Callback prototype for configuring status changes notification

Parameters
lcthe LinphoneCore
messageinformational message.

This structure holds all callbacks that the application should implement. None is mandatory.

Enumeration Type Documentation

Enum describing ICE states.

Enumerator
LinphoneIceStateNotActivated 

ICE has not been activated for this call

LinphoneIceStateFailed 

ICE processing has failed

LinphoneIceStateInProgress 

ICE process is in progress

LinphoneIceStateHostConnection 

ICE has established a direct connection to the remote host

LinphoneIceStateReflexiveConnection 

ICE has established a connection to the remote host through one or several NATs

LinphoneIceStateRelayConnection 

ICE has established a connection through a relay

Enum describing uPnP states.

Enumerator
LinphoneUpnpStateIdle 

uPnP is not activate

LinphoneUpnpStatePending 

uPnP process is in progress

LinphoneUpnpStateAdding 

Internal use: Only used by port binding

LinphoneUpnpStateRemoving 

Internal use: Only used by port binding

LinphoneUpnpStateNotAvailable 

uPnP is not available

LinphoneUpnpStateOk 

uPnP is enabled

LinphoneUpnpStateKo 

uPnP processing has failed

LinphoneUpnpStateBlacklisted 

IGD router is blacklisted

LinphoneGlobalState describes the global state of the LinphoneCore object. It is notified via the LinphoneCoreVTable::global_state_changed

LinphoneGlobalState describes the global state of the LinphoneCore object. It is notified via the LinphoneCoreVTable::global_state_changed

Function Documentation

LinphoneCore* linphone_core_new ( const LinphoneCoreVTable vtable,
const char *  config_path,
const char *  factory_config_path,
void *  userdata 
)

Instanciates a LinphoneCore object.

The LinphoneCore object is the primary handle for doing all phone actions. It should be unique within your application.

Parameters
vtablea LinphoneCoreVTable structure holding your application callbacks
config_patha path to a config file. If it does not exists it will be created. The config file is used to store all settings, call logs, friends, proxies... so that all these settings become persistent over the life of the LinphoneCore object. It is allowed to set a NULL config file. In that case LinphoneCore will not store any settings.
factory_config_patha path to a read-only config file that can be used to to store hard-coded preference such as proxy settings or internal preferences. The settings in this factory file always override the one in the normal config file. It is OPTIONAL, use NULL if unneeded.
userdataan opaque user pointer that can be retrieved at any time (for example in callbacks) using linphone_core_get_user_data().
See Also
linphone_core_new_with_config
void linphone_core_iterate ( LinphoneCore lc)

Main loop function. It is crucial that your application call it periodically.

linphone_core_iterate() performs various backgrounds tasks:

  • receiving of SIP messages
  • handles timers and timeout
  • performs registration to proxies
  • authentication retries The application MUST call this function periodically, in its main loop. Be careful that this function must be called from the same thread as other liblinphone methods. If it is not the case make sure all liblinphone calls are serialized with a mutex.
void linphone_core_set_root_ca ( LinphoneCore lc,
const char *  path 
)

Sets the path to a file or folder containing trusted root CAs (PEM format)

Parameters
path
lcThe LinphoneCore object
const char* linphone_core_get_root_ca ( LinphoneCore lc)

Gets the path to a file or folder containing the trusted root CAs (PEM format)

Parameters
lcThe LinphoneCore object
void linphone_core_verify_server_certificates ( LinphoneCore lc,
bool_t  yesno 
)

Specify whether the tls server certificate must be verified when connecting to a SIP/TLS server.

void linphone_core_verify_server_cn ( LinphoneCore lc,
bool_t  yesno 
)

Specify whether the tls server certificate common name must be verified when connecting to a SIP/TLS server.

void* linphone_core_get_user_data ( LinphoneCore lc)

Retrieves the user pointer that was given to linphone_core_new()

void linphone_core_set_user_data ( LinphoneCore lc,
void *  userdata 
)

Associate a user pointer to the linphone core.

void linphone_core_destroy ( LinphoneCore lc)

Destroys a LinphoneCore

void linphone_core_set_chat_database_path ( LinphoneCore lc,
const char *  path 
)

Sets the database filename where chat messages will be stored. If the file does not exist, it will be created.

Parameters
lcthe linphone core
pathfilesystem path
LinphoneCore* linphone_core_new_with_config ( const LinphoneCoreVTable vtable,
LpConfig config,
void *  userdata 
)

Instantiates a LinphoneCore object with a given LpConfig.

The LinphoneCore object is the primary handle for doing all phone actions. It should be unique within your application.

Parameters
vtablea LinphoneCoreVTable structure holding your application callbacks
configa pointer to an LpConfig object holding the configuration of the LinphoneCore to be instantiated.
userdataan opaque user pointer that can be retrieved at any time (for example in callbacks) using linphone_core_get_user_data().
See Also
linphone_core_new
void linphone_core_set_zrtp_secrets_file ( LinphoneCore lc,
const char *  file 
)

Set the path to the file storing the zrtp secrets cache.

Parameters
[in]lcLinphoneCore object
[in]fileThe path to the file to use to store the zrtp secrets cache.
const char* linphone_core_get_zrtp_secrets_file ( LinphoneCore lc)

Get the path to the file storing the zrtp secrets cache.

Parameters
[in]lcLinphoneCore object.
Returns
The path to the file storing the zrtp secrets cache.
int linphone_core_get_max_calls ( LinphoneCore lc)

Get the maximum number of simultaneous calls Linphone core can manage at a time. All new call above this limit are declined with a busy answer

Parameters
lccore
Returns
max number of simultaneous calls
void linphone_core_set_max_calls ( LinphoneCore lc,
int  max 
)

Set the maximum number of simultaneous calls Linphone core can manage at a time. All new call above this limit are declined with a busy answer

Parameters
lccore
maxnumber of simultaneous calls
void linphone_core_set_provisioning_uri ( LinphoneCore lc,
const char *  uri 
)

Set URI where to download xml configuration file at startup. This can also be set from configuration file or factory config file, from [misc] section, item "config-uri". Calling this function does not load the configuration. It will write the value into configuration so that configuration from remote URI will take place at next LinphoneCore start.

Parameters
lcthe linphone core
urithe http or https uri to use in order to download the configuration.
const char* linphone_core_get_provisioning_uri ( const LinphoneCore lc)

Get provisioning URI.

Parameters
lcthe linphone core
Returns
the provisioning URI.
int linphone_core_migrate_to_multi_transport ( LinphoneCore lc)

Migrate configuration so that all SIP transports are enabled. Versions of linphone < 3.7 did not support using multiple SIP transport simultaneously. This function helps application to migrate the configuration so that all transports are enabled. Existing proxy configuration are added a transport parameter so that they continue using the unique transport that was set previously. This function must be used just after creating the core, before any call to linphone_core_iterate()

Parameters
lcthe linphone core
Returns
1 if migration was done, 0 if not done because unnecessary or already done, -1 in case of error.