Macros
#define	LINPHONE_CONFIG(obj) BELLE_SIP_CAST(obj, LinphoneConfig);
	Safely downcast a belle_sip_object into LinphoneConfig.

#define	lp_config_section_to_dict linphone_config_section_to_dict

#define	lp_config_load_dict_to_section linphone_config_load_dict_to_section

Functions
MS2_DEPRECATED int	linphone_core_start_echo_calibration (LinphoneCore lc, LinphoneEcCalibrationCallback cb, LinphoneEcCalibrationAudioInit audio_init_cb, LinphoneEcCalibrationAudioUninit audio_uninit_cb, void cb_data)
	Starts an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically. More...

LinphoneStatus	linphone_core_start_echo_canceller_calibration (LinphoneCore *core)
	Starts an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically. More...

LinphoneStatus	linphone_core_start_echo_tester (LinphoneCore *core, unsigned int rate)
	Start the simulation of call to test the latency with an external device. More...

LinphoneStatus	linphone_core_stop_echo_tester (LinphoneCore *core)
	Stop the simulation of call. More...

bool_t	linphone_core_has_crappy_opengl (LinphoneCore *core)
	Check whether the device is flagged has crappy opengl. More...

bool_t	linphone_core_has_builtin_echo_canceller (LinphoneCore *core)
	Check whether the device has a hardware echo canceller. More...

bool_t	linphone_core_is_echo_canceller_calibration_required (LinphoneCore *core)
	Check whether the device is echo canceller calibration is required. More...

LinphoneErrorInfo *	linphone_error_info_new (void)
	Create an empty LinphoneErrorInfo object. More...

LinphoneErrorInfo *	linphone_error_info_ref (LinphoneErrorInfo *error_info)
	Increment refcount. More...

void	linphone_error_info_unref (LinphoneErrorInfo *error_info)
	Decrement refcount and possibly free the object. More...

int	linphone_error_info_get_retry_after (const LinphoneErrorInfo *error_info)
	Get Retry-After delay second from the error info. More...

LinphoneReason	linphone_error_info_get_reason (const LinphoneErrorInfo *error_info)
	Get reason code from the error info. More...

LinphoneErrorInfo *	linphone_error_info_get_sub_error_info (const LinphoneErrorInfo *error_info)
	Get pointer to chained LinphoneErrorInfo set in sub_ei. More...

const char *	linphone_error_info_get_phrase (const LinphoneErrorInfo *error_info)
	Get textual phrase from the error info. More...

const char *	linphone_error_info_get_protocol (const LinphoneErrorInfo *error_info)
	Get protocol from the error info. More...

const char *	linphone_error_info_get_warnings (const LinphoneErrorInfo *error_info)
	Provides additional information regarding the failure. More...

int	linphone_error_info_get_protocol_code (const LinphoneErrorInfo *error_info)
	Get the status code from the low level protocol (ex a SIP status code). More...

void	linphone_error_info_set (LinphoneErrorInfo error_info, const char protocol, LinphoneReason reason, int code, const char status, const char warning)
	Assign information to a LinphoneErrorInfo object. More...

void	linphone_error_info_set_sub_error_info (LinphoneErrorInfo error_info, LinphoneErrorInfo appended_error_info)
	Set the sub_ei in LinphoneErrorInfo to another LinphoneErrorInfo. More...

void	linphone_error_info_set_retry_after (LinphoneErrorInfo *error_info, int retry_after)
	Assign retry-after value to a LinphoneErrorInfo object. More...

void	linphone_error_info_set_reason (LinphoneErrorInfo *error_info, LinphoneReason reason)
	Assign reason LinphoneReason to a LinphoneErrorInfo object. More...

void	linphone_error_info_set_protocol (LinphoneErrorInfo error_info, const char protocol)
	Assign protocol name to a LinphoneErrorInfo object. More...

void	linphone_error_info_set_protocol_code (LinphoneErrorInfo *error_info, int code)
	Assign protocol code to a LinphoneErrorInfo object. More...

void	linphone_error_info_set_phrase (LinphoneErrorInfo error_info, const char phrase)
	Assign phrase to a LinphoneErrorInfo object. More...

void	linphone_error_info_set_warnings (LinphoneErrorInfo error_info, const char warnings)
	Assign warnings to a LinphoneErrorInfo object. More...

LinphoneHeaders *	linphone_headers_ref (LinphoneHeaders *obj)
	Increments ref count.

void	linphone_headers_unref (LinphoneHeaders *obj)
	Decrements ref count.

const char *	linphone_headers_get_value (const LinphoneHeaders headers, const char header_name)
	Search for a given header name and return its value. More...

void	linphone_headers_add (LinphoneHeaders headers, const char name, const char *value)
	Add given header name and corresponding value. More...

void	linphone_headers_remove (LinphoneHeaders headers, const char name)
	Add given header name and corresponding value. More...

void	linphone_info_message_add_header (LinphoneInfoMessage info_message, const char name, const char *value)
	Add a header to an info message to be sent. More...

const char *	linphone_info_message_get_header (const LinphoneInfoMessage info_message, const char name)
	Obtain a header value from a received info message. More...

void	linphone_info_message_set_content (LinphoneInfoMessage info_message, const LinphoneContent content)
	Assign a content to the info message. More...

const LinphoneContent *	linphone_info_message_get_content (const LinphoneInfoMessage *info_message)
	Returns the info message's content as a LinphoneContent structure. More...

LinphoneInfoMessage *	linphone_info_message_ref (LinphoneInfoMessage *info_message)
	Take a reference on a LinphoneInfoMessage. More...

void	linphone_info_message_unref (LinphoneInfoMessage *info_message)
	Release a reference on a LinphoneInfoMessage. More...

LinphoneInfoMessage *	linphone_info_message_copy (const LinphoneInfoMessage *info_message)

LinphoneConfig *	linphone_config_new (const char *filename)
	Instantiates a LinphoneConfig object from a user config file. More...

LinphoneConfig *	linphone_config_new_from_buffer (const char *buffer)
	Instantiates a LinphoneConfig object from a user provided buffer. More...

LinphoneConfig *	linphone_config_new_with_factory (const char config_filename, const char factory_config_filename)
	Instantiates a LinphoneConfig object from a user config file and a factory config file. More...

LinphoneConfig *	linphone_config_new_for_shared_core (const char app_group_id, const char config_filename, const char *factory_config_filename)
	Instantiates a LinphoneConfig object from a user config file name, group id and a factory config file. More...

LinphoneStatus	linphone_config_read_file (LinphoneConfig config, const char filename)
	Reads a user config file and fill the LinphoneConfig with the read config values. More...

const char *	linphone_config_load_from_xml_file (LinphoneConfig config, const char filename)
	Reads a xml config file and fill the LinphoneConfig with the read config dynamic values. More...

LinphoneStatus	linphone_config_load_from_xml_string (LinphoneConfig config, const char buffer)
	Reads a xml config string and fill the LinphoneConfig with the read config dynamic values. More...

const char *	linphone_config_get_filename (const LinphoneConfig *config)
	Returns the filename used to store the user config. More...

const char *	linphone_config_get_factory_filename (const LinphoneConfig *config)
	Returns the filename that was used as the factory config. More...

const char *	linphone_config_get_temporary_filename (const LinphoneConfig *config)
	Returns the temporary filename used to store the user config. More...

const char *	linphone_config_get_string (const LinphoneConfig config, const char section, const char key, const char default_string)
	Retrieves a configuration item as a string, given its section, key, and default value. More...

bctbx_list_t *	linphone_config_get_string_list (const LinphoneConfig config, 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. More...

bool_t	linphone_config_get_range (const LinphoneConfig config, 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. More...

int	linphone_config_get_int (const LinphoneConfig config, const char section, const char *key, int default_value)
	Retrieves a configuration item as an integer, given its section, key, and default value. More...

bool_t	linphone_config_get_bool (const LinphoneConfig config, const char section, const char *key, bool_t default_value)
	Retrieves a configuration item as a boolean, given its section, key, and default value. More...

int64_t	linphone_config_get_int64 (const LinphoneConfig config, 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. More...

float	linphone_config_get_float (const LinphoneConfig config, const char section, const char *key, float default_value)
	Retrieves a configuration item as a float, given its section, key, and default value. More...

void	linphone_config_set_string (LinphoneConfig config, const char section, const char key, const char value)
	Sets a string config item. More...

void	linphone_config_set_string_list (LinphoneConfig config, const char section, const char key, const bctbx_list_t value)
	Sets a string list config item. More...

void	linphone_config_set_range (LinphoneConfig config, const char section, const char *key, int min_value, int max_value)
	Sets a range config item. More...

void	linphone_config_set_int (LinphoneConfig config, const char section, const char *key, int value)
	Sets an integer config item. More...

void	linphone_config_set_bool (LinphoneConfig config, const char section, const char *key, bool_t value)
	Sets a boolean config item. More...

void	linphone_config_set_int_hex (LinphoneConfig config, const char section, const char *key, int value)
	Sets an integer config item, but store it as hexadecimal. More...

void	linphone_config_set_int64 (LinphoneConfig config, const char section, const char *key, int64_t value)
	Sets a 64 bits integer config item. More...

void	linphone_config_set_float (LinphoneConfig config, const char section, const char *key, float value)
	Sets a float config item. More...

LinphoneStatus	linphone_config_sync (LinphoneConfig *config)
	Writes the config file to disk. More...

void	linphone_config_reload (LinphoneConfig *config)
	Reload the config from the file. More...

int	linphone_config_has_section (const LinphoneConfig config, const char section)
	Returns if a given section is present in the configuration. More...

void	linphone_config_clean_section (LinphoneConfig config, const char section)
	Removes every pair of key,value in a section and remove the section. More...

int	linphone_config_has_entry (const LinphoneConfig config, const char section, const char *key)
	Returns if a given section with a given key is present in the configuration. More...

void	linphone_config_clean_entry (LinphoneConfig config, const char section, const char *key)
	Removes entries for key,value in a section. More...

bctbx_list_t *	linphone_config_get_sections_names_list (LinphoneConfig *config)
	Returns the list of sections' names in the LinphoneConfig. More...

bctbx_list_t *	linphone_config_get_keys_names_list (LinphoneConfig config, const char section)
	Returns the list of keys' names for a section in the LinphoneConfig. More...

void	linphone_config_for_each_section (const LinphoneConfig config, void(callback)(const char section, void ctx), void *ctx)
	Call a function for each section present in the configuration. More...

void	linphone_config_for_each_entry (const LinphoneConfig config, const char section, void(callback)(const char entry, void ctx), void ctx)
	Call a function for each entry present in a section configuration. More...

bool_t	linphone_config_needs_commit (const LinphoneConfig *config)

void	linphone_config_destroy (LinphoneConfig *cfg)

int	linphone_config_get_default_int (const LinphoneConfig config, const char section, const char *key, int default_value)
	Retrieves a default configuration item as an integer, given its section, key, and default value. More...

int64_t	linphone_config_get_default_int64 (const LinphoneConfig config, 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. More...

float	linphone_config_get_default_float (const LinphoneConfig config, const char section, const char *key, float default_value)
	Retrieves a default configuration item as a float, given its section, key, and default value. More...

const char *	linphone_config_get_default_string (const LinphoneConfig config, 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. More...

const char *	linphone_config_get_section_param_string (const LinphoneConfig config, const char section, const char key, const char default_value)
	Retrieves a section parameter item as a string, given its section and key. More...

LinphoneConfig *	linphone_config_ref (LinphoneConfig *config)
	increment reference count More...

void	linphone_config_unref (LinphoneConfig *config)
	Decrement reference count, which will eventually free the object. More...

void	linphone_config_write_relative_file (const LinphoneConfig config, const char filename, const char *data)
	Write a string in a file placed relatively with the Linphone configuration file. More...

LinphoneStatus	linphone_config_read_relative_file (const LinphoneConfig config, const char filename, char *data, size_t max_length)
	Read a string from a file placed beside the Linphone configuration file. More...

bool_t	linphone_config_relative_file_exists (const LinphoneConfig config, const char filename)
	Check if given file name exists relatively to the current location. More...

char *	linphone_config_dump_as_xml (const LinphoneConfig *config)
	Dumps the LinphoneConfig as XML into a buffer. More...

char *	linphone_config_dump (const LinphoneConfig *config)
	Dumps the LinphoneConfig as INI into a buffer. More...

bool_t	linphone_config_get_overwrite_flag_for_entry (const LinphoneConfig config, const char section, const char *key)
	Retrieves the overwrite flag for a config item. More...

void	linphone_config_set_overwrite_flag_for_entry (LinphoneConfig config, const char section, const char *key, bool_t value)
	Sets the overwrite flag for a config item (used when dumping config as xml) More...

bool_t	linphone_config_get_overwrite_flag_for_section (const LinphoneConfig config, const char section)
	Retrieves the overwrite flag for a config section. More...

void	linphone_config_set_overwrite_flag_for_section (LinphoneConfig config, const char section, bool_t value)
	Sets the overwrite flag for a config section (used when dumping config as xml) More...

bool_t	linphone_config_get_skip_flag_for_entry (const LinphoneConfig config, const char section, const char *key)
	Retrieves the skip flag for a config item. More...

void	linphone_config_set_skip_flag_for_entry (LinphoneConfig config, const char section, const char *key, bool_t value)
	Sets the skip flag for a config item (used when dumping config as xml) More...

bool_t	linphone_config_get_skip_flag_for_section (const LinphoneConfig config, const char section)
	Retrieves the skip flag for a config section. More...

void	linphone_config_set_skip_flag_for_section (LinphoneConfig config, const char section, bool_t value)
	Sets the skip flag for a config section (used when dumping config as xml) More...

LinphoneDictionary *	linphone_config_section_to_dict (const LinphoneConfig config, const char section)
	Converts a config section into a dictionary. More...

void	linphone_config_load_dict_to_section (LinphoneConfig config, const char section, const LinphoneDictionary *dict)
	Loads a dictionary into a section of the LinphoneConfig. More...

bool_t	linphone_config_is_readonly (const LinphoneConfig *config)
	Indicates whether the LinphoneConfig object is readonly, in other words it has no file backend or file is opened without write permission. More...

const char **	linphone_config_get_sections_names (LinphoneConfig *config)
	Returns the list of sections' names in the LinphoneConfig. More...

LinphoneXmlRpcRequest *	linphone_xml_rpc_request_new (LinphoneXmlRpcArgType return_type, const char *method)
	Create a new LinphoneXmlRpcRequest object. More...

LinphoneXmlRpcRequest *	linphone_xml_rpc_request_ref (LinphoneXmlRpcRequest *request)
	Acquire a reference to the XML-RPC request. More...

void	linphone_xml_rpc_request_unref (LinphoneXmlRpcRequest *request)
	Release reference to the XML-RPC request. More...

void *	linphone_xml_rpc_request_get_user_data (const LinphoneXmlRpcRequest *request)
	Retrieve the user pointer associated with the XML-RPC request. More...

void	linphone_xml_rpc_request_set_user_data (LinphoneXmlRpcRequest request, void user_data)
	Assign a user pointer to the XML-RPC request. More...

void	linphone_xml_rpc_request_add_int_arg (LinphoneXmlRpcRequest *request, int value)
	Add an integer argument to an XML-RPC request. More...

void	linphone_xml_rpc_request_add_string_arg (LinphoneXmlRpcRequest request, const char value)
	Add a string argument to an XML-RPC request. More...

void	linphone_xml_rpc_request_add_callbacks (LinphoneXmlRpcRequest request, LinphoneXmlRpcRequestCbs cbs)
	Add the current LinphoneXmlRpcRequestCbs object to a LinphoneXmlRpcRequest. More...

void	linphone_xml_rpc_request_remove_callbacks (LinphoneXmlRpcRequest request, LinphoneXmlRpcRequestCbs cbs)
	Remove the current LinphoneXmlRpcRequestCbs object from a LinphoneXmlRpcRequest. More...

LinphoneXmlRpcRequestCbs *	linphone_xml_rpc_request_get_current_callbacks (const LinphoneXmlRpcRequest *request)
	Get the current LinphoneXmlRpcRequestCbs object associated with a LinphoneXmlRpcRequest. More...

const char *	linphone_xml_rpc_request_get_content (const LinphoneXmlRpcRequest *request)
	Get the content of the XML-RPC request. More...

LinphoneXmlRpcStatus	linphone_xml_rpc_request_get_status (const LinphoneXmlRpcRequest *request)
	Get the status of the XML-RPC request. More...

int	linphone_xml_rpc_request_get_int_response (const LinphoneXmlRpcRequest *request)
	Get the response to an XML-RPC request sent with linphone_xml_rpc_session_send_request() and returning an integer response. More...

const char *	linphone_xml_rpc_request_get_string_response (const LinphoneXmlRpcRequest *request)
	Get the response to an XML-RPC request sent with linphone_xml_rpc_session_send_request() and returning a string response. More...

const char *	linphone_xml_rpc_request_get_raw_response (const LinphoneXmlRpcRequest *request)
	Get the raw response to an XML-RPC request sent with linphone_xml_rpc_session_send_request() and returning http body as string. More...

const bctbx_map_t *	linphone_xml_rpc_request_get_string_struct_response (const LinphoneXmlRpcRequest *request)
	Get the response to an XML-RPC request sent with linphone_xml_rpc_session_send_request() and returning a struct response. More...

const bctbx_list_t *	linphone_xml_rpc_request_get_list_response (const LinphoneXmlRpcRequest *request)
	Get the response to an XML-RPC request sent with linphone_xml_rpc_session_send_request() and returning a string response. More...

LinphoneXmlRpcSession *	linphone_xml_rpc_session_new (LinphoneCore core, const char url)
	Create a new LinphoneXmlRpcSession object. More...

LinphoneXmlRpcSession *	linphone_xml_rpc_session_ref (LinphoneXmlRpcSession *session)
	Acquire a reference to the XML-RPC session. More...

void	linphone_xml_rpc_session_unref (LinphoneXmlRpcSession *session)
	Release reference to the XML-RPC session. More...

void *	linphone_xml_rpc_session_get_user_data (const LinphoneXmlRpcSession *session)
	Retrieve the user pointer associated with the XML-RPC session. More...

void	linphone_xml_rpc_session_set_user_data (LinphoneXmlRpcSession session, void user_data)
	Assign a user pointer to the XML-RPC session. More...

void	linphone_xml_rpc_session_send_request (LinphoneXmlRpcSession session, LinphoneXmlRpcRequest request)
	Send an XML-RPC request. More...

void	linphone_xml_rpc_session_release (LinphoneXmlRpcSession *session)
	Stop and unref an XML rpc session. More...

LinphoneXmlRpcRequestCbs *	linphone_xml_rpc_request_cbs_ref (LinphoneXmlRpcRequestCbs *cbs)
	Acquire a reference to a LinphoneXmlRpcRequestCbs object. More...

void	linphone_xml_rpc_request_cbs_unref (LinphoneXmlRpcRequestCbs *cbs)
	Release a reference to a LinphoneXmlRpcRequestCbs object. More...

void *	linphone_xml_rpc_request_cbs_get_user_data (const LinphoneXmlRpcRequestCbs *cbs)
	Retrieve the user pointer associated with a LinphoneXmlRpcRequestCbs object. More...

void	linphone_xml_rpc_request_cbs_set_user_data (LinphoneXmlRpcRequestCbs cbs, void user_data)
	Assign a user pointer to a LinphoneXmlRpcRequestCbs object. More...

LinphoneXmlRpcRequestCbsResponseCb	linphone_xml_rpc_request_cbs_get_response (const LinphoneXmlRpcRequestCbs *cbs)
	Get the response callback. More...

void	linphone_xml_rpc_request_cbs_set_response (LinphoneXmlRpcRequestCbs *cbs, LinphoneXmlRpcRequestCbsResponseCb cb)
	Set the response callback. More...

LinphoneXmlRpcRequest *	linphone_xml_rpc_session_create_request (LinphoneXmlRpcSession session, LinphoneXmlRpcArgType return_type, const char method)
	Creates a LinphoneXmlRpcRequest from a LinphoneXmlRpcSession. More...

MS2_DEPRECATED LinphoneXmlRpcRequestCbs *	linphone_xml_rpc_request_get_callbacks (const LinphoneXmlRpcRequest *request)
	Get the LinphoneXmlRpcRequestCbs object associated with a LinphoneXmlRpcRequest. More...

Detailed Description

Function Documentation

◆ linphone_config_clean_entry()

void linphone_config_clean_entry	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key
	)

Removes entries for key,value in a section.

Parameters

config	The LinphoneConfig object
section	the section for which to clean the key entry
key	the key to clean

◆ linphone_config_clean_section()

void linphone_config_clean_section	(	LinphoneConfig *	config,
		const char *	section
	)

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

Parameters

config	The LinphoneConfig object
section	the section to clean

◆ linphone_config_dump()

char* linphone_config_dump ( const LinphoneConfig * config )

Dumps the LinphoneConfig as INI into a buffer.

Parameters

config The LinphoneConfig object

Returns: The buffer that contains the config dump

◆ linphone_config_dump_as_xml()

char* linphone_config_dump_as_xml ( const LinphoneConfig * config )

Dumps the LinphoneConfig as XML into a buffer.

Parameters

config The LinphoneConfig object

Returns: The buffer that contains the XML dump

◆ linphone_config_for_each_entry()

void linphone_config_for_each_entry	(	const LinphoneConfig *	config,
		const char *	section,
		void()(const char entry, void *ctx)	callback,
		void *	ctx
	)

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

◆ linphone_config_for_each_section()

void linphone_config_for_each_section	(	const LinphoneConfig *	config,
		void()(const char section, void *ctx)	callback,
		void *	ctx
	)

Call a function for each section present in the configuration.

◆ linphone_config_get_bool()

bool_t linphone_config_get_bool	(	const LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		bool_t	default_value
	)

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

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

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
default_value	The default value to return if not found

Returns: the found value or default_value if not found.

◆ linphone_config_get_default_float()

float linphone_config_get_default_float	(	const LinphoneConfig *	config,
		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.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve the default value
key	The name of the configuration item to retrieve
default_value	The default value to return if not found

Returns: the found default value or default_value if not found.

◆ linphone_config_get_default_int()

int linphone_config_get_default_int	(	const LinphoneConfig *	config,
		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.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve the default value
key	The name of the configuration item to retrieve
default_value	The default value to return if not found

Returns: the found default value or default_value if not found.

◆ linphone_config_get_default_int64()

int64_t linphone_config_get_default_int64	(	const LinphoneConfig *	config,
		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.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve the default value
key	The name of the configuration item to retrieve
default_value	The default value to return if not found

Returns: the found default value or default_value if not found.

◆ linphone_config_get_default_string()

const char* linphone_config_get_default_string	(	const LinphoneConfig *	config,
		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.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve the default value
key	The name of the configuration item to retrieve
default_value	The default value to return if not found

Returns: the found default value or default_value if not found.

◆ linphone_config_get_factory_filename()

const char* linphone_config_get_factory_filename ( const LinphoneConfig * config )

Returns the filename that was used as the factory config.

Parameters

config the LinphoneConfig object.

Returns: the filename used to as the factory config if any.

◆ linphone_config_get_filename()

const char* linphone_config_get_filename ( const LinphoneConfig * config )

Returns the filename used to store the user config.

Parameters

config the LinphoneConfig object.

Returns: the filename used to store the user config if any.

◆ linphone_config_get_float()

float linphone_config_get_float	(	const LinphoneConfig *	config,
		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.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
default_value	The default value to return if not found

Returns: the found value or default_value if not found.

◆ linphone_config_get_int()

int linphone_config_get_int	(	const LinphoneConfig *	config,
		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.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
default_value	The default value to return if not found

Returns: the found value or default_value if not found.

◆ linphone_config_get_int64()

int64_t linphone_config_get_int64	(	const LinphoneConfig *	config,
		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.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
default_value	The default value to return if not found

Returns: the found value or default_value if not found.

◆ linphone_config_get_keys_names_list()

bctbx_list_t* linphone_config_get_keys_names_list	(	LinphoneConfig *	config,
		const char *	section
	)

Returns the list of keys' names for a section in the LinphoneConfig.

Parameters

config	The LinphoneConfig object
section	The section name

Returns: A list of strings.

◆ linphone_config_get_overwrite_flag_for_entry()

bool_t linphone_config_get_overwrite_flag_for_entry	(	const LinphoneConfig *	config,
		const char *	section,
		const char *	key
	)

Retrieves the overwrite flag for a config item.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve the overwrite flag
key	The name of the configuration item to retrieve the overwrite flag from.

Returns: TRUE if overwrite flag is set, FALSE otherwise.

◆ linphone_config_get_overwrite_flag_for_section()

bool_t linphone_config_get_overwrite_flag_for_section	(	const LinphoneConfig *	config,
		const char *	section
	)

Retrieves the overwrite flag for a config section.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve the overwrite flag

Returns: TRUE if overwrite flag is set, FALSE otherwise.

◆ linphone_config_get_range()

bool_t linphone_config_get_range	(	const LinphoneConfig *	config,
		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.

Parameters

	config	The LinphoneConfig object
	section	The section from which to retrieve a configuration item
	key	The name of the configuration item to retrieve
[out]	min	The min value found or default_min
[out]	max	The max value found or default_max
	default_min	the default min value to return if not found
	default_max	the default max value to return if not found.

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.

◆ linphone_config_get_section_param_string()

const char* linphone_config_get_section_param_string	(	const LinphoneConfig *	config,
		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.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve the default value
key	The name of the configuration item to retrieve
default_value	The default value to return if not found.

Returns: the found default value or default_value if not found.

◆ linphone_config_get_sections_names()

const char** linphone_config_get_sections_names ( LinphoneConfig * config )

Returns the list of sections' names in the LinphoneConfig.

Parameters

config The LinphoneConfig object

Returns: a null terminated static array of strings

Deprecated:: 12/10/2017 use linphone_config_get_sections_names_list instead

◆ linphone_config_get_sections_names_list()

bctbx_list_t* linphone_config_get_sections_names_list ( LinphoneConfig * config )

Returns the list of sections' names in the LinphoneConfig.

Parameters

config The LinphoneConfig object

Returns: A list of strings.

◆ linphone_config_get_skip_flag_for_entry()

bool_t linphone_config_get_skip_flag_for_entry	(	const LinphoneConfig *	config,
		const char *	section,
		const char *	key
	)

Retrieves the skip flag for a config item.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve the skip flag
key	The name of the configuration item to retrieve the skip flag from

Returns: TRUE if skip flag is set, FALSE otherwise.

◆ linphone_config_get_skip_flag_for_section()

bool_t linphone_config_get_skip_flag_for_section	(	const LinphoneConfig *	config,
		const char *	section
	)

Retrieves the skip flag for a config section.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve the skip flag

Returns: TRUE if skip flag is set, FALSE otherwise.

◆ linphone_config_get_string()

const char* linphone_config_get_string	(	const LinphoneConfig *	config,
		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.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
default_string	The default value to return if not found.

Returns: the found value or the default one if not found.

◆ linphone_config_get_string_list()

bctbx_list_t* linphone_config_get_string_list	(	const LinphoneConfig *	config,
		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

config	A LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
default_list	The list to return when the key doesn't exist.

Returns: A list of strings.

◆ linphone_config_get_temporary_filename()

const char* linphone_config_get_temporary_filename ( const LinphoneConfig * config )

Returns the temporary filename used to store the user config.

Parameters

config the LinphoneConfig object.

Returns: the temporary filename used to store the user config if any.

◆ linphone_config_has_entry()

int linphone_config_has_entry	(	const LinphoneConfig *	config,
		const char *	section,
		const char *	key
	)

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

Parameters

config	The LinphoneConfig object
section	to check if the given entry exists
key	to check if it exists

Returns: 1 if it exists, 0 otherwise

◆ linphone_config_has_section()

int linphone_config_has_section	(	const LinphoneConfig *	config,
		const char *	section
	)

Returns if a given section is present in the configuration.

Parameters

config	The LinphoneConfig object
section	the section to check if exists

Returns: 1 if it exists, 0 otherwise

◆ linphone_config_is_readonly()

bool_t linphone_config_is_readonly ( const LinphoneConfig * config )

Indicates whether the LinphoneConfig object is readonly, in other words it has no file backend or file is opened without write permission.

Parameters

config the LinphoneConfig object

Returns: a boolean.

◆ linphone_config_load_dict_to_section()

void linphone_config_load_dict_to_section	(	LinphoneConfig *	config,
		const char *	section,
		const LinphoneDictionary *	dict
	)

Loads a dictionary into a section of the LinphoneConfig.

If the section doesn't exist it is created. Overwrites existing keys, creates non-existing keys.

Parameters

config	The LinphoneConfig object
section	The section to dump as dictionary
dict	the dictionary to load into the section LinphoneDictionary can't be wrapped

◆ linphone_config_load_from_xml_file()

const char* linphone_config_load_from_xml_file	(	LinphoneConfig *	config,
		const char *	filename
	)

Reads a xml config file and fill the LinphoneConfig with the read config dynamic values.

Parameters

config	The LinphoneConfig object to fill with the content of the file
filename	The filename of the config file to read to fill the LinphoneConfig

◆ linphone_config_load_from_xml_string()

LinphoneStatus linphone_config_load_from_xml_string	(	LinphoneConfig *	config,
		const char *	buffer
	)

Reads a xml config string and fill the LinphoneConfig with the read config dynamic values.

Parameters

config	The LinphoneConfig object to fill with the content of the file
buffer	The string of the config file to fill the LinphoneConfig

Returns: 0 in case of success

◆ linphone_config_new()

LinphoneConfig* linphone_config_new ( const char * filename )

Instantiates a LinphoneConfig object from a user config file.

The caller of this constructor owns a reference. linphone_config_unref() must be called when this object is no longer needed.

Parameters

filename the filename of the config file to read to fill the instantiated LinphoneConfig

See also: linphone_config_new_with_factory()

Returns: a LinphoneConfig object

◆ linphone_config_new_for_shared_core()

LinphoneConfig* linphone_config_new_for_shared_core	(	const char *	app_group_id,
		const char *	config_filename,
		const char *	factory_config_filename
	)

Instantiates a LinphoneConfig object from a user config file name, group id and a factory config file.

The "group id" is the string that identify the "App group" capability of the iOS application. App group gives access to a shared file system where all the configuration files for shared core are stored. Both iOS application and iOS app extension that need shared core must activate the "App group" capability with the SAME "group id" in the project settings. The caller of this constructor owns a reference. linphone_config_unref() must be called when this object is no longer needed.

Parameters

app_group_id	used to compute the path of the config file in the file system shared by the shared Cores
config_filename	the filename of the user config file to read to fill the instantiated LinphoneConfig
factory_config_filename	the filename of the factory config file to read to fill the instantiated LinphoneConfig

See also: linphone_config_new()

Returns: a LinphoneConfig object

The user config file is read first to fill the LinphoneConfig 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.

◆ linphone_config_new_from_buffer()

LinphoneConfig* linphone_config_new_from_buffer ( const char * buffer )

Instantiates a LinphoneConfig object from a user provided buffer.

The caller of this constructor owns a reference. linphone_config_unref() must be called when this object is no longer needed.

Parameters

buffer the buffer from which the LinphoneConfig will be retrieved. We expect the buffer to be null-terminated.

See also: linphone_config_new_with_factory(); linphone_config_new()

Returns: a LinphoneConfig object

◆ linphone_config_new_with_factory()

LinphoneConfig* linphone_config_new_with_factory	(	const char *	config_filename,
		const char *	factory_config_filename
	)

Instantiates a LinphoneConfig object from a user config file and a factory config file.

The caller of this constructor owns a reference. linphone_config_unref() must be called when this object is no longer needed.

Parameters

config_filename	the filename of the user config file to read to fill the instantiated LinphoneConfig
factory_config_filename	the filename of the factory config file to read to fill the instantiated LinphoneConfig

See also: linphone_config_new()

Returns: a LinphoneConfig object

The user config file is read first to fill the LinphoneConfig 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.

◆ linphone_config_read_file()

LinphoneStatus linphone_config_read_file	(	LinphoneConfig *	config,
		const char *	filename
	)

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

Parameters

config	The LinphoneConfig object to fill with the content of the file
filename	The filename of the config file to read to fill the LinphoneConfig

◆ linphone_config_read_relative_file()

LinphoneStatus linphone_config_read_relative_file	(	const LinphoneConfig *	config,
		const char *	filename,
		char *	data,
		size_t	max_length
	)

Read a string from a file placed beside the Linphone configuration file.

Parameters

config	LinphoneConfig instance used as a reference
filename	Name of the file where data will be read from. The name is relative to the place of the config file
data	Buffer where read string will be stored
max_length	Length of the buffer

Returns: 0 on success, -1 on failure

◆ linphone_config_ref()

LinphoneConfig* linphone_config_ref ( LinphoneConfig * config )

increment reference count

Parameters

config The LinphoneConfig object

Returns: the same LinphoneConfig object

◆ linphone_config_relative_file_exists()

bool_t linphone_config_relative_file_exists	(	const LinphoneConfig *	config,
		const char *	filename
	)

Check if given file name exists relatively to the current location.

Parameters

config	The LinphoneConfig object
filename	The file name to check if exists

Returns: TRUE if file exists relative to the to the current location

◆ linphone_config_reload()

void linphone_config_reload ( LinphoneConfig * config )

Reload the config from the file.

Parameters

config The LinphoneConfig object

◆ linphone_config_section_to_dict()

LinphoneDictionary* linphone_config_section_to_dict	(	const LinphoneConfig *	config,
		const char *	section
	)

Converts a config section into a dictionary.

Parameters

config	The LinphoneConfig object
section	The section to dump as dictionary

Returns: a dictionary with all the keys from a section, or NULL if the section doesn't exist. LinphoneDictionary can't be wrapped

◆ linphone_config_set_bool()

void linphone_config_set_bool	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		bool_t	value
	)

Sets a boolean config item.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
value	the value to set

◆ linphone_config_set_float()

void linphone_config_set_float	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		float	value
	)

Sets a float config item.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
value	the value to set

◆ linphone_config_set_int()

void linphone_config_set_int	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		int	value
	)

Sets an integer config item.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
value	the value to set

◆ linphone_config_set_int64()

void linphone_config_set_int64	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		int64_t	value
	)

Sets a 64 bits integer config item.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
value	the value to set

◆ linphone_config_set_int_hex()

void linphone_config_set_int_hex	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		int	value
	)

Sets an integer config item, but store it as hexadecimal.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
value	the value to set

◆ linphone_config_set_overwrite_flag_for_entry()

void linphone_config_set_overwrite_flag_for_entry	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		bool_t	value
	)

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

Parameters

config	The LinphoneConfig object
section	The section from which to set the overwrite flag
key	The name of the configuration item to set the overwrite flag from
value	The overwrite flag value to set

◆ linphone_config_set_overwrite_flag_for_section()

void linphone_config_set_overwrite_flag_for_section	(	LinphoneConfig *	config,
		const char *	section,
		bool_t	value
	)

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

Parameters

config	The LinphoneConfig object
section	The section from which to set the overwrite flag
value	The overwrite flag value to set

◆ linphone_config_set_range()

void linphone_config_set_range	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		int	min_value,
		int	max_value
	)

Sets a range config item.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
min_value	the min value to set
max_value	the max value to set

◆ linphone_config_set_skip_flag_for_entry()

void linphone_config_set_skip_flag_for_entry	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		bool_t	value
	)

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

Parameters

config	The LinphoneConfig object
section	The section from which to set the skip flag
key	The name of the configuration item to set the skip flag from
value	The skip flag value to set

◆ linphone_config_set_skip_flag_for_section()

void linphone_config_set_skip_flag_for_section	(	LinphoneConfig *	config,
		const char *	section,
		bool_t	value
	)

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

Parameters

config	The LinphoneConfig object
section	The section from which to set the skip flag
value	The skip flag value to set

◆ linphone_config_set_string()

void linphone_config_set_string	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		const char *	value
	)

Sets a string config item.

Parameters

config	The LinphoneConfig object
section	The section from which to retrieve a configuration item
key	The name of the configuration item to retrieve
value	The value to set

◆ linphone_config_set_string_list()

void linphone_config_set_string_list	(	LinphoneConfig *	config,
		const char *	section,
		const char *	key,
		const bctbx_list_t *	value
	)

Sets a string list config item.

Parameters

config	A LinphoneConfig object
section	The name of the section to put the configuration item into
key	The name of the configuration item to set
value	The value to set.

◆ linphone_config_sync()

LinphoneStatus linphone_config_sync ( LinphoneConfig * config )

Writes the config file to disk.

Parameters

config The LinphoneConfig object

Returns: 0 if successful, -1 otherwise

◆ linphone_config_unref()

void linphone_config_unref ( LinphoneConfig * config )

Decrement reference count, which will eventually free the object.

Parameters

config The LinphoneConfig object

◆ linphone_config_write_relative_file()

void linphone_config_write_relative_file	(	const LinphoneConfig *	config,
		const char *	filename,
		const char *	data
	)

Write a string in a file placed relatively with the Linphone configuration file.

Parameters

config	LinphoneConfig instance used as a reference
filename	Name of the file where to write data. The name is relative to the place of the config file
data	String to write

◆ linphone_core_has_builtin_echo_canceller()

bool_t linphone_core_has_builtin_echo_canceller ( LinphoneCore * core )

Check whether the device has a hardware echo canceller.

Parameters

core	The LinphoneCore object.

Returns: TRUE if it does, FALSE otherwise

◆ linphone_core_has_crappy_opengl()

bool_t linphone_core_has_crappy_opengl ( LinphoneCore * core )

Check whether the device is flagged has crappy opengl.

Parameters

core	The LinphoneCore object.

Returns: TRUE if crappy opengl flag is set, FALSE otherwise

◆ linphone_core_is_echo_canceller_calibration_required()

bool_t linphone_core_is_echo_canceller_calibration_required ( LinphoneCore * core )

Check whether the device is echo canceller calibration is required.

Parameters

core	The LinphoneCore object.

Returns: TRUE if it is required, FALSE otherwise

◆ linphone_core_start_echo_calibration()

MS2_DEPRECATED int linphone_core_start_echo_calibration	(	LinphoneCore *	lc,
		LinphoneEcCalibrationCallback	cb,
		LinphoneEcCalibrationAudioInit	audio_init_cb,
		LinphoneEcCalibrationAudioUninit	audio_uninit_cb,
		void *	cb_data
	)

Starts an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically.

Deprecated:: 16/10/2017 Use linphone_core_start_echo_canceller_calibration() instead. To set the callbacks create or get an already instantiated LinphoneCoreCbs and call linphone_core_cbs_set_ec_calibration_result(), linphone_core_cbs_set_ec_calibration_audio_init() and #linphone_core_cbs_set_ec_callibration_audio_uninit(). Deprecated since 2017-10-16.

◆ linphone_core_start_echo_canceller_calibration()

LinphoneStatus linphone_core_start_echo_canceller_calibration ( LinphoneCore * core )

Starts an echo calibration of the sound devices, in order to find adequate settings for the echo canceler automatically.

Parameters

core	LinphoneCore object.

Returns: LinphoneStatus whether calibration has started or not.

◆ linphone_core_start_echo_tester()

LinphoneStatus linphone_core_start_echo_tester	(	LinphoneCore *	core,
		unsigned int	rate
	)

Start the simulation of call to test the latency with an external device.

Parameters

core	The LinphoneCore object.
rate	Sound sample rate.

Returns: -1 in case of failure, 1 otherwise.

◆ linphone_core_stop_echo_tester()

LinphoneStatus linphone_core_stop_echo_tester ( LinphoneCore * core )

Stop the simulation of call.

Parameters

core	The LinphoneCore object.

◆ linphone_error_info_get_phrase()

const char* linphone_error_info_get_phrase ( const LinphoneErrorInfo * error_info )

Get textual phrase from the error info.

This is the text that is provided by the peer in the protocol (SIP).

Parameters

error_info LinphoneErrorInfo object

Returns: The error phrase

◆ linphone_error_info_get_protocol()

const char* linphone_error_info_get_protocol ( const LinphoneErrorInfo * error_info )

Get protocol from the error info.

Parameters

error_info LinphoneErrorInfo object

Returns: The protocol.

◆ linphone_error_info_get_protocol_code()

int linphone_error_info_get_protocol_code ( const LinphoneErrorInfo * error_info )

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

Parameters

error_info LinphoneErrorInfo object

Returns: The status code

◆ linphone_error_info_get_reason()

LinphoneReason linphone_error_info_get_reason ( const LinphoneErrorInfo * error_info )

Get reason code from the error info.

Parameters

error_info LinphoneErrorInfo object

Returns: A LinphoneReason object

◆ linphone_error_info_get_retry_after()

int linphone_error_info_get_retry_after ( const LinphoneErrorInfo * error_info )

Get Retry-After delay second from the error info.

Parameters

error_info LinphoneErrorInfo object

Returns: The Retry-After delay second

◆ linphone_error_info_get_sub_error_info()

LinphoneErrorInfo* linphone_error_info_get_sub_error_info ( const LinphoneErrorInfo * error_info )

Get pointer to chained LinphoneErrorInfo set in sub_ei.

It corresponds to a Reason header in a received SIP response.

Parameters

error_info LinphoneErrorInfo object

Returns: LinphoneErrorInfo pointer defined in the ei object.

◆ linphone_error_info_get_warnings()

const char* linphone_error_info_get_warnings ( const LinphoneErrorInfo * error_info )

Provides additional information regarding the failure.

With SIP protocol, the content of "Warning" headers are returned.

Parameters

error_info LinphoneErrorInfo object

Returns: More details about the failure.

◆ linphone_error_info_new()

LinphoneErrorInfo* linphone_error_info_new ( void )

Create an empty LinphoneErrorInfo object.

The LinphoneErrorInfo object carries these fields:

a LinphoneReason enum member giving overall signification of the error reported.
the "protocol" name in which the protocol reason code has meaning, for example SIP or Q.850
the "protocol code", an integer referencing the kind of error reported
the "phrase", a text phrase describing the error
the "warning", the content of warning headers if any
a sub "LinphoneErrorInfo" may be provided if a SIP response includes a Reason header (RFC3326).
Returns
a new LinphoneErrorInfo object

◆ linphone_error_info_ref()

LinphoneErrorInfo* linphone_error_info_ref ( LinphoneErrorInfo * error_info )

Increment refcount.

Parameters

error_info LinphoneErrorInfo object

Returns: the same LinphoneErrorInfo object

◆ linphone_error_info_set()

void linphone_error_info_set	(	LinphoneErrorInfo *	error_info,
		const char *	protocol,
		LinphoneReason	reason,
		int	code,
		const char *	status,
		const char *	warning
	)

Assign information to a LinphoneErrorInfo object.

Parameters

error_info	LinphoneErrorInfo object
protocol	protocol name
reason	reason from LinphoneReason enum
code	protocol code
status	description of the reason
warning	warning message

◆ linphone_error_info_set_phrase()

void linphone_error_info_set_phrase	(	LinphoneErrorInfo *	error_info,
		const char *	phrase
	)

Assign phrase to a LinphoneErrorInfo object.

Parameters

error_info	LinphoneErrorInfo object
phrase	the phrase explaining the error

◆ linphone_error_info_set_protocol()

void linphone_error_info_set_protocol	(	LinphoneErrorInfo *	error_info,
		const char *	protocol
	)

Assign protocol name to a LinphoneErrorInfo object.

Parameters

error_info	LinphoneErrorInfo object
protocol	the protocol name

◆ linphone_error_info_set_protocol_code()

void linphone_error_info_set_protocol_code	(	LinphoneErrorInfo *	error_info,
		int	code
	)

Assign protocol code to a LinphoneErrorInfo object.

Parameters

error_info	LinphoneErrorInfo object
code	the protocol code

◆ linphone_error_info_set_reason()

void linphone_error_info_set_reason	(	LinphoneErrorInfo *	error_info,
		LinphoneReason	reason
	)

Assign reason LinphoneReason to a LinphoneErrorInfo object.

Parameters

error_info	LinphoneErrorInfo object
reason	reason from LinphoneReason enum

◆ linphone_error_info_set_retry_after()

void linphone_error_info_set_retry_after	(	LinphoneErrorInfo *	error_info,
		int	retry_after
	)

Assign retry-after value to a LinphoneErrorInfo object.

Parameters

error_info	LinphoneErrorInfo object
retry_after	the retry-after value

◆ linphone_error_info_set_sub_error_info()

void linphone_error_info_set_sub_error_info	(	LinphoneErrorInfo *	error_info,
		LinphoneErrorInfo *	appended_error_info
	)

Set the sub_ei in LinphoneErrorInfo to another LinphoneErrorInfo.

Used when a reason header is to be added in a SIP response. The first level LinphoneErrorInfo defines the SIP response code and phrase, the second (sub) #LinphoneErroInfo defining the content of the Reason header.

Parameters

error_info	LinphoneErrorInfo object to which the other LinphoneErrorInfo will be appended as ei->sub_ei.
appended_error_info	LinphoneErrorInfo to append

◆ linphone_error_info_set_warnings()

void linphone_error_info_set_warnings	(	LinphoneErrorInfo *	error_info,
		const char *	warnings
	)

Assign warnings to a LinphoneErrorInfo object.

Parameters

error_info	LinphoneErrorInfo object
warnings	the warnings

◆ linphone_error_info_unref()

void linphone_error_info_unref ( LinphoneErrorInfo * error_info )

Decrement refcount and possibly free the object.

Parameters

error_info LinphoneErrorInfo object

◆ linphone_headers_add()

void linphone_headers_add	(	LinphoneHeaders *	headers,
		const char *	name,
		const char *	value
	)

Add given header name and corresponding value.

Parameters

headers	the LinphoneHeaders object
name	the header's name
value	the header's value

◆ linphone_headers_get_value()

const char* linphone_headers_get_value	(	const LinphoneHeaders *	headers,
		const char *	header_name
	)

Search for a given header name and return its value.

Parameters

headers	the LinphoneHeaders object
header_name	the header's name

Returns: the header's value or NULL if not found.

◆ linphone_headers_remove()

void linphone_headers_remove	(	LinphoneHeaders *	headers,
		const char *	name
	)

Add given header name and corresponding value.

Parameters

headers	the LinphoneHeaders object
name	the header's name

◆ linphone_info_message_add_header()

void linphone_info_message_add_header	(	LinphoneInfoMessage *	info_message,
		const char *	name,
		const char *	value
	)

Add a header to an info message to be sent.

Parameters

info_message	the LinphoneInfoMessage object
name	the header'name
value	the header's value

◆ linphone_info_message_get_content()

const LinphoneContent* linphone_info_message_get_content ( const LinphoneInfoMessage * info_message )

Returns the info message's content as a LinphoneContent structure.

Parameters

info_message the LinphoneInfoMessage object

Returns: the LinphoneContent object.

◆ linphone_info_message_get_header()

const char* linphone_info_message_get_header	(	const LinphoneInfoMessage *	info_message,
		const char *	name
	)

Obtain a header value from a received info message.

Parameters

info_message	the LinphoneInfoMessage object
name	the header'name

Returns: the corresponding header's value, or NULL if not exists.

◆ linphone_info_message_ref()

LinphoneInfoMessage* linphone_info_message_ref ( LinphoneInfoMessage * info_message )

Take a reference on a LinphoneInfoMessage.

Parameters

info_message the LinphoneInfoMessage object

Returns: the same LinphoneInfoMessage object

◆ linphone_info_message_set_content()

void linphone_info_message_set_content	(	LinphoneInfoMessage *	info_message,
		const LinphoneContent *	content
	)

Assign a content to the info message.

All fields of the LinphoneContent are copied, thus the application can destroy/modify/recycloe the content object freely ater the function returns.

Parameters

info_message	the LinphoneInfoMessage object
content	the content described as a LinphoneContent structure.

◆ linphone_info_message_unref()

void linphone_info_message_unref ( LinphoneInfoMessage * info_message )

Release a reference on a LinphoneInfoMessage.

Parameters

info_message the linphone info message

◆ linphone_xml_rpc_request_add_callbacks()

void linphone_xml_rpc_request_add_callbacks	(	LinphoneXmlRpcRequest *	request,
		LinphoneXmlRpcRequestCbs *	cbs
	)

Add the current LinphoneXmlRpcRequestCbs object to a LinphoneXmlRpcRequest.

Parameters

request	LinphoneXmlRpcRequest object
cbs	The LinphoneXmlRpcRequestCbs object to add to the LinphoneXmlRpcRequest.

◆ linphone_xml_rpc_request_add_int_arg()

void linphone_xml_rpc_request_add_int_arg	(	LinphoneXmlRpcRequest *	request,
		int	value
	)

Add an integer argument to an XML-RPC request.

Parameters

request	LinphoneXmlRpcRequest object.
value	The integer value of the added argument.

◆ linphone_xml_rpc_request_add_string_arg()

void linphone_xml_rpc_request_add_string_arg	(	LinphoneXmlRpcRequest *	request,
		const char *	value
	)

Add a string argument to an XML-RPC request.

Parameters

request	LinphoneXmlRpcRequest object.
value	The string value of the added argument.

◆ linphone_xml_rpc_request_cbs_get_response()

LinphoneXmlRpcRequestCbsResponseCb linphone_xml_rpc_request_cbs_get_response ( const LinphoneXmlRpcRequestCbs * cbs )

Get the response callback.

Parameters

cbs	LinphoneXmlRpcRequestCbs object.

Returns: The current response callback.

◆ linphone_xml_rpc_request_cbs_get_user_data()

void* linphone_xml_rpc_request_cbs_get_user_data ( const LinphoneXmlRpcRequestCbs * cbs )

Retrieve the user pointer associated with a LinphoneXmlRpcRequestCbs object.

Parameters

cbs	LinphoneXmlRpcRequestCbs object.

Returns: The user pointer associated with the LinphoneXmlRpcRequestCbs object.

◆ linphone_xml_rpc_request_cbs_ref()

LinphoneXmlRpcRequestCbs* linphone_xml_rpc_request_cbs_ref ( LinphoneXmlRpcRequestCbs * cbs )

Acquire a reference to a LinphoneXmlRpcRequestCbs object.

Parameters

cbs	LinphoneXmlRpcRequestCbs object.

Returns: The same LinphoneXmlRpcRequestCbs object.

◆ linphone_xml_rpc_request_cbs_set_response()

void linphone_xml_rpc_request_cbs_set_response	(	LinphoneXmlRpcRequestCbs *	cbs,
		LinphoneXmlRpcRequestCbsResponseCb	cb
	)

Set the response callback.

Parameters

cbs	LinphoneXmlRpcRequestCbs object.
cb	The response callback to be used.

◆ linphone_xml_rpc_request_cbs_set_user_data()

void linphone_xml_rpc_request_cbs_set_user_data	(	LinphoneXmlRpcRequestCbs *	cbs,
		void *	user_data
	)

Assign a user pointer to a LinphoneXmlRpcRequestCbs object.

Parameters

cbs	LinphoneXmlRpcRequestCbs object.
user_data	The user pointer to associate with the LinphoneXmlRpcRequestCbs object.

◆ linphone_xml_rpc_request_cbs_unref()

void linphone_xml_rpc_request_cbs_unref ( LinphoneXmlRpcRequestCbs * cbs )

Release a reference to a LinphoneXmlRpcRequestCbs object.

Parameters

cbs	LinphoneXmlRpcRequestCbs object.

◆ linphone_xml_rpc_request_get_callbacks()

MS2_DEPRECATED LinphoneXmlRpcRequestCbs* linphone_xml_rpc_request_get_callbacks ( const LinphoneXmlRpcRequest * request )

Get the LinphoneXmlRpcRequestCbs object associated with a LinphoneXmlRpcRequest.

Parameters

request LinphoneXmlRpcRequest object

Returns: The LinphoneXmlRpcRequestCbs object associated with the LinphoneXmlRpcRequest.

Deprecated:: 19/02/2019 use add_callbacks / remove_callbacks instead

◆ linphone_xml_rpc_request_get_content()

const char* linphone_xml_rpc_request_get_content ( const LinphoneXmlRpcRequest * request )

Get the content of the XML-RPC request.

Parameters

request LinphoneXmlRpcRequest object.

Returns: The string representation of the content of the XML-RPC request.

◆ linphone_xml_rpc_request_get_current_callbacks()

LinphoneXmlRpcRequestCbs* linphone_xml_rpc_request_get_current_callbacks ( const LinphoneXmlRpcRequest * request )

Get the current LinphoneXmlRpcRequestCbs object associated with a LinphoneXmlRpcRequest.

Parameters

request LinphoneXmlRpcRequest object

Returns: The current LinphoneXmlRpcRequestCbs object associated with the LinphoneXmlRpcRequest.

◆ linphone_xml_rpc_request_get_int_response()

int linphone_xml_rpc_request_get_int_response ( const LinphoneXmlRpcRequest * request )

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

Parameters

request LinphoneXmlRpcRequest object.

Returns: The integer response to the XML-RPC request.

◆ linphone_xml_rpc_request_get_list_response()

const bctbx_list_t* linphone_xml_rpc_request_get_list_response ( const LinphoneXmlRpcRequest * request )

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

Parameters

request LinphoneXmlRpcRequest object.

Returns: A list of all string responses in the XML-RPC request.

◆ linphone_xml_rpc_request_get_raw_response()

const char* linphone_xml_rpc_request_get_raw_response ( const LinphoneXmlRpcRequest * request )

Get the raw response to an XML-RPC request sent with linphone_xml_rpc_session_send_request() and returning http body as string.

Parameters

request LinphoneXmlRpcRequest object.

Returns: The string response to the XML-RPC request.

◆ linphone_xml_rpc_request_get_status()

LinphoneXmlRpcStatus linphone_xml_rpc_request_get_status ( const LinphoneXmlRpcRequest * request )

Get the status of the XML-RPC request.

Parameters

request LinphoneXmlRpcRequest object.

Returns: The LinphoneXmlRpcStatus of the XML-RPC request.

◆ linphone_xml_rpc_request_get_string_response()

const char* linphone_xml_rpc_request_get_string_response ( const LinphoneXmlRpcRequest * request )

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

Parameters

request LinphoneXmlRpcRequest object.

Returns: The string response to the XML-RPC request.

◆ linphone_xml_rpc_request_get_string_struct_response()

const bctbx_map_t* linphone_xml_rpc_request_get_string_struct_response ( const LinphoneXmlRpcRequest * request )

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

Parameters

request LinphoneXmlRpcRequest object.

Returns: The struct response to the XML-RPC request.

◆ linphone_xml_rpc_request_get_user_data()

void* linphone_xml_rpc_request_get_user_data ( const LinphoneXmlRpcRequest * request )

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

Parameters

request LinphoneXmlRpcRequest object.

Returns: The user pointer associated with the XML-RPC request.

◆ linphone_xml_rpc_request_new()

LinphoneXmlRpcRequest* linphone_xml_rpc_request_new	(	LinphoneXmlRpcArgType	return_type,
		const char *	method
	)

Create a new LinphoneXmlRpcRequest object.

Parameters

return_type	The expected XML-RPC response type as LinphoneXmlRpcArgType.
method	The XML-RPC method to call.

Returns: A new LinphoneXmlRpcRequest object.

◆ linphone_xml_rpc_request_ref()

LinphoneXmlRpcRequest* linphone_xml_rpc_request_ref ( LinphoneXmlRpcRequest * request )

Acquire a reference to the XML-RPC request.

Parameters

request LinphoneXmlRpcRequest object.

Returns: The same LinphoneXmlRpcRequest object.

◆ linphone_xml_rpc_request_remove_callbacks()

void linphone_xml_rpc_request_remove_callbacks	(	LinphoneXmlRpcRequest *	request,
		LinphoneXmlRpcRequestCbs *	cbs
	)

Remove the current LinphoneXmlRpcRequestCbs object from a LinphoneXmlRpcRequest.

Parameters

request	LinphoneXmlRpcRequest object
cbs	The LinphoneXmlRpcRequestCbs object to remove from the LinphoneXmlRpcRequest.

◆ linphone_xml_rpc_request_set_user_data()

void linphone_xml_rpc_request_set_user_data	(	LinphoneXmlRpcRequest *	request,
		void *	user_data
	)

Assign a user pointer to the XML-RPC request.

Parameters

request	LinphoneXmlRpcRequest object.
user_data	The user pointer to associate with the XML-RPC request.

◆ linphone_xml_rpc_request_unref()

void linphone_xml_rpc_request_unref ( LinphoneXmlRpcRequest * request )

Release reference to the XML-RPC request.

Parameters

request LinphoneXmlRpcRequest object.

◆ linphone_xml_rpc_session_create_request()

LinphoneXmlRpcRequest* linphone_xml_rpc_session_create_request	(	LinphoneXmlRpcSession *	session,
		LinphoneXmlRpcArgType	return_type,
		const char *	method
	)

Creates a LinphoneXmlRpcRequest from a LinphoneXmlRpcSession.

Parameters

session	the LinphoneXmlRpcSession
return_type	the return type of the request as a LinphoneXmlRpcArgType
method	the function name to call

Returns: a LinphoneXmlRpcRequest object

◆ linphone_xml_rpc_session_get_user_data()

void* linphone_xml_rpc_session_get_user_data ( const LinphoneXmlRpcSession * session )

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

Parameters

session LinphoneXmlRpcSession object.

Returns: The user pointer associated with the XML-RPC session.

◆ linphone_xml_rpc_session_new()

LinphoneXmlRpcSession* linphone_xml_rpc_session_new	(	LinphoneCore *	core,
		const char *	url
	)

Create a new LinphoneXmlRpcSession object.

Parameters

core	The LinphoneCore object used to send the XML-RPC requests.
url	The URL of the XML-RPC server to send the XML-RPC requests to.

Returns: A new LinphoneXmlRpcSession object.

◆ linphone_xml_rpc_session_ref()

LinphoneXmlRpcSession* linphone_xml_rpc_session_ref ( LinphoneXmlRpcSession * session )

Acquire a reference to the XML-RPC session.

Parameters

session LinphoneXmlRpcSession object.

Returns: The same LinphoneXmlRpcSession object.

◆ linphone_xml_rpc_session_release()

void linphone_xml_rpc_session_release ( LinphoneXmlRpcSession * session )

Stop and unref an XML rpc session.

Pending requests will be aborted.

Parameters

session LinphoneXmlRpcSession object.

◆ linphone_xml_rpc_session_send_request()

void linphone_xml_rpc_session_send_request	(	LinphoneXmlRpcSession *	session,
		LinphoneXmlRpcRequest *	request
	)

Send an XML-RPC request.

Parameters

session	LinphoneXmlRpcSession object.
request	The LinphoneXmlRpcRequest to be sent.

◆ linphone_xml_rpc_session_set_user_data()

void linphone_xml_rpc_session_set_user_data	(	LinphoneXmlRpcSession *	session,
		void *	user_data
	)

Assign a user pointer to the XML-RPC session.

Parameters

session	LinphoneXmlRpcSession object.
user_data	The user pointer to associate with the XML-RPC session.

◆ linphone_xml_rpc_session_unref()

void linphone_xml_rpc_session_unref ( LinphoneXmlRpcSession * session )

Release reference to the XML-RPC session.

Parameters

session LinphoneXmlRpcSession object.

Warning: This will not stop pending xml-rpc requests. Use linphone_xml_rpc_session_release() instead if this is intended.

Macros

Functions

Detailed Description

Function Documentation

◆ linphone_config_clean_entry()

◆ linphone_config_clean_section()

◆ linphone_config_dump()

◆ linphone_config_dump_as_xml()

◆ linphone_config_for_each_entry()

◆ linphone_config_for_each_section()

◆ linphone_config_get_bool()

◆ linphone_config_get_default_float()

◆ linphone_config_get_default_int()

◆ linphone_config_get_default_int64()

◆ linphone_config_get_default_string()

◆ linphone_config_get_factory_filename()

◆ linphone_config_get_filename()

◆ linphone_config_get_float()

◆ linphone_config_get_int()

◆ linphone_config_get_int64()

◆ linphone_config_get_keys_names_list()

◆ linphone_config_get_overwrite_flag_for_entry()

◆ linphone_config_get_overwrite_flag_for_section()

◆ linphone_config_get_range()

◆ linphone_config_get_section_param_string()

◆ linphone_config_get_sections_names()

◆ linphone_config_get_sections_names_list()

◆ linphone_config_get_skip_flag_for_entry()

◆ linphone_config_get_skip_flag_for_section()

◆ linphone_config_get_string()

◆ linphone_config_get_string_list()

◆ linphone_config_get_temporary_filename()

◆ linphone_config_has_entry()

◆ linphone_config_has_section()

◆ linphone_config_is_readonly()

◆ linphone_config_load_dict_to_section()

◆ linphone_config_load_from_xml_file()

◆ linphone_config_load_from_xml_string()

◆ linphone_config_new()

◆ linphone_config_new_for_shared_core()

◆ linphone_config_new_from_buffer()

◆ linphone_config_new_with_factory()

◆ linphone_config_read_file()

◆ linphone_config_read_relative_file()

◆ linphone_config_ref()

◆ linphone_config_relative_file_exists()

◆ linphone_config_reload()

◆ linphone_config_section_to_dict()

◆ linphone_config_set_bool()

◆ linphone_config_set_float()

◆ linphone_config_set_int()

◆ linphone_config_set_int64()

◆ linphone_config_set_int_hex()

◆ linphone_config_set_overwrite_flag_for_entry()

◆ linphone_config_set_overwrite_flag_for_section()

◆ linphone_config_set_range()

◆ linphone_config_set_skip_flag_for_entry()

◆ linphone_config_set_skip_flag_for_section()

◆ linphone_config_set_string()

◆ linphone_config_set_string_list()

◆ linphone_config_sync()

◆ linphone_config_unref()

◆ linphone_config_write_relative_file()

◆ linphone_core_has_builtin_echo_canceller()

◆ linphone_core_has_crappy_opengl()

◆ linphone_core_is_echo_canceller_calibration_required()

◆ linphone_core_start_echo_calibration()

◆ linphone_core_start_echo_canceller_calibration()

◆ linphone_core_start_echo_tester()

◆ linphone_core_stop_echo_tester()

◆ linphone_error_info_get_phrase()

◆ linphone_error_info_get_protocol()

◆ linphone_error_info_get_protocol_code()

◆ linphone_error_info_get_reason()

◆ linphone_error_info_get_retry_after()

◆ linphone_error_info_get_sub_error_info()

◆ linphone_error_info_get_warnings()

◆ linphone_error_info_new()

◆ linphone_error_info_ref()

◆ linphone_error_info_set()