Liblinphone  3.10.2
Data Structures | Typedefs | Enumerations | Functions
Miscenalleous: logs, version strings, config storage

Data Structures

struct  lp_config_to_dict
struct  lp_config_from_dict

Typedefs

typedef enum
_LinphoneAccountCreatorStatus 
LinphoneAccountCreatorStatus
typedef struct
_LinphoneAccountCreator 
LinphoneAccountCreator
typedef struct
_LinphoneAccountCreatorCbs 
LinphoneAccountCreatorCbs
typedef void(* LinphoneAccountCreatorCbsExistenceTestedCb )(LinphoneAccountCreator *creator, LinphoneAccountCreatorStatus status)
typedef void(* LinphoneAccountCreatorCbsValidationTestedCb )(LinphoneAccountCreator *creator, LinphoneAccountCreatorStatus status)
typedef void(* LinphoneAccountCreatorCbsCreateAccountCb )(LinphoneAccountCreator *creator, LinphoneAccountCreatorStatus status)
typedef struct _LinphoneBuffer LinphoneBuffer
typedef struct _LinphoneContent LinphoneContent
typedef enum _LinphoneReason LinphoneReason
typedef struct _LinphoneErrorInfo LinphoneErrorInfo
typedef struct _LpConfig LpConfig
typedef enum _LinphoneXmlRpcArgType LinphoneXmlRpcArgType
typedef enum _LinphoneXmlRpcStatus LinphoneXmlRpcStatus
typedef struct
_LinphoneXmlRpcRequest 
LinphoneXmlRpcRequest
typedef struct
_LinphoneXmlRpcRequestCbs 
LinphoneXmlRpcRequestCbs
typedef struct
_LinphoneXmlRpcSession 
LinphoneXmlRpcSession
typedef void(* LinphoneXmlRpcRequestCbsResponseCb )(LinphoneXmlRpcRequest *request)

Enumerations

enum  _LinphoneAccountCreatorStatus {
  LinphoneAccountCreatorOK,
  LinphoneAccountCreatorReqFailed,
  LinphoneAccountCreatorAccountCreated,
  LinphoneAccountCreatorAccountNotCreated,
  LinphoneAccountCreatorAccountExist,
  LinphoneAccountCreatorAccountNotExist,
  LinphoneAccountCreatorAccountValidated,
  LinphoneAccountCreatorAccountNotValidated,
  LinphoneAccountCreatorEmailInvalid,
  LinphoneAccountCreatorUsernameInvalid,
  LinphoneAccountCreatorUsernameTooShort,
  LinphoneAccountCreatorUsernameTooLong,
  LinphoneAccountCreatorUsernameInvalidSize,
  LinphoneAccountCreatorPasswordTooShort,
  LinphoneAccountCreatorPasswordTooLong,
  LinphoneAccountCreatorDomainInvalid,
  LinphoneAccountCreatorRouteInvalid,
  LinphoneAccountCreatorDisplayNameInvalid,
  LinphoneAccountCreatorTransportNotSupported
}
enum  _LinphoneReason {
  LinphoneReasonNone,
  LinphoneReasonNoResponse,
  LinphoneReasonForbidden,
  LinphoneReasonDeclined,
  LinphoneReasonNotFound,
  LinphoneReasonNotAnswered,
  LinphoneReasonBusy,
  LinphoneReasonUnsupportedContent,
  LinphoneReasonIOError,
  LinphoneReasonDoNotDisturb,
  LinphoneReasonUnauthorized,
  LinphoneReasonNotAcceptable,
  LinphoneReasonNoMatch,
  LinphoneReasonMovedPermanently,
  LinphoneReasonGone,
  LinphoneReasonTemporarilyUnavailable,
  LinphoneReasonAddressIncomplete,
  LinphoneReasonNotImplemented,
  LinphoneReasonBadGateway,
  LinphoneReasonServerTimeout,
  LinphoneReasonUnknown
}
enum  _LinphoneXmlRpcArgType {
  LinphoneXmlRpcArgNone,
  LinphoneXmlRpcArgInt,
  LinphoneXmlRpcArgString
}
enum  _LinphoneXmlRpcStatus {
  LinphoneXmlRpcStatusPending,
  LinphoneXmlRpcStatusOk,
  LinphoneXmlRpcStatusFailed
}

Functions

LinphoneAccountCreatorlinphone_account_creator_new (LinphoneCore *core, const char *xmlrpc_url)
LinphoneAccountCreatorlinphone_account_creator_ref (LinphoneAccountCreator *creator)
void linphone_account_creator_unref (LinphoneAccountCreator *creator)
void * linphone_account_creator_get_user_data (const LinphoneAccountCreator *creator)
void linphone_account_creator_set_user_data (LinphoneAccountCreator *creator, void *ud)
LinphoneAccountCreatorStatus linphone_account_creator_set_username (LinphoneAccountCreator *creator, const char *username)
const char * linphone_account_creator_get_username (const LinphoneAccountCreator *creator)
LinphoneAccountCreatorStatus linphone_account_creator_set_password (LinphoneAccountCreator *creator, const char *password)
const char * linphone_account_creator_get_password (const LinphoneAccountCreator *creator)
LinphoneAccountCreatorStatus linphone_account_creator_set_transport (LinphoneAccountCreator *creator, LinphoneTransportType transport)
LinphoneTransportType linphone_account_creator_get_transport (const LinphoneAccountCreator *creator)
LinphoneAccountCreatorStatus linphone_account_creator_set_domain (LinphoneAccountCreator *creator, const char *domain)
const char * linphone_account_creator_get_domain (const LinphoneAccountCreator *creator)
LinphoneAccountCreatorStatus linphone_account_creator_set_route (LinphoneAccountCreator *creator, const char *route)
const char * linphone_account_creator_get_route (const LinphoneAccountCreator *creator)
LinphoneAccountCreatorStatus linphone_account_creator_set_display_name (LinphoneAccountCreator *creator, const char *display_name)
const char * linphone_account_creator_get_display_name (const LinphoneAccountCreator *creator)
LinphoneAccountCreatorStatus linphone_account_creator_set_email (LinphoneAccountCreator *creator, const char *email)
const char * linphone_account_creator_get_email (const LinphoneAccountCreator *creator)
void linphone_account_creator_enable_newsletter_subscription (LinphoneAccountCreator *creator, bool_t subscribe)
bool_t linphone_account_creator_newsletter_subscription_enabled (const LinphoneAccountCreator *creator)
LinphoneAccountCreatorCbslinphone_account_creator_get_callbacks (const LinphoneAccountCreator *creator)
LinphoneAccountCreatorStatus linphone_account_creator_test_existence (LinphoneAccountCreator *creator)
LinphoneAccountCreatorStatus linphone_account_creator_test_validation (LinphoneAccountCreator *creator)
LinphoneAccountCreatorStatus linphone_account_creator_create_account (LinphoneAccountCreator *creator)
LinphoneProxyConfiglinphone_account_creator_configure (const LinphoneAccountCreator *creator)
LinphoneAccountCreatorCbslinphone_account_creator_cbs_ref (LinphoneAccountCreatorCbs *cbs)
void linphone_account_creator_cbs_unref (LinphoneAccountCreatorCbs *cbs)
void * linphone_account_creator_cbs_get_user_data (const LinphoneAccountCreatorCbs *cbs)
void linphone_account_creator_cbs_set_user_data (LinphoneAccountCreatorCbs *cbs, void *ud)
LinphoneAccountCreatorCbsExistenceTestedCb linphone_account_creator_cbs_get_existence_tested (const LinphoneAccountCreatorCbs *cbs)
void linphone_account_creator_cbs_set_existence_tested (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsExistenceTestedCb cb)
LinphoneAccountCreatorCbsValidationTestedCb linphone_account_creator_cbs_get_validation_tested (const LinphoneAccountCreatorCbs *cbs)
void linphone_account_creator_cbs_set_validation_tested (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsValidationTestedCb cb)
LinphoneAccountCreatorCbsCreateAccountCb linphone_account_creator_cbs_get_create_account (const LinphoneAccountCreatorCbs *cbs)
void linphone_account_creator_cbs_set_create_account (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsCreateAccountCb cb)
LinphoneBufferlinphone_buffer_new (void)
LinphoneBufferlinphone_buffer_new_from_data (const uint8_t *data, size_t size)
LinphoneBufferlinphone_buffer_new_from_string (const char *data)
LinphoneBufferlinphone_buffer_ref (LinphoneBuffer *buffer)
void linphone_buffer_unref (LinphoneBuffer *buffer)
void * linphone_buffer_get_user_data (const LinphoneBuffer *buffer)
void linphone_buffer_set_user_data (LinphoneBuffer *buffer, void *ud)
const uint8_t * linphone_buffer_get_content (const LinphoneBuffer *buffer)
void linphone_buffer_set_content (LinphoneBuffer *buffer, const uint8_t *content, size_t size)
const char * linphone_buffer_get_string_content (const LinphoneBuffer *buffer)
void linphone_buffer_set_string_content (LinphoneBuffer *buffer, const char *content)
size_t linphone_buffer_get_size (const LinphoneBuffer *buffer)
void linphone_buffer_set_size (LinphoneBuffer *buffer, size_t size)
bool_t linphone_buffer_is_empty (const LinphoneBuffer *buffer)
LinphoneContentlinphone_core_create_content (LinphoneCore *lc)
LinphoneContentlinphone_content_ref (LinphoneContent *content)
void linphone_content_unref (LinphoneContent *content)
void * linphone_content_get_user_data (const LinphoneContent *content)
void linphone_content_set_user_data (LinphoneContent *content, void *ud)
const char * linphone_content_get_type (const LinphoneContent *content)
void linphone_content_set_type (LinphoneContent *content, const char *type)
const char * linphone_content_get_subtype (const LinphoneContent *content)
void linphone_content_set_subtype (LinphoneContent *content, const char *subtype)
void * linphone_content_get_buffer (const LinphoneContent *content)
void linphone_content_set_buffer (LinphoneContent *content, const void *buffer, size_t size)
const char * linphone_content_get_string_buffer (const LinphoneContent *content)
void linphone_content_set_string_buffer (LinphoneContent *content, const char *buffer)
size_t linphone_content_get_size (const LinphoneContent *content)
void linphone_content_set_size (LinphoneContent *content, size_t size)
const char * linphone_content_get_encoding (const LinphoneContent *content)
void linphone_content_set_encoding (LinphoneContent *content, const char *encoding)
const char * linphone_content_get_name (const LinphoneContent *content)
void linphone_content_set_name (LinphoneContent *content, const char *name)
bool_t linphone_content_is_multipart (const LinphoneContent *content)
LinphoneContentlinphone_content_get_part (const LinphoneContent *content, int idx)
LinphoneContentlinphone_content_find_part_by_header (const LinphoneContent *content, const char *header_name, const char *header_value)
const char * linphone_content_get_custom_header (const LinphoneContent *content, const char *header_name)
LinphoneDictionary * linphone_dictionary_new ()
LinphoneDictionary * linphone_dictionary_clone (const LinphoneDictionary *src)
LinphoneDictionary * linphone_dictionary_ref (LinphoneDictionary *obj)
void linphone_dictionary_unref (LinphoneDictionary *obj)
void linphone_dictionary_set_int (LinphoneDictionary *obj, const char *key, int value)
int linphone_dictionary_get_int (LinphoneDictionary *obj, const char *key, int default_value)
void linphone_dictionary_set_string (LinphoneDictionary *obj, const char *key, const char *value)
const char * linphone_dictionary_get_string (LinphoneDictionary *obj, const char *key, const char *default_value)
void linphone_dictionary_set_int64 (LinphoneDictionary *obj, const char *key, int64_t value)
int64_t linphone_dictionary_get_int64 (LinphoneDictionary *obj, const char *key, int64_t default_value)
int linphone_dictionary_remove (LinphoneDictionary *obj, const char *key)
void linphone_dictionary_clear (LinphoneDictionary *obj)
int linphone_dictionary_haskey (const LinphoneDictionary *obj, const char *key)
void linphone_dictionary_foreach (const LinphoneDictionary *obj, void(*apply_func)(const char *, void *, void *), void *userdata)
LinphoneDictionary * lp_config_section_to_dict (const LpConfig *lpconfig, const char *section)
void lp_config_load_dict_to_section (LpConfig *lpconfig, const char *section, const LinphoneDictionary *dict)
void linphone_core_set_user_agent (LinphoneCore *lc, const char *name, const char *ver)
int linphone_core_play_local (LinphoneCore *lc, const char *audiofile)
LpConfiglinphone_core_get_config (LinphoneCore *lc)
const char * linphone_reason_to_string (LinphoneReason err)
const char * linphone_configuring_state_to_string (LinphoneConfiguringState cs)
int linphone_core_take_preview_snapshot (LinphoneCore *lc, const char *file)
LpConfiglinphone_core_create_lp_config (LinphoneCore *lc, const char *filename)
void linphone_core_set_file_transfer_server (LinphoneCore *core, const char *server_url)
const char * linphone_core_get_file_transfer_server (LinphoneCore *core)
const char * linphone_transport_to_string (LinphoneTransportType transport)
LinphoneTransportType linphone_transport_parse (const char *transport)
int linphone_dial_plan_lookup_ccc_from_iso (const char *iso)
int linphone_dial_plan_lookup_ccc_from_e164 (const char *e164)
LpConfiglp_config_new (const char *filename)
LpConfiglp_config_new_from_buffer (const char *buffer)
LpConfiglp_config_new_with_factory (const char *config_filename, const char *factory_config_filename)
int lp_config_read_file (LpConfig *lpconfig, const char *filename)
const char * lp_config_get_string (const LpConfig *lpconfig, const char *section, const char *key, const char *default_string)
bctbx_list_t * lp_config_get_string_list (const LpConfig *lpconfig, const char *section, const char *key, bctbx_list_t *default_list)
bool_t lp_config_get_range (const LpConfig *lpconfig, const char *section, const char *key, int *min, int *max, int default_min, int default_max)
int lp_config_get_int (const LpConfig *lpconfig, const char *section, const char *key, int default_value)
int64_t lp_config_get_int64 (const LpConfig *lpconfig, const char *section, const char *key, int64_t default_value)
float lp_config_get_float (const LpConfig *lpconfig, const char *section, const char *key, float default_value)
void lp_config_set_string (LpConfig *lpconfig, const char *section, const char *key, const char *value)
void lp_config_set_string_list (LpConfig *lpconfig, const char *section, const char *key, const bctbx_list_t *value)
void lp_config_set_range (LpConfig *lpconfig, const char *section, const char *key, int min_value, int max_value)
void lp_config_set_int (LpConfig *lpconfig, const char *section, const char *key, int value)
void lp_config_set_int_hex (LpConfig *lpconfig, const char *section, const char *key, int value)
void lp_config_set_int64 (LpConfig *lpconfig, const char *section, const char *key, int64_t value)
void lp_config_set_float (LpConfig *lpconfig, const char *section, const char *key, float value)
int lp_config_sync (LpConfig *lpconfig)
int lp_config_has_section (const LpConfig *lpconfig, const char *section)
void lp_config_clean_section (LpConfig *lpconfig, const char *section)
int lp_config_has_entry (const LpConfig *lpconfig, const char *section, const char *key)
void lp_config_clean_entry (LpConfig *lpconfig, const char *section, const char *key)
void lp_config_for_each_section (const LpConfig *lpconfig, void(*callback)(const char *section, void *ctx), void *ctx)
void lp_config_for_each_entry (const LpConfig *lpconfig, const char *section, void(*callback)(const char *entry, void *ctx), void *ctx)
int lp_config_get_default_int (const LpConfig *lpconfig, const char *section, const char *key, int default_value)
int64_t lp_config_get_default_int64 (const LpConfig *lpconfig, const char *section, const char *key, int64_t default_value)
float lp_config_get_default_float (const LpConfig *lpconfig, const char *section, const char *key, float default_value)
const char * lp_config_get_default_string (const LpConfig *lpconfig, const char *section, const char *key, const char *default_value)
const char * lp_config_get_section_param_string (const LpConfig *lpconfig, const char *section, const char *key, const char *default_value)
LpConfiglp_config_ref (LpConfig *lpconfig)
void lp_config_unref (LpConfig *lpconfig)
char * lp_config_dump_as_xml (const LpConfig *lpconfig)
char * lp_config_dump (const LpConfig *lpconfig)
bool_t lp_config_get_overwrite_flag_for_entry (const LpConfig *lpconfig, const char *section, const char *key)
void lp_config_set_overwrite_flag_for_entry (LpConfig *lpconfig, const char *section, const char *key, bool_t value)
bool_t lp_config_get_overwrite_flag_for_section (const LpConfig *lpconfig, const char *section)
void lp_config_set_overwrite_flag_for_section (LpConfig *lpconfig, const char *section, bool_t value)
bool_t lp_config_get_skip_flag_for_entry (const LpConfig *lpconfig, const char *section, const char *key)
void lp_config_set_skip_flag_for_entry (LpConfig *lpconfig, const char *section, const char *key, bool_t value)
bool_t lp_config_get_skip_flag_for_section (const LpConfig *lpconfig, const char *section)
void lp_config_set_skip_flag_for_section (LpConfig *lpconfig, const char *section, bool_t value)
LinphoneReason linphone_error_info_get_reason (const LinphoneErrorInfo *ei)
const char * linphone_error_info_get_phrase (const LinphoneErrorInfo *ei)
const char * linphone_error_info_get_details (const LinphoneErrorInfo *ei)
int linphone_error_info_get_protocol_code (const LinphoneErrorInfo *ei)
void linphone_core_set_call_error_tone (LinphoneCore *lc, LinphoneReason reason, const char *audiofile)
LinphoneXmlRpcRequestlinphone_xml_rpc_request_new (const char *method, LinphoneXmlRpcArgType return_type)
LinphoneXmlRpcRequestlinphone_xml_rpc_request_new_with_args (const char *method, LinphoneXmlRpcArgType return_type,...)
LinphoneXmlRpcRequestlinphone_xml_rpc_request_ref (LinphoneXmlRpcRequest *request)
void linphone_xml_rpc_request_unref (LinphoneXmlRpcRequest *request)
void * linphone_xml_rpc_request_get_user_data (const LinphoneXmlRpcRequest *request)
void linphone_xml_rpc_request_set_user_data (LinphoneXmlRpcRequest *request, void *ud)
void linphone_xml_rpc_request_add_int_arg (LinphoneXmlRpcRequest *request, int value)
void linphone_xml_rpc_request_add_string_arg (LinphoneXmlRpcRequest *request, const char *value)
LinphoneXmlRpcRequestCbslinphone_xml_rpc_request_get_callbacks (const LinphoneXmlRpcRequest *request)
const char * linphone_xml_rpc_request_get_content (const LinphoneXmlRpcRequest *request)
LinphoneXmlRpcStatus linphone_xml_rpc_request_get_status (const LinphoneXmlRpcRequest *request)
int linphone_xml_rpc_request_get_int_response (const LinphoneXmlRpcRequest *request)
const char * linphone_xml_rpc_request_get_string_response (const LinphoneXmlRpcRequest *request)
LinphoneXmlRpcSessionlinphone_xml_rpc_session_new (LinphoneCore *core, const char *url)
LinphoneXmlRpcSessionlinphone_xml_rpc_session_ref (LinphoneXmlRpcSession *session)
void linphone_xml_rpc_session_unref (LinphoneXmlRpcSession *session)
void * linphone_xml_rpc_session_get_user_data (const LinphoneXmlRpcSession *session)
void linphone_xml_rpc_session_set_user_data (LinphoneXmlRpcSession *session, void *ud)
void linphone_xml_rpc_session_send_request (LinphoneXmlRpcSession *session, LinphoneXmlRpcRequest *request)
LinphoneXmlRpcRequestCbslinphone_xml_rpc_request_cbs_ref (LinphoneXmlRpcRequestCbs *cbs)
void linphone_xml_rpc_request_cbs_unref (LinphoneXmlRpcRequestCbs *cbs)
void * linphone_xml_rpc_request_cbs_get_user_data (const LinphoneXmlRpcRequestCbs *cbs)
void linphone_xml_rpc_request_cbs_set_user_data (LinphoneXmlRpcRequestCbs *cbs, void *ud)
LinphoneXmlRpcRequestCbsResponseCb linphone_xml_rpc_request_cbs_get_response (const LinphoneXmlRpcRequestCbs *cbs)
void linphone_xml_rpc_request_cbs_set_response (LinphoneXmlRpcRequestCbs *cbs, LinphoneXmlRpcRequestCbsResponseCb cb)

Typedef Documentation

The LinphoneAccountCreator object used to create an account on a server via XML-RPC.

An object to handle the callbacks for handling the LinphoneAccountCreator operations.

Callback used to notify the end of a LinphoneAccountCreator validate operation.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]statusThe status of the LinphoneAccountCreator validate operation that has just finished

Callback used to notify the end of a LinphoneAccountCreator test existence operation.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]statusThe status of the LinphoneAccountCreator test existence operation that has just finished

Callback used to notify the end of a LinphoneAccountCreator test validation operation.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]statusThe status of the LinphoneAccountCreator test validation operation that has just finished

Enum describing the status of a LinphoneAccountCreator operation.

The LinphoneContent object representing a data buffer.

The LinphoneContent object holds data that can be embedded in a signaling message.

typedef struct _LinphoneErrorInfo LinphoneErrorInfo

Object representing full details about a signaling error or status. All LinphoneErrorInfo object returned by the liblinphone API are readonly and transcients. For safety they must be used immediately after obtaining them. Any other function call to the liblinphone may change their content or invalidate the pointer.

Enum describing failure reasons.

Enum describing the types of argument for LinphoneXmlRpcRequest.

The LinphoneXmlRpcRequest object representing a XML-RPC request to be sent.

An object to handle the callbacks for handling the LinphoneXmlRpcRequest operations.

Callback used to notify the response to an XML-RPC request.

Parameters:
[in]requestLinphoneXmlRpcRequest object

The LinphoneXmlRpcSession object used to send XML-RPC requests and handle their responses.

Enum describing the status of a LinphoneXmlRpcRequest.

typedef struct _LpConfig LpConfig

The LpConfig object is used to manipulate a configuration file.

The format of the configuration file is a .ini like format:

  • sections are defined in []
  • each section contains a sequence of key=value pairs.

Example:

 [sound]
 echocanceler=1
 playback_dev=ALSA: Default device

 [video]
 enabled=1

Enumeration Type Documentation

Enum describing the status of a LinphoneAccountCreator operation.

Enum describing various failure reasons or contextual information for some events.

See also:
linphone_call_get_reason()
linphone_proxy_config_get_error()
linphone_error_info_get_reason()
Enumerator:
LinphoneReasonNoResponse 

No response received from remote

LinphoneReasonForbidden 

Authentication failed due to bad credentials or resource forbidden

LinphoneReasonDeclined 

The call has been declined

LinphoneReasonNotFound 

Destination of the call was not found.

LinphoneReasonNotAnswered 

The call was not answered in time (request timeout)

LinphoneReasonBusy 

Phone line was busy

LinphoneReasonUnsupportedContent 

Unsupported content

LinphoneReasonIOError 

Transport error: connection failures, disconnections etc...

LinphoneReasonDoNotDisturb 

Do not disturb reason

LinphoneReasonUnauthorized 

Operation is unauthorized because missing credential

LinphoneReasonNotAcceptable 

Operation like call update rejected by peer

LinphoneReasonNoMatch 

Operation could not be executed by server or remote client because it didn't have any context for it

LinphoneReasonMovedPermanently 

Resource moved permanently

LinphoneReasonGone 

Resource no longer exists

LinphoneReasonTemporarilyUnavailable 

Temporarily unavailable

LinphoneReasonAddressIncomplete 

Address incomplete

LinphoneReasonNotImplemented 

Not implemented

LinphoneReasonBadGateway 

Bad gateway

LinphoneReasonServerTimeout 

Server timeout

LinphoneReasonUnknown 

Unknown reason

Enum describing the types of argument for LinphoneXmlRpcRequest.

Enum describing the status of a LinphoneXmlRpcRequest.


Function Documentation

Get the create account callback.

Parameters:
[in]cbsLinphoneAccountCreatorCbs object.
Returns:
The current create account callback.

Get the existence tested callback.

Parameters:
[in]cbsLinphoneAccountCreatorCbs object.
Returns:
The current existence tested callback.

Retrieve the user pointer associated with a LinphoneAccountCreatorCbs object.

Parameters:
[in]cbsLinphoneAccountCreatorCbs object.
Returns:
The user pointer associated with the LinphoneAccountCreatorCbs object.

Get the validation tested callback.

Parameters:
[in]cbsLinphoneAccountCreatorCbs object.
Returns:
The current validation tested callback.

Acquire a reference to a LinphoneAccountCreatorCbs object.

Parameters:
[in]cbsLinphoneAccountCreatorCbs object.
Returns:
The same LinphoneAccountCreatorCbs object.

Set the create account callback.

Parameters:
[in]cbsLinphoneAccountCreatorCbs object.
[in]cbThe create account callback to be used.

Set the existence tested callback.

Parameters:
[in]cbsLinphoneAccountCreatorCbs object.
[in]cbThe existence tested callback to be used.

Assign a user pointer to a LinphoneAccountCreatorCbs object.

Parameters:
[in]cbsLinphoneAccountCreatorCbs object.
[in]udThe user pointer to associate with the LinphoneAccountCreatorCbs object.

Set the validation tested callback.

Parameters:
[in]cbsLinphoneAccountCreatorCbs object.
[in]cbThe validation tested callback to be used.

Release a reference to a LinphoneAccountCreatorCbs object.

Parameters:
[in]cbsLinphoneAccountCreatorCbs object.

Configure an account (create a proxy config and authentication info for it).

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
A LinphoneProxyConfig object if successful, NULL otherwise

Send an XML-RPC request to create a Linphone account.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise

Enable the newsletter subscription.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]subscribeA boolean telling whether to subscribe to the newsletter or not.

Get the LinphoneAccountCreatorCbs object associated with a LinphoneAccountCreator.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
The LinphoneAccountCreatorCbs object associated with the LinphoneAccountCreator.

Get the email.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
The display name of the LinphoneAccountCreator

Get the domain.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
The domain of the LinphoneAccountCreator

Get the email.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
The email of the LinphoneAccountCreator

Get the password.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
The password of the LinphoneAccountCreator

Get the route.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
The route of the LinphoneAccountCreator

Get the transport.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
The transport of the LinphoneAccountCreator

Retrieve the user pointer associated with the LinphoneAccountCreator.

Parameters:
[in]creatorLinphoneAccountCreator object.
Returns:
The user pointer associated with the LinphoneAccountCreator.

Get the username.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
The username of the LinphoneAccountCreator
LinphoneAccountCreator* linphone_account_creator_new ( LinphoneCore core,
const char *  xmlrpc_url 
)

Create a LinphoneAccountCreator.

Parameters:
[in]coreThe LinphoneCore used for the XML-RPC communication
[in]xmlrpc_urlThe URL to the XML-RPC server. Must be NON NULL.
Returns:
The new LinphoneAccountCreator object

Tell whether to subscribe to the newsletter or not.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
A boolean telling whether to subscribe to the newsletter or not.

Acquire a reference to the LinphoneAccountCreator.

Parameters:
[in]creatorLinphoneAccountCreator object.
Returns:
The same LinphoneAccountCreator object.

Set the email.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]display_nameThe display name to set
Returns:
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.

Set the domain.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]domainThe domain to set
Returns:
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.

Set the email.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]emailThe email to set
Returns:
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.

Set the password.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]passwordThe password to set
Returns:
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.

Set the route.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]routeThe route to set
Returns:
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.

Set the transport.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]transportThe transport to set
Returns:
LinphoneAccountCreatorOk if everything is OK, or a specific error if given transport is not supported by linphone core.

Assign a user pointer to the LinphoneAccountCreator.

Parameters:
[in]creatorLinphoneAccountCreator object.
[in]udThe user pointer to associate with the LinphoneAccountCreator.

Set the username.

Parameters:
[in]creatorLinphoneAccountCreator object
[in]usernameThe username to set
Returns:
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.

Send an XML-RPC request to test the existence of a Linphone account.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise

Send an XML-RPC request to test the validation of a Linphone account.

Parameters:
[in]creatorLinphoneAccountCreator object
Returns:
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise

Release reference to the LinphoneAccountCreator.

Parameters:
[in]creatorLinphoneAccountCreator object.
const uint8_t* linphone_buffer_get_content ( const LinphoneBuffer buffer)

Get the content of the data buffer.

Parameters:
[in]bufferLinphoneBuffer object.
Returns:
The content of the data buffer.
size_t linphone_buffer_get_size ( const LinphoneBuffer buffer)

Get the size of the content of the data buffer.

Parameters:
[in]bufferLinphoneBuffer object.
Returns:
The size of the content of the data buffer.
const char* linphone_buffer_get_string_content ( const LinphoneBuffer buffer)

Get the string content of the data buffer.

Parameters:
[in]bufferLinphoneBuffer object
Returns:
The string content of the data buffer.
void* linphone_buffer_get_user_data ( const LinphoneBuffer buffer)

Retrieve the user pointer associated with the buffer.

Parameters:
[in]bufferLinphoneBuffer object.
Returns:
The user pointer associated with the buffer.
bool_t linphone_buffer_is_empty ( const LinphoneBuffer buffer)

Tell whether the LinphoneBuffer is empty.

Parameters:
[in]bufferLinphoneBuffer object
Returns:
A boolean value telling whether the LinphoneBuffer is empty or not.

Create a new empty LinphoneBuffer object.

Returns:
A new LinphoneBuffer object.
LinphoneBuffer* linphone_buffer_new_from_data ( const uint8_t *  data,
size_t  size 
)

Create a new LinphoneBuffer object from existing data.

Parameters:
[in]dataThe initial data to store in the LinphoneBuffer.
[in]sizeThe size of the initial data to stroe in the LinphoneBuffer.
Returns:
A new LinphoneBuffer object.

Create a new LinphoneBuffer object from a string.

Parameters:
[in]dataThe initial string content of the LinphoneBuffer.
Returns:
A new LinphoneBuffer object.

Acquire a reference to the buffer.

Parameters:
[in]bufferLinphoneBuffer object.
Returns:
The same LinphoneBuffer object.
void linphone_buffer_set_content ( LinphoneBuffer buffer,
const uint8_t *  content,
size_t  size 
)

Set the content of the data buffer.

Parameters:
[in]bufferLinphoneBuffer object.
[in]contentThe content of the data buffer.
[in]sizeThe size of the content of the data buffer.
void linphone_buffer_set_size ( LinphoneBuffer buffer,
size_t  size 
)

Set the size of the content of the data buffer.

Parameters:
[in]bufferLinphoneBuffer object
[in]sizeThe size of the content of the data buffer.
void linphone_buffer_set_string_content ( LinphoneBuffer buffer,
const char *  content 
)

Set the string content of the data buffer.

Parameters:
[in]bufferLinphoneBuffer object.
[in]contentThe string content of the data buffer.
void linphone_buffer_set_user_data ( LinphoneBuffer buffer,
void *  ud 
)

Assign a user pointer to the buffer.

Parameters:
[in]bufferLinphoneBuffer object.
[in]udThe user pointer to associate with the buffer.

Release reference to the buffer.

Parameters:
[in]bufferLinphoneBuffer object.

Converts a _LinphoneConfiguringState enum to a string.

LinphoneContent* linphone_content_find_part_by_header ( const LinphoneContent content,
const char *  header_name,
const char *  header_value 
)

Find a part from a multipart content looking for a part header with a specified value.

Parameters:
[in]contentLinphoneContent object.
[in]header_nameThe name of the header to look for.
[in]header_valueThe value of the header to look for.
Returns:
A LinphoneContent object object the part if found, NULL otherwise.
void* linphone_content_get_buffer ( const LinphoneContent content)

Get the content data buffer, usually a string.

Parameters:
[in]contentLinphoneContent object.
Returns:
The content data buffer.
const char* linphone_content_get_custom_header ( const LinphoneContent content,
const char *  header_name 
)

Get a custom header value of a content.

Parameters:
[in]contentLinphoneContent object.
[in]header_nameThe name of the header to get the value from.
Returns:
The value of the header if found, NULL otherwise.
const char* linphone_content_get_encoding ( const LinphoneContent content)

Get the encoding of the data buffer, for example "gzip".

Parameters:
[in]contentLinphoneContent object.
Returns:
The encoding of the data buffer.
const char* linphone_content_get_name ( const LinphoneContent content)

Get the name associated with a RCS file transfer message. It is used to store the original filename of the file to be downloaded from server.

Parameters:
[in]contentLinphoneContent object.
Returns:
The name of the content.
LinphoneContent* linphone_content_get_part ( const LinphoneContent content,
int  idx 
)

Get a part from a multipart content according to its index.

Parameters:
[in]contentLinphoneContent object.
[in]idxThe index of the part to get.
Returns:
A LinphoneContent object holding the part if found, NULL otherwise.
size_t linphone_content_get_size ( const LinphoneContent content)

Get the content data buffer size, excluding null character despite null character is always set for convenience.

Parameters:
[in]contentLinphoneContent object.
Returns:
The content data buffer size.
const char* linphone_content_get_string_buffer ( const LinphoneContent content)

Get the string content data buffer.

Parameters:
[in]contentLinphoneContent object
Returns:
The string content data buffer.
const char* linphone_content_get_subtype ( const LinphoneContent content)

Get the mime subtype of the content data.

Parameters:
[in]contentLinphoneContent object.
Returns:
The mime subtype of the content data, for example "html".
const char* linphone_content_get_type ( const LinphoneContent content)

Get the mime type of the content data.

Parameters:
[in]contentLinphoneContent object.
Returns:
The mime type of the content data, for example "application".
void* linphone_content_get_user_data ( const LinphoneContent content)

Retrieve the user pointer associated with the content.

Parameters:
[in]contentLinphoneContent object.
Returns:
The user pointer associated with the content.
bool_t linphone_content_is_multipart ( const LinphoneContent content)

Tell whether a content is a multipart content.

Parameters:
[in]contentLinphoneContent object.
Returns:
A boolean value telling whether the content is multipart or not.

Acquire a reference to the content.

Parameters:
[in]contentLinphoneContent object.
Returns:
The same LinphoneContent object.
void linphone_content_set_buffer ( LinphoneContent content,
const void *  buffer,
size_t  size 
)

Set the content data buffer, usually a string.

Parameters:
[in]contentLinphoneContent object.
[in]bufferThe content data buffer.
[in]sizeThe size of the content data buffer.
void linphone_content_set_encoding ( LinphoneContent content,
const char *  encoding 
)

Set the encoding of the data buffer, for example "gzip".

Parameters:
[in]contentLinphoneContent object.
[in]encodingThe encoding of the data buffer.
void linphone_content_set_name ( LinphoneContent content,
const char *  name 
)

Set the name associated with a RCS file transfer message. It is used to store the original filename of the file to be downloaded from server.

Parameters:
[in]contentLinphoneContent object.
[in]nameThe name of the content.
void linphone_content_set_size ( LinphoneContent content,
size_t  size 
)

Set the content data size, excluding null character despite null character is always set for convenience.

Parameters:
[in]contentLinphoneContent object
[in]sizeThe content data buffer size.
void linphone_content_set_string_buffer ( LinphoneContent content,
const char *  buffer 
)

Set the string content data buffer.

Parameters:
[in]contentLinphoneContent object.
[in]bufferThe string content data buffer.
void linphone_content_set_subtype ( LinphoneContent content,
const char *  subtype 
)

Set the mime subtype of the content data.

Parameters:
[in]contentLinphoneContent object.
[in]subtypeThe mime subtype of the content data, for example "html".
void linphone_content_set_type ( LinphoneContent content,
const char *  type 
)

Set the mime type of the content data.

Parameters:
[in]contentLinphoneContent object.
[in]typeThe mime type of the content data, for example "application".
void linphone_content_set_user_data ( LinphoneContent content,
void *  ud 
)

Assign a user pointer to the content.

Parameters:
[in]contentLinphoneContent object.
[in]udThe user pointer to associate with the content.

Release reference to the content.

Parameters:
[in]contentLinphoneContent object.

Create a content with default values from Linphone core.

Parameters:
[in]lcLinphoneCore object
Returns:
LinphoneContent object with default values set
LpConfig* linphone_core_create_lp_config ( LinphoneCore lc,
const char *  filename 
)

Create a LpConfig object from a user config file.

Parameters:
[in]lcLinphoneCore object
[in]filenameThe filename of the config file to read to fill the instantiated LpConfig

Returns the LpConfig object used to manage the storage (config) file.

The application can use the LpConfig object to insert its own private sections and pairs of key=value in the configuration file.

Get the globaly set http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml.

Parameters:
[in]coreLinphoneCore from which to get the server_url
Returns:
URL of the file server like https://file.linphone.org/upload.php
int linphone_core_play_local ( LinphoneCore lc,
const char *  audiofile 
)

Plays an audio file to the local user. This function works at any time, during calls, or when no calls are running. It doesn't request the underlying audio system to support multiple playback streams.

Parameters:
lcthe linphone core
audiofilepath to audio file in wav PCM 16 bit format.
void linphone_core_set_call_error_tone ( LinphoneCore lc,
LinphoneReason  reason,
const char *  audiofile 
)

Assign an audio file to be played locally upon call failure, for a given reason.

Parameters:
lcthe core
reasonthe LinphoneReason representing the failure error code.
audiofilea wav file to be played when such call failure happens.
void linphone_core_set_file_transfer_server ( LinphoneCore core,
const char *  server_url 
)

Globaly set an http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml. This value can also be set for a dedicated account using linphone_proxy_config_set_file_transfer_server

Parameters:
[in]coreLinphoneCore to be modified
[in]server_urlURL of the file server like https://file.linphone.org/upload.php
void linphone_core_set_user_agent ( LinphoneCore lc,
const char *  name,
const char *  ver 
)

Sets the user agent string used in SIP messages.

int linphone_core_take_preview_snapshot ( LinphoneCore lc,
const char *  file 
)

Take a photo of currently from capture device and write it into a jpeg file. Note that the snapshot is asynchronous, an application shall not assume that the file is created when the function returns.

Parameters:
lcthe linphone core
filea path where to write the jpeg content.
Returns:
0 if successfull, -1 otherwise (typically if jpeg format is not supported).
int linphone_dial_plan_lookup_ccc_from_e164 ( const char *  e164)

Function to get call country code from an e164 number, ex: +33952650121 will return 33

Parameters:
e164phone number
Returns:
call country code or -1 if not found
int linphone_dial_plan_lookup_ccc_from_iso ( const char *  iso)

Function to get call country code from ISO 3166-1 alpha-2 code, ex: FR returns 33

Parameters:
isocountry code alpha2
Returns:
call country code or -1 if not found

Provides additional information regarding the failure. With SIP protocol, the "Reason" and "Warning" headers are returned.

Parameters:
eithe error info.
Returns:
more details about the failure.

Get textual phrase from the error info. This is the text that is provided by the peer in the protocol (SIP).

Parameters:
eithe error info.
Returns:
the error phrase

Get the status code from the low level protocol (ex a SIP status code).

Parameters:
eithe error info.
Returns:
the status code.

Get reason code from the error info.

Parameters:
eithe error info.
Returns:
a LinphoneReason

Converts a LinphoneReason enum to a string.

LinphoneTransportType linphone_transport_parse ( const char *  transport)

Converts a lowercase string to a LinphoneTransportType enum.

Returns:
Transport matching input, or LinphoneTransportUdp if nothing is found

Converts a LinphoneTransportType enum to a lowercase string.

void linphone_xml_rpc_request_add_int_arg ( LinphoneXmlRpcRequest request,
int  value 
)

Add an integer argument to an XML-RPC request.

Parameters:
[in]requestLinphoneXmlRpcRequest object.
[in]valueThe integer value of the added argument.
void linphone_xml_rpc_request_add_string_arg ( LinphoneXmlRpcRequest request,
const char *  value 
)

Add a string argument to an XML-RPC request.

Parameters:
[in]requestLinphoneXmlRpcRequest object.
[in]valueThe string value of the added argument.

Get the response callback.

Parameters:
[in]cbsLinphoneXmlRpcRequestCbs object.
Returns:
The current response callback.

Retrieve the user pointer associated with a LinphoneXmlRpcRequestCbs object.

Parameters:
[in]cbsLinphoneXmlRpcRequestCbs object.
Returns:
The user pointer associated with the LinphoneXmlRpcRequestCbs object.

Acquire a reference to a LinphoneXmlRpcRequestCbs object.

Parameters:
[in]cbsLinphoneXmlRpcRequestCbs object.
Returns:
The same LinphoneXmlRpcRequestCbs object.

Set the response callback.

Parameters:
[in]cbsLinphoneXmlRpcRequestCbs object.
[in]cbThe response callback to be used.

Assign a user pointer to a LinphoneXmlRpcRequestCbs object.

Parameters:
[in]cbsLinphoneXmlRpcRequestCbs object.
[in]udThe user pointer to associate with the LinphoneXmlRpcRequestCbs object.

Release a reference to a LinphoneXmlRpcRequestCbs object.

Parameters:
[in]cbsLinphoneXmlRpcRequestCbs object.

Get the LinphoneXmlRpcRequestCbs object associated with a LinphoneXmlRpcRequest.

Parameters:
[in]requestLinphoneXmlRpcRequest object
Returns:
The LinphoneXmlRpcRequestCbs object associated with the LinphoneXmlRpcRequest.

Get the content of the XML-RPC request.

Parameters:
[in]requestLinphoneXmlRpcRequest object.
Returns:
The string representation of the content of the XML-RPC request.

Get the response to an XML-RPC request sent with linphone_xml_rpc_session_send_request() and returning an integer response.

Parameters:
[in]requestLinphoneXmlRpcRequest object.
Returns:
The integer response to the XML-RPC request.

Get the status of the XML-RPC request.

Parameters:
[in]requestLinphoneXmlRpcRequest object.
Returns:
The status of the XML-RPC request.

Get the response to an XML-RPC request sent with linphone_xml_rpc_session_send_request() and returning a string response.

Parameters:
[in]requestLinphoneXmlRpcRequest object.
Returns:
The string response to the XML-RPC request.

Retrieve the user pointer associated with the XML-RPC request.

Parameters:
[in]requestLinphoneXmlRpcRequest object.
Returns:
The user pointer associated with the XML-RPC request.
LinphoneXmlRpcRequest* linphone_xml_rpc_request_new ( const char *  method,
LinphoneXmlRpcArgType  return_type 
)

Create a new LinphoneXmlRpcRequest object.

Parameters:
[in]methodThe XML-RPC method to call.
[in]return_typeThe expected XML-RPC response type.
Returns:
A new LinphoneXmlRpcRequest object.
LinphoneXmlRpcRequest* linphone_xml_rpc_request_new_with_args ( const char *  method,
LinphoneXmlRpcArgType  return_type,
  ... 
)

Create a new LinphoneXmlRpcRequest object giving the arguments to the method call.

Parameters:
[in]methodThe XML-RPC method to call.
[in]return_typeThe expected XML-RPC response type.
Returns:
A new LinphoneXmlRpcRequest object.

Acquire a reference to the XML-RPC request.

Parameters:
[in]requestLinphoneXmlRpcRequest object.
Returns:
The same LinphoneXmlRpcRequest object.

Assign a user pointer to the XML-RPC request.

Parameters:
[in]requestLinphoneXmlRpcRequest object.
[in]udThe user pointer to associate with the XML-RPC request.

Release reference to the XML-RPC request.

Parameters:
[in]requestLinphoneXmlRpcRequest object.

Retrieve the user pointer associated with the XML-RPC session.

Parameters:
[in]sessionLinphoneXmlRpcSession object.
Returns:
The user pointer associated with the XML-RPC session.

Create a new LinphoneXmlRpcSession object.

Parameters:
[in]coreThe LinphoneCore object used to send the XML-RPC requests.
[in]urlThe URL of the XML-RPC server to send the XML-RPC requests to.
Returns:
A new LinphoneXmlRpcSession object.

Acquire a reference to the XML-RPC session.

Parameters:
[in]sessionLinphoneXmlRpcSession object.
Returns:
The same LinphoneXmlRpcSession object.

Send an XML-RPC request.

Parameters:
[in]sessionLinphoneXmlRpcSession object.
[in]requestThe LinphoneXmlRpcRequest to be sent.

Assign a user pointer to the XML-RPC session.

Parameters:
[in]sessionLinphoneXmlRpcSession object.
[in]udThe user pointer to associate with the XML-RPC session.

Release reference to the XML-RPC session.

Parameters:
[in]sessionLinphoneXmlRpcSession object.
void lp_config_clean_entry ( LpConfig lpconfig,
const char *  section,
const char *  key 
)

Removes entries for key,value in a section.

Parameters:
[in]lpconfigThe LpConfig object
[in]section
[in]key
void lp_config_clean_section ( LpConfig lpconfig,
const char *  section 
)

Removes every pair of key,value in a section and remove the section.

char* lp_config_dump ( const LpConfig lpconfig)

Dumps the LpConfig as INI into a buffer

Parameters:
[in]lpconfigThe LpConfig object
Returns:
The buffer that contains the config dump
char* lp_config_dump_as_xml ( const LpConfig lpconfig)

Dumps the LpConfig as XML into a buffer

Parameters:
[in]lpconfigThe LpConfig object
Returns:
The buffer that contains the XML dump
void lp_config_for_each_entry ( const LpConfig lpconfig,
const char *  section,
void(*)(const char *entry, void *ctx)  callback,
void *  ctx 
)

Call a function for each entry present in a section configuration.

void lp_config_for_each_section ( const LpConfig lpconfig,
void(*)(const char *section, void *ctx)  callback,
void *  ctx 
)

Call a function for each section present in the configuration.

float lp_config_get_default_float ( const LpConfig lpconfig,
const char *  section,
const char *  key,
float  default_value 
)

Retrieves a default configuration item as a float, given its section, key, and default value.

The default float value is returned if the config item isn't found.

int lp_config_get_default_int ( const LpConfig lpconfig,
const char *  section,
const char *  key,
int  default_value 
)

Retrieves a default configuration item as an integer, given its section, key, and default value.

The default integer value is returned if the config item isn't found.

int64_t lp_config_get_default_int64 ( const LpConfig lpconfig,
const char *  section,
const char *  key,
int64_t  default_value 
)

Retrieves a default configuration item as a 64 bit integer, given its section, key, and default value.

The default integer value is returned if the config item isn't found.

const char* lp_config_get_default_string ( const LpConfig lpconfig,
const char *  section,
const char *  key,
const char *  default_value 
)

Retrieves a default configuration item as a string, given its section, key, and default value.

The default value string is returned if the config item isn't found.

float lp_config_get_float ( const LpConfig lpconfig,
const char *  section,
const char *  key,
float  default_value 
)

Retrieves a configuration item as a float, given its section, key, and default value.

The default float value is returned if the config item isn't found.

int lp_config_get_int ( const LpConfig lpconfig,
const char *  section,
const char *  key,
int  default_value 
)

Retrieves a configuration item as an integer, given its section, key, and default value.

The default integer value is returned if the config item isn't found.

int64_t lp_config_get_int64 ( const LpConfig lpconfig,
const char *  section,
const char *  key,
int64_t  default_value 
)

Retrieves a configuration item as a 64 bit integer, given its section, key, and default value.

The default integer value is returned if the config item isn't found.

bool_t lp_config_get_overwrite_flag_for_entry ( const LpConfig lpconfig,
const char *  section,
const char *  key 
)

Retrieves the overwrite flag for a config item

bool_t lp_config_get_overwrite_flag_for_section ( const LpConfig lpconfig,
const char *  section 
)

Retrieves the overwrite flag for a config section

bool_t lp_config_get_range ( const LpConfig lpconfig,
const char *  section,
const char *  key,
int *  min,
int *  max,
int  default_min,
int  default_max 
)

Retrieves a configuration item as a range, given its section, key, and default min and max values.

Returns:
TRUE if the value is successfully parsed as a range, FALSE otherwise. If FALSE is returned, min and max are filled respectively with default_min and default_max values.
const char* lp_config_get_section_param_string ( const LpConfig lpconfig,
const char *  section,
const char *  key,
const char *  default_value 
)

Retrieves a section parameter item as a string, given its section and key.

The default value string is returned if the config item isn't found.

bool_t lp_config_get_skip_flag_for_entry ( const LpConfig lpconfig,
const char *  section,
const char *  key 
)

Retrieves the skip flag for a config item

bool_t lp_config_get_skip_flag_for_section ( const LpConfig lpconfig,
const char *  section 
)

Retrieves the skip flag for a config section

const char* lp_config_get_string ( const LpConfig lpconfig,
const char *  section,
const char *  key,
const char *  default_string 
)

Retrieves a configuration item as a string, given its section, key, and default value.

The default value string is returned if the config item isn't found.

bctbx_list_t* lp_config_get_string_list ( const LpConfig lpconfig,
const char *  section,
const char *  key,
bctbx_list_t *  default_list 
)

Retrieves a configuration item as a list of strings, given its section, key, and default value. The default value is returned if the config item is not found.

Parameters:
[in]lpconfigA LpConfig object
[in]sectionThe section from which to retrieve a configuration item
[in]keyThe name of the configuration item to retrieve
[in]default_listA list of const char * objects.
Returns:
A list of const char * objects.
int lp_config_has_entry ( const LpConfig lpconfig,
const char *  section,
const char *  key 
)

Returns 1 if a given section with a given key is present in the configuration.

Parameters:
[in]lpconfigThe LpConfig object
[in]section
[in]key
int lp_config_has_section ( const LpConfig lpconfig,
const char *  section 
)

Returns 1 if a given section is present in the configuration.

void lp_config_load_dict_to_section ( LpConfig lpconfig,
const char *  section,
const LinphoneDictionary *  dict 
)

Loads a dictionary into a section of the lpconfig. If the section doesn't exist it is created. Overwrites existing keys, creates non-existing keys.

LpConfig* lp_config_new ( const char *  filename)

Instantiates a LpConfig object from a user config file. The caller of this constructor owns a reference. lp_config_unref() must be called when this object is no longer needed.

Parameters:
filenamethe filename of the config file to read to fill the instantiated LpConfig
See also:
lp_config_new_with_factory
LpConfig* lp_config_new_from_buffer ( const char *  buffer)

Instantiates a LpConfig object from a user provided buffer. The caller of this constructor owns a reference. lp_config_unref() must be called when this object is no longer needed.

Parameters:
bufferthe buffer from which the lpconfig will be retrieved. We expect the buffer to be null-terminated.
See also:
lp_config_new_with_factory
lp_config_new
LpConfig* lp_config_new_with_factory ( const char *  config_filename,
const char *  factory_config_filename 
)

Instantiates a LpConfig object from a user config file and a factory config file. The caller of this constructor owns a reference. lp_config_unref() must be called when this object is no longer needed.

Parameters:
config_filenamethe filename of the user config file to read to fill the instantiated LpConfig
factory_config_filenamethe filename of the factory config file to read to fill the instantiated LpConfig
See also:
lp_config_new

The user config file is read first to fill the LpConfig and then the factory config file is read. Therefore the configuration parameters defined in the user config file will be overwritten by the parameters defined in the factory config file.

int lp_config_read_file ( LpConfig lpconfig,
const char *  filename 
)

Reads a user config file and fill the LpConfig with the read config values.

Parameters:
lpconfigThe LpConfig object to fill with the content of the file
filenameThe filename of the config file to read to fill the LpConfig
LpConfig* lp_config_ref ( LpConfig lpconfig)

increment reference count

LinphoneDictionary * lp_config_section_to_dict ( const LpConfig lpconfig,
const char *  section 
)

Converts a config section into a dictionary.

Returns:
a #LinphoneDictionary with all the keys from a section, or NULL if the section doesn't exist
void lp_config_set_float ( LpConfig lpconfig,
const char *  section,
const char *  key,
float  value 
)

Sets a float config item

void lp_config_set_int ( LpConfig lpconfig,
const char *  section,
const char *  key,
int  value 
)

Sets an integer config item

void lp_config_set_int64 ( LpConfig lpconfig,
const char *  section,
const char *  key,
int64_t  value 
)

Sets a 64 bits integer config item

void lp_config_set_int_hex ( LpConfig lpconfig,
const char *  section,
const char *  key,
int  value 
)

Sets an integer config item, but store it as hexadecimal

void lp_config_set_overwrite_flag_for_entry ( LpConfig lpconfig,
const char *  section,
const char *  key,
bool_t  value 
)

Sets the overwrite flag for a config item (used when dumping config as xml)

void lp_config_set_overwrite_flag_for_section ( LpConfig lpconfig,
const char *  section,
bool_t  value 
)

Sets the overwrite flag for a config section (used when dumping config as xml)

void lp_config_set_range ( LpConfig lpconfig,
const char *  section,
const char *  key,
int  min_value,
int  max_value 
)

Sets a range config item

void lp_config_set_skip_flag_for_entry ( LpConfig lpconfig,
const char *  section,
const char *  key,
bool_t  value 
)

Sets the skip flag for a config item (used when dumping config as xml)

void lp_config_set_skip_flag_for_section ( LpConfig lpconfig,
const char *  section,
bool_t  value 
)

Sets the skip flag for a config section (used when dumping config as xml)

void lp_config_set_string ( LpConfig lpconfig,
const char *  section,
const char *  key,
const char *  value 
)

Sets a string config item

void lp_config_set_string_list ( LpConfig lpconfig,
const char *  section,
const char *  key,
const bctbx_list_t *  value 
)

Sets a string list config item

Parameters:
[in]lpconfigA LpConfig object
[in]sectionThe name of the section to put the configuration item into
[in]keyThe name of the configuration item to set
[in]valueA list of const char * objects. The value to set
int lp_config_sync ( LpConfig lpconfig)

Writes the config file to disk.

void lp_config_unref ( LpConfig lpconfig)

Decrement reference count, which will eventually free the object.