Liblinphone
3.10.2
|
typedef struct _LinphoneAccountCreator LinphoneAccountCreator |
The LinphoneAccountCreator object used to create an account on a server via XML-RPC.
typedef struct _LinphoneAccountCreatorCbs LinphoneAccountCreatorCbs |
An object to handle the callbacks for handling the LinphoneAccountCreator operations.
typedef void(* LinphoneAccountCreatorCbsCreateAccountCb)(LinphoneAccountCreator *creator, LinphoneAccountCreatorStatus status) |
Callback used to notify the end of a LinphoneAccountCreator validate operation.
[in] | creator | LinphoneAccountCreator object |
[in] | status | The status of the LinphoneAccountCreator validate operation that has just finished |
typedef void(* LinphoneAccountCreatorCbsExistenceTestedCb)(LinphoneAccountCreator *creator, LinphoneAccountCreatorStatus status) |
Callback used to notify the end of a LinphoneAccountCreator test existence operation.
[in] | creator | LinphoneAccountCreator object |
[in] | status | The status of the LinphoneAccountCreator test existence operation that has just finished |
typedef void(* LinphoneAccountCreatorCbsValidationTestedCb)(LinphoneAccountCreator *creator, LinphoneAccountCreatorStatus status) |
Callback used to notify the end of a LinphoneAccountCreator test validation operation.
[in] | creator | LinphoneAccountCreator object |
[in] | status | The status of the LinphoneAccountCreator test validation operation that has just finished |
Enum describing the status of a LinphoneAccountCreator operation.
typedef struct _LinphoneBuffer LinphoneBuffer |
The LinphoneContent object representing a data buffer.
typedef struct _LinphoneContent LinphoneContent |
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.
typedef enum _LinphoneReason LinphoneReason |
Enum describing failure reasons.
typedef enum _LinphoneXmlRpcArgType LinphoneXmlRpcArgType |
Enum describing the types of argument for LinphoneXmlRpcRequest.
typedef struct _LinphoneXmlRpcRequest LinphoneXmlRpcRequest |
The LinphoneXmlRpcRequest object representing a XML-RPC request to be sent.
typedef struct _LinphoneXmlRpcRequestCbs LinphoneXmlRpcRequestCbs |
An object to handle the callbacks for handling the LinphoneXmlRpcRequest operations.
typedef void(* LinphoneXmlRpcRequestCbsResponseCb)(LinphoneXmlRpcRequest *request) |
Callback used to notify the response to an XML-RPC request.
[in] | request | LinphoneXmlRpcRequest object |
typedef struct _LinphoneXmlRpcSession LinphoneXmlRpcSession |
The LinphoneXmlRpcSession object used to send XML-RPC requests and handle their responses.
typedef enum _LinphoneXmlRpcStatus LinphoneXmlRpcStatus |
Enum describing the status of a LinphoneXmlRpcRequest.
The LpConfig object is used to manipulate a configuration file.
The format of the configuration file is a .ini like format:
Example:
[sound] echocanceler=1 playback_dev=ALSA: Default device [video] enabled=1
Enum describing the status of a LinphoneAccountCreator operation.
enum _LinphoneReason |
Enum describing various failure reasons or contextual information for some events.
Enum describing the types of argument for LinphoneXmlRpcRequest.
Enum describing the status of a LinphoneXmlRpcRequest.
LinphoneAccountCreatorCbsCreateAccountCb linphone_account_creator_cbs_get_create_account | ( | const LinphoneAccountCreatorCbs * | cbs | ) |
Get the create account callback.
[in] | cbs | LinphoneAccountCreatorCbs object. |
LinphoneAccountCreatorCbsExistenceTestedCb linphone_account_creator_cbs_get_existence_tested | ( | const LinphoneAccountCreatorCbs * | cbs | ) |
Get the existence tested callback.
[in] | cbs | LinphoneAccountCreatorCbs object. |
void* linphone_account_creator_cbs_get_user_data | ( | const LinphoneAccountCreatorCbs * | cbs | ) |
Retrieve the user pointer associated with a LinphoneAccountCreatorCbs object.
[in] | cbs | LinphoneAccountCreatorCbs object. |
LinphoneAccountCreatorCbsValidationTestedCb linphone_account_creator_cbs_get_validation_tested | ( | const LinphoneAccountCreatorCbs * | cbs | ) |
Get the validation tested callback.
[in] | cbs | LinphoneAccountCreatorCbs object. |
Acquire a reference to a LinphoneAccountCreatorCbs object.
[in] | cbs | LinphoneAccountCreatorCbs object. |
void linphone_account_creator_cbs_set_create_account | ( | LinphoneAccountCreatorCbs * | cbs, |
LinphoneAccountCreatorCbsCreateAccountCb | cb | ||
) |
Set the create account callback.
[in] | cbs | LinphoneAccountCreatorCbs object. |
[in] | cb | The create account callback to be used. |
void linphone_account_creator_cbs_set_existence_tested | ( | LinphoneAccountCreatorCbs * | cbs, |
LinphoneAccountCreatorCbsExistenceTestedCb | cb | ||
) |
Set the existence tested callback.
[in] | cbs | LinphoneAccountCreatorCbs object. |
[in] | cb | The existence tested callback to be used. |
void linphone_account_creator_cbs_set_user_data | ( | LinphoneAccountCreatorCbs * | cbs, |
void * | ud | ||
) |
Assign a user pointer to a LinphoneAccountCreatorCbs object.
[in] | cbs | LinphoneAccountCreatorCbs object. |
[in] | ud | The user pointer to associate with the LinphoneAccountCreatorCbs object. |
void linphone_account_creator_cbs_set_validation_tested | ( | LinphoneAccountCreatorCbs * | cbs, |
LinphoneAccountCreatorCbsValidationTestedCb | cb | ||
) |
Set the validation tested callback.
[in] | cbs | LinphoneAccountCreatorCbs object. |
[in] | cb | The validation tested callback to be used. |
void linphone_account_creator_cbs_unref | ( | LinphoneAccountCreatorCbs * | cbs | ) |
Release a reference to a LinphoneAccountCreatorCbs object.
[in] | cbs | LinphoneAccountCreatorCbs object. |
LinphoneProxyConfig* linphone_account_creator_configure | ( | const LinphoneAccountCreator * | creator | ) |
Configure an account (create a proxy config and authentication info for it).
[in] | creator | LinphoneAccountCreator object |
LinphoneAccountCreatorStatus linphone_account_creator_create_account | ( | LinphoneAccountCreator * | creator | ) |
Send an XML-RPC request to create a Linphone account.
[in] | creator | LinphoneAccountCreator object |
void linphone_account_creator_enable_newsletter_subscription | ( | LinphoneAccountCreator * | creator, |
bool_t | subscribe | ||
) |
Enable the newsletter subscription.
[in] | creator | LinphoneAccountCreator object |
[in] | subscribe | A boolean telling whether to subscribe to the newsletter or not. |
LinphoneAccountCreatorCbs* linphone_account_creator_get_callbacks | ( | const LinphoneAccountCreator * | creator | ) |
Get the LinphoneAccountCreatorCbs object associated with a LinphoneAccountCreator.
[in] | creator | LinphoneAccountCreator object |
const char* linphone_account_creator_get_display_name | ( | const LinphoneAccountCreator * | creator | ) |
Get the email.
[in] | creator | LinphoneAccountCreator object |
const char* linphone_account_creator_get_domain | ( | const LinphoneAccountCreator * | creator | ) |
Get the domain.
[in] | creator | LinphoneAccountCreator object |
const char* linphone_account_creator_get_email | ( | const LinphoneAccountCreator * | creator | ) |
Get the email.
[in] | creator | LinphoneAccountCreator object |
const char* linphone_account_creator_get_password | ( | const LinphoneAccountCreator * | creator | ) |
Get the password.
[in] | creator | LinphoneAccountCreator object |
const char* linphone_account_creator_get_route | ( | const LinphoneAccountCreator * | creator | ) |
Get the route.
[in] | creator | LinphoneAccountCreator object |
LinphoneTransportType linphone_account_creator_get_transport | ( | const LinphoneAccountCreator * | creator | ) |
Get the transport.
[in] | creator | LinphoneAccountCreator object |
void* linphone_account_creator_get_user_data | ( | const LinphoneAccountCreator * | creator | ) |
Retrieve the user pointer associated with the LinphoneAccountCreator.
[in] | creator | LinphoneAccountCreator object. |
const char* linphone_account_creator_get_username | ( | const LinphoneAccountCreator * | creator | ) |
Get the username.
[in] | creator | LinphoneAccountCreator object |
LinphoneAccountCreator* linphone_account_creator_new | ( | LinphoneCore * | core, |
const char * | xmlrpc_url | ||
) |
Create a LinphoneAccountCreator.
[in] | core | The LinphoneCore used for the XML-RPC communication |
[in] | xmlrpc_url | The URL to the XML-RPC server. Must be NON NULL. |
bool_t linphone_account_creator_newsletter_subscription_enabled | ( | const LinphoneAccountCreator * | creator | ) |
Tell whether to subscribe to the newsletter or not.
[in] | creator | LinphoneAccountCreator object |
Acquire a reference to the LinphoneAccountCreator.
[in] | creator | LinphoneAccountCreator object. |
LinphoneAccountCreatorStatus linphone_account_creator_set_display_name | ( | LinphoneAccountCreator * | creator, |
const char * | display_name | ||
) |
Set the email.
[in] | creator | LinphoneAccountCreator object |
[in] | display_name | The display name to set |
LinphoneAccountCreatorStatus linphone_account_creator_set_domain | ( | LinphoneAccountCreator * | creator, |
const char * | domain | ||
) |
Set the domain.
[in] | creator | LinphoneAccountCreator object |
[in] | domain | The domain to set |
LinphoneAccountCreatorStatus linphone_account_creator_set_email | ( | LinphoneAccountCreator * | creator, |
const char * | |||
) |
Set the email.
[in] | creator | LinphoneAccountCreator object |
[in] | The email to set |
LinphoneAccountCreatorStatus linphone_account_creator_set_password | ( | LinphoneAccountCreator * | creator, |
const char * | password | ||
) |
Set the password.
[in] | creator | LinphoneAccountCreator object |
[in] | password | The password to set |
LinphoneAccountCreatorStatus linphone_account_creator_set_route | ( | LinphoneAccountCreator * | creator, |
const char * | route | ||
) |
Set the route.
[in] | creator | LinphoneAccountCreator object |
[in] | route | The route to set |
LinphoneAccountCreatorStatus linphone_account_creator_set_transport | ( | LinphoneAccountCreator * | creator, |
LinphoneTransportType | transport | ||
) |
Set the transport.
[in] | creator | LinphoneAccountCreator object |
[in] | transport | The transport to set |
void linphone_account_creator_set_user_data | ( | LinphoneAccountCreator * | creator, |
void * | ud | ||
) |
Assign a user pointer to the LinphoneAccountCreator.
[in] | creator | LinphoneAccountCreator object. |
[in] | ud | The user pointer to associate with the LinphoneAccountCreator. |
LinphoneAccountCreatorStatus linphone_account_creator_set_username | ( | LinphoneAccountCreator * | creator, |
const char * | username | ||
) |
Set the username.
[in] | creator | LinphoneAccountCreator object |
[in] | username | The username to set |
LinphoneAccountCreatorStatus linphone_account_creator_test_existence | ( | LinphoneAccountCreator * | creator | ) |
Send an XML-RPC request to test the existence of a Linphone account.
[in] | creator | LinphoneAccountCreator object |
LinphoneAccountCreatorStatus linphone_account_creator_test_validation | ( | LinphoneAccountCreator * | creator | ) |
Send an XML-RPC request to test the validation of a Linphone account.
[in] | creator | LinphoneAccountCreator object |
void linphone_account_creator_unref | ( | LinphoneAccountCreator * | creator | ) |
Release reference to the LinphoneAccountCreator.
[in] | creator | LinphoneAccountCreator object. |
const uint8_t* linphone_buffer_get_content | ( | const LinphoneBuffer * | buffer | ) |
Get the content of the data buffer.
[in] | buffer | LinphoneBuffer object. |
size_t linphone_buffer_get_size | ( | const LinphoneBuffer * | buffer | ) |
Get the size of the content of the data buffer.
[in] | buffer | LinphoneBuffer object. |
const char* linphone_buffer_get_string_content | ( | const LinphoneBuffer * | buffer | ) |
Get the string content of the data buffer.
[in] | buffer | LinphoneBuffer object |
void* linphone_buffer_get_user_data | ( | const LinphoneBuffer * | buffer | ) |
Retrieve the user pointer associated with the buffer.
[in] | buffer | LinphoneBuffer object. |
bool_t linphone_buffer_is_empty | ( | const LinphoneBuffer * | buffer | ) |
Tell whether the LinphoneBuffer is empty.
[in] | buffer | LinphoneBuffer object |
LinphoneBuffer* linphone_buffer_new | ( | void | ) |
Create a new empty LinphoneBuffer object.
LinphoneBuffer* linphone_buffer_new_from_data | ( | const uint8_t * | data, |
size_t | size | ||
) |
Create a new LinphoneBuffer object from existing data.
[in] | data | The initial data to store in the LinphoneBuffer. |
[in] | size | The size of the initial data to stroe in the LinphoneBuffer. |
LinphoneBuffer* linphone_buffer_new_from_string | ( | const char * | data | ) |
Create a new LinphoneBuffer object from a string.
[in] | data | The initial string content of the LinphoneBuffer. |
LinphoneBuffer* linphone_buffer_ref | ( | LinphoneBuffer * | buffer | ) |
Acquire a reference to the buffer.
[in] | buffer | LinphoneBuffer object. |
void linphone_buffer_set_content | ( | LinphoneBuffer * | buffer, |
const uint8_t * | content, | ||
size_t | size | ||
) |
Set the content of the data buffer.
[in] | buffer | LinphoneBuffer object. |
[in] | content | The content of the data buffer. |
[in] | size | The 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.
[in] | buffer | LinphoneBuffer object |
[in] | size | The 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.
[in] | buffer | LinphoneBuffer object. |
[in] | content | The string content of the data buffer. |
void linphone_buffer_set_user_data | ( | LinphoneBuffer * | buffer, |
void * | ud | ||
) |
Assign a user pointer to the buffer.
[in] | buffer | LinphoneBuffer object. |
[in] | ud | The user pointer to associate with the buffer. |
void linphone_buffer_unref | ( | LinphoneBuffer * | buffer | ) |
Release reference to the buffer.
[in] | buffer | LinphoneBuffer object. |
const char* linphone_configuring_state_to_string | ( | LinphoneConfiguringState | cs | ) |
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.
[in] | content | LinphoneContent object. |
[in] | header_name | The name of the header to look for. |
[in] | header_value | The value of the header to look for. |
void* linphone_content_get_buffer | ( | const LinphoneContent * | content | ) |
Get the content data buffer, usually a string.
[in] | content | LinphoneContent object. |
const char* linphone_content_get_custom_header | ( | const LinphoneContent * | content, |
const char * | header_name | ||
) |
Get a custom header value of a content.
[in] | content | LinphoneContent object. |
[in] | header_name | The name of the header to get the value from. |
const char* linphone_content_get_encoding | ( | const LinphoneContent * | content | ) |
Get the encoding of the data buffer, for example "gzip".
[in] | content | LinphoneContent object. |
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.
[in] | content | LinphoneContent object. |
LinphoneContent* linphone_content_get_part | ( | const LinphoneContent * | content, |
int | idx | ||
) |
Get a part from a multipart content according to its index.
[in] | content | LinphoneContent object. |
[in] | idx | The index of the part to get. |
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.
[in] | content | LinphoneContent object. |
const char* linphone_content_get_string_buffer | ( | const LinphoneContent * | content | ) |
Get the string content data buffer.
[in] | content | LinphoneContent object |
const char* linphone_content_get_subtype | ( | const LinphoneContent * | content | ) |
Get the mime subtype of the content data.
[in] | content | LinphoneContent object. |
const char* linphone_content_get_type | ( | const LinphoneContent * | content | ) |
Get the mime type of the content data.
[in] | content | LinphoneContent object. |
void* linphone_content_get_user_data | ( | const LinphoneContent * | content | ) |
Retrieve the user pointer associated with the content.
[in] | content | LinphoneContent object. |
bool_t linphone_content_is_multipart | ( | const LinphoneContent * | content | ) |
Tell whether a content is a multipart content.
[in] | content | LinphoneContent object. |
LinphoneContent* linphone_content_ref | ( | LinphoneContent * | content | ) |
Acquire a reference to the content.
[in] | content | LinphoneContent object. |
void linphone_content_set_buffer | ( | LinphoneContent * | content, |
const void * | buffer, | ||
size_t | size | ||
) |
Set the content data buffer, usually a string.
[in] | content | LinphoneContent object. |
[in] | buffer | The content data buffer. |
[in] | size | The 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".
[in] | content | LinphoneContent object. |
[in] | encoding | The 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.
[in] | content | LinphoneContent object. |
[in] | name | The 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.
[in] | content | LinphoneContent object |
[in] | size | The content data buffer size. |
void linphone_content_set_string_buffer | ( | LinphoneContent * | content, |
const char * | buffer | ||
) |
Set the string content data buffer.
[in] | content | LinphoneContent object. |
[in] | buffer | The string content data buffer. |
void linphone_content_set_subtype | ( | LinphoneContent * | content, |
const char * | subtype | ||
) |
Set the mime subtype of the content data.
[in] | content | LinphoneContent object. |
[in] | subtype | The 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.
[in] | content | LinphoneContent object. |
[in] | type | The 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.
[in] | content | LinphoneContent object. |
[in] | ud | The user pointer to associate with the content. |
void linphone_content_unref | ( | LinphoneContent * | content | ) |
Release reference to the content.
[in] | content | LinphoneContent object. |
Create a content with default values from Linphone core.
[in] | lc | LinphoneCore object |
LpConfig* linphone_core_create_lp_config | ( | LinphoneCore * | lc, |
const char * | filename | ||
) |
Create a LpConfig object from a user config file.
[in] | lc | LinphoneCore object |
[in] | filename | The filename of the config file to read to fill the instantiated LpConfig |
LpConfig* linphone_core_get_config | ( | LinphoneCore * | lc | ) |
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.
const char* linphone_core_get_file_transfer_server | ( | LinphoneCore * | core | ) |
Get the globaly set http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml.
[in] | core | LinphoneCore from which to get the server_url |
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.
lc | the linphone core |
audiofile | path 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.
lc | the core |
reason | the LinphoneReason representing the failure error code. |
audiofile | a 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
[in] | core | LinphoneCore to be modified |
[in] | server_url | URL 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.
lc | the linphone core |
file | a path where to write the jpeg content. |
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
e164 | phone number |
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
iso | country code alpha2 |
const char* linphone_error_info_get_details | ( | const LinphoneErrorInfo * | ei | ) |
Provides additional information regarding the failure. With SIP protocol, the "Reason" and "Warning" headers are returned.
ei | the error info. |
const char* linphone_error_info_get_phrase | ( | const LinphoneErrorInfo * | ei | ) |
Get textual phrase from the error info. This is the text that is provided by the peer in the protocol (SIP).
ei | the error info. |
int linphone_error_info_get_protocol_code | ( | const LinphoneErrorInfo * | ei | ) |
Get the status code from the low level protocol (ex a SIP status code).
ei | the error info. |
LinphoneReason linphone_error_info_get_reason | ( | const LinphoneErrorInfo * | ei | ) |
const char* linphone_reason_to_string | ( | LinphoneReason | err | ) |
Converts a LinphoneReason enum to a string.
LinphoneTransportType linphone_transport_parse | ( | const char * | transport | ) |
Converts a lowercase string to a LinphoneTransportType enum.
const char* linphone_transport_to_string | ( | LinphoneTransportType | transport | ) |
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.
[in] | request | LinphoneXmlRpcRequest object. |
[in] | value | The 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.
[in] | request | LinphoneXmlRpcRequest object. |
[in] | value | The string value of the added argument. |
LinphoneXmlRpcRequestCbsResponseCb linphone_xml_rpc_request_cbs_get_response | ( | const LinphoneXmlRpcRequestCbs * | cbs | ) |
Get the response callback.
[in] | cbs | LinphoneXmlRpcRequestCbs object. |
void* linphone_xml_rpc_request_cbs_get_user_data | ( | const LinphoneXmlRpcRequestCbs * | cbs | ) |
Retrieve the user pointer associated with a LinphoneXmlRpcRequestCbs object.
[in] | cbs | LinphoneXmlRpcRequestCbs object. |
Acquire a reference to a LinphoneXmlRpcRequestCbs object.
[in] | cbs | LinphoneXmlRpcRequestCbs object. |
void linphone_xml_rpc_request_cbs_set_response | ( | LinphoneXmlRpcRequestCbs * | cbs, |
LinphoneXmlRpcRequestCbsResponseCb | cb | ||
) |
Set the response callback.
[in] | cbs | LinphoneXmlRpcRequestCbs object. |
[in] | cb | The response callback to be used. |
void linphone_xml_rpc_request_cbs_set_user_data | ( | LinphoneXmlRpcRequestCbs * | cbs, |
void * | ud | ||
) |
Assign a user pointer to a LinphoneXmlRpcRequestCbs object.
[in] | cbs | LinphoneXmlRpcRequestCbs object. |
[in] | ud | The user pointer to associate with the LinphoneXmlRpcRequestCbs object. |
void linphone_xml_rpc_request_cbs_unref | ( | LinphoneXmlRpcRequestCbs * | cbs | ) |
Release a reference to a LinphoneXmlRpcRequestCbs object.
[in] | cbs | LinphoneXmlRpcRequestCbs object. |
LinphoneXmlRpcRequestCbs* linphone_xml_rpc_request_get_callbacks | ( | const LinphoneXmlRpcRequest * | request | ) |
Get the LinphoneXmlRpcRequestCbs object associated with a LinphoneXmlRpcRequest.
[in] | request | LinphoneXmlRpcRequest object |
const char* linphone_xml_rpc_request_get_content | ( | const LinphoneXmlRpcRequest * | request | ) |
Get the content of the XML-RPC request.
[in] | request | LinphoneXmlRpcRequest object. |
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.
[in] | request | LinphoneXmlRpcRequest object. |
LinphoneXmlRpcStatus linphone_xml_rpc_request_get_status | ( | const LinphoneXmlRpcRequest * | request | ) |
Get the status of the XML-RPC request.
[in] | request | LinphoneXmlRpcRequest object. |
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.
[in] | request | LinphoneXmlRpcRequest object. |
void* linphone_xml_rpc_request_get_user_data | ( | const LinphoneXmlRpcRequest * | request | ) |
Retrieve the user pointer associated with the XML-RPC request.
[in] | request | LinphoneXmlRpcRequest object. |
LinphoneXmlRpcRequest* linphone_xml_rpc_request_new | ( | const char * | method, |
LinphoneXmlRpcArgType | return_type | ||
) |
Create a new LinphoneXmlRpcRequest object.
[in] | method | The XML-RPC method to call. |
[in] | return_type | The expected XML-RPC response type. |
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.
[in] | method | The XML-RPC method to call. |
[in] | return_type | The expected XML-RPC response type. |
Acquire a reference to the XML-RPC request.
[in] | request | LinphoneXmlRpcRequest object. |
void linphone_xml_rpc_request_set_user_data | ( | LinphoneXmlRpcRequest * | request, |
void * | ud | ||
) |
Assign a user pointer to the XML-RPC request.
[in] | request | LinphoneXmlRpcRequest object. |
[in] | ud | The user pointer to associate with the XML-RPC request. |
void linphone_xml_rpc_request_unref | ( | LinphoneXmlRpcRequest * | request | ) |
Release reference to the XML-RPC request.
[in] | request | LinphoneXmlRpcRequest object. |
void* linphone_xml_rpc_session_get_user_data | ( | const LinphoneXmlRpcSession * | session | ) |
Retrieve the user pointer associated with the XML-RPC session.
[in] | session | LinphoneXmlRpcSession object. |
LinphoneXmlRpcSession* linphone_xml_rpc_session_new | ( | LinphoneCore * | core, |
const char * | url | ||
) |
Create a new LinphoneXmlRpcSession object.
[in] | core | The LinphoneCore object used to send the XML-RPC requests. |
[in] | url | The URL of the XML-RPC server to send the XML-RPC requests to. |
Acquire a reference to the XML-RPC session.
[in] | session | LinphoneXmlRpcSession object. |
void linphone_xml_rpc_session_send_request | ( | LinphoneXmlRpcSession * | session, |
LinphoneXmlRpcRequest * | request | ||
) |
Send an XML-RPC request.
[in] | session | LinphoneXmlRpcSession object. |
[in] | request | The LinphoneXmlRpcRequest to be sent. |
void linphone_xml_rpc_session_set_user_data | ( | LinphoneXmlRpcSession * | session, |
void * | ud | ||
) |
Assign a user pointer to the XML-RPC session.
[in] | session | LinphoneXmlRpcSession object. |
[in] | ud | The user pointer to associate with the XML-RPC session. |
void linphone_xml_rpc_session_unref | ( | LinphoneXmlRpcSession * | session | ) |
Release reference to the XML-RPC session.
[in] | session | LinphoneXmlRpcSession object. |
void lp_config_clean_entry | ( | LpConfig * | lpconfig, |
const char * | section, | ||
const char * | key | ||
) |
Removes entries for key,value in a section.
[in] | lpconfig | The 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
[in] | lpconfig | The LpConfig object |
char* lp_config_dump_as_xml | ( | const LpConfig * | lpconfig | ) |
Dumps the LpConfig as XML into a buffer
[in] | lpconfig | The LpConfig object |
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.
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.
[in] | lpconfig | A LpConfig object |
[in] | section | The section from which to retrieve a configuration item |
[in] | key | The name of the configuration item to retrieve |
[in] | default_list | 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.
[in] | lpconfig | The 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.
filename | the filename of the config file to read to fill the instantiated LpConfig |
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.
buffer | the buffer from which the lpconfig will be retrieved. We expect the buffer to be null-terminated. |
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.
config_filename | the filename of the user config file to read to fill the instantiated LpConfig |
factory_config_filename | the filename of the factory config file to read to fill the instantiated LpConfig |
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.
lpconfig | The LpConfig object to fill with the content of the file |
filename | The 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.
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
[in] | lpconfig | A LpConfig object |
[in] | section | The name of the section to put the configuration item into |
[in] | key | The name of the configuration item to set |
[in] | value | A 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.