mirrors/linphone-iphone
1
0
Fork 1
mirror of https://gitlab.linphone.org/BC/public/linphone-iphone.git synced 2026-01-17 11:08:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixes references in Doxygen docstrings

Browse source
This commit is contained in:
François Grisez 2018-03-07 16:08:47 +01:00
parent ed9bc0f6db
commit a3c41aae31
44 changed files with 1550 additions and 1550 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

252
include/linphone/account_creator.h
View file

@ -33,302 +33,302 @@ extern "C" {
/**
* Callback to notify a response of server.
* @param[in] creator LinphoneAccountCreator object
* @param[in] status The status of the LinphoneAccountCreator test existence operation that has just finished
* @param[in] creator #LinphoneAccountCreator object
* @param[in] status The status of the #LinphoneAccountCreator test existence operation that has just finished
**/
typedef void (*LinphoneAccountCreatorCbsStatusCb)(LinphoneAccountCreator *creator, LinphoneAccountCreatorStatus status, const char* resp);
/************************** Start Account Creator data **************************/
/**
* Create a LinphoneAccountCreator and set Linphone Request callbacks.
* @param[in] core The LinphoneCore used for the XML-RPC communication
* Create a #LinphoneAccountCreator and set Linphone Request callbacks.
* @param[in] core The #LinphoneCore used for the XML-RPC communication
* @param[in] xmlrpc_url The URL to the XML-RPC server. Must be NON NULL.
* @return The new LinphoneAccountCreator object.
* @return The new #LinphoneAccountCreator object.
**/
LINPHONE_PUBLIC LinphoneAccountCreator * linphone_account_creator_new(LinphoneCore *core, const char *xmlrpc_url);
/**
* Reset the account creator entries like username, password, phone number...
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
**/
LINPHONE_PUBLIC void linphone_account_creator_reset(LinphoneAccountCreator *creator);
/**
* Send a request to know the existence of account on server.
* @param[in] creator LinphoneAccountCreator object
* @return LinphoneAccountCreatorStatusRequestOk if the request has been sent, LinphoneAccountCreatorStatusRequestFailed otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return #LinphoneAccountCreatorStatusRequestOk if the request has been sent, #LinphoneAccountCreatorStatusRequestFailed otherwise
**/
LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_is_account_exist(LinphoneAccountCreator *creator);
/**
* Send a request to create an account on server.
* @param[in] creator LinphoneAccountCreator object
* @return LinphoneAccountCreatorStatusRequestOk if the request has been sent, LinphoneAccountCreatorStatusRequestFailed otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return #LinphoneAccountCreatorStatusRequestOk if the request has been sent, #LinphoneAccountCreatorStatusRequestFailed otherwise
**/
LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_create_account(LinphoneAccountCreator *creator);
/**
* Send a request to know if an account is activated on server.
* @param[in] creator LinphoneAccountCreator object
* @return LinphoneAccountCreatorStatusRequestOk if the request has been sent, LinphoneAccountCreatorStatusRequestFailed otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return #LinphoneAccountCreatorStatusRequestOk if the request has been sent, #LinphoneAccountCreatorStatusRequestFailed otherwise
**/
LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_is_account_activated(LinphoneAccountCreator *creator);
/**
* Send a request to activate an account on server.
* @param[in] creator LinphoneAccountCreator object
* @return LinphoneAccountCreatorStatusRequestOk if the request has been sent, LinphoneAccountCreatorStatusRequestFailed otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return #LinphoneAccountCreatorStatusRequestOk if the request has been sent, #LinphoneAccountCreatorStatusRequestFailed otherwise
**/
LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_activate_account(LinphoneAccountCreator *creator);
/**
* Send a request to link an account to an alias.
* @param[in] creator LinphoneAccountCreator object
* @return LinphoneAccountCreatorStatusRequestOk if the request has been sent, LinphoneAccountCreatorStatusRequestFailed otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return #LinphoneAccountCreatorStatusRequestOk if the request has been sent, #LinphoneAccountCreatorStatusRequestFailed otherwise
**/
LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_link_account(LinphoneAccountCreator *creator);
/**
* Send a request to activate an alias.
* @param[in] creator LinphoneAccountCreator object
* @return LinphoneAccountCreatorStatusRequestOk if the request has been sent, LinphoneAccountCreatorStatusRequestFailed otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return #LinphoneAccountCreatorStatusRequestOk if the request has been sent, #LinphoneAccountCreatorStatusRequestFailed otherwise
**/
LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_activate_alias(LinphoneAccountCreator *creator);
/**
* Send a request to know if an alias is used.
* @param[in] creator LinphoneAccountCreator object
* @return LinphoneAccountCreatorStatusRequestOk if the request has been sent, LinphoneAccountCreatorStatusRequestFailed otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return #LinphoneAccountCreatorStatusRequestOk if the request has been sent, #LinphoneAccountCreatorStatusRequestFailed otherwise
**/
LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_is_alias_used(LinphoneAccountCreator *creator);
/**
* Send a request to know if an account is linked.
* @param[in] creator LinphoneAccountCreator object
* @return LinphoneAccountCreatorStatusRequestOk if the request has been sent, LinphoneAccountCreatorStatusRequestFailed otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return #LinphoneAccountCreatorStatusRequestOk if the request has been sent, #LinphoneAccountCreatorStatusRequestFailed otherwise
**/
LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_is_account_linked(LinphoneAccountCreator *creator);
/**
* Send a request to recover an account.
* @param[in] creator LinphoneAccountCreator object
* @return LinphoneAccountCreatorStatusRequestOk if the request has been sent, LinphoneAccountCreatorStatusRequestFailed otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return #LinphoneAccountCreatorStatusRequestOk if the request has been sent, #LinphoneAccountCreatorStatusRequestFailed otherwise
**/
LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_recover_account(LinphoneAccountCreator *creator);
/**
* Send a request to update an account.
* @param[in] creator LinphoneAccountCreator object
* @return LinphoneAccountCreatorStatusRequestOk if the request has been sent, LinphoneAccountCreatorStatusRequestFailed otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return #LinphoneAccountCreatorStatusRequestOk if the request has been sent, #LinphoneAccountCreatorStatusRequestFailed otherwise
**/
LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_update_account(LinphoneAccountCreator *creator);
/**
* Acquire a reference to the LinphoneAccountCreator.
* @param[in] creator LinphoneAccountCreator object.
* @return The same LinphoneAccountCreator object.
* @param[in] creator #LinphoneAccountCreator object.
* @return The same #LinphoneAccountCreator object.
**/
LINPHONE_PUBLIC LinphoneAccountCreator * linphone_account_creator_ref(LinphoneAccountCreator *creator);
/**
* Release reference to the LinphoneAccountCreator.
* @param[in] creator LinphoneAccountCreator object.
* @param[in] creator #LinphoneAccountCreator object.
**/
LINPHONE_PUBLIC void linphone_account_creator_unref(LinphoneAccountCreator *creator);
/**
* Retrieve the user pointer associated with the LinphoneAccountCreator.
* @param[in] creator LinphoneAccountCreator object.
* @param[in] creator #LinphoneAccountCreator object.
* @return The user pointer associated with the LinphoneAccountCreator.
**/
LINPHONE_PUBLIC void *linphone_account_creator_get_user_data(const LinphoneAccountCreator *creator);
/**
* Assign a user pointer to the LinphoneAccountCreator.
* @param[in] creator LinphoneAccountCreator object.
* @param[in] creator #LinphoneAccountCreator object.
* @param[in] ud The user pointer to associate with the LinphoneAccountCreator.
**/
LINPHONE_PUBLIC void linphone_account_creator_set_user_data(LinphoneAccountCreator *creator, void *ud);
/**
* Set the username.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] username The username to set
* @return LinphoneAccountCreatorUsernameStatusOk if everything is OK, or a specific error otherwise.
* @return #LinphoneAccountCreatorUsernameStatusOk if everything is OK, or a specific error otherwise.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorUsernameStatus linphone_account_creator_set_username(LinphoneAccountCreator *creator, const char *username);
/**
* Get the username.
* @param[in] creator LinphoneAccountCreator object
* @return The username of the LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The username of the #LinphoneAccountCreator
**/
LINPHONE_PUBLIC const char * linphone_account_creator_get_username(const LinphoneAccountCreator *creator);
/**
* Set the phone number normalized.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] phone_number The phone number to set
* @param[in] country_code Country code to associate phone number with
* @return LinphoneAccountCreatorPhoneNumberStatusOk if everything is OK, or specific(s) error(s) otherwise.
* @return #LinphoneAccountCreatorPhoneNumberStatusOk if everything is OK, or specific(s) error(s) otherwise.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorPhoneNumberStatusMask linphone_account_creator_set_phone_number(LinphoneAccountCreator *creator, const char *phone_number, const char *country_code);
/**
* Get the RFC 3966 normalized phone number.
* @param[in] creator LinphoneAccountCreator object
* @return The phone number of the LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The phone number of the #LinphoneAccountCreator
**/
LINPHONE_PUBLIC const char * linphone_account_creator_get_phone_number(const LinphoneAccountCreator *creator);
/**
* Set the password.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] password The password to set
* @return LinphoneAccountCreatorPasswordStatusOk if everything is OK, or specific(s) error(s) otherwise.
* @return #LinphoneAccountCreatorPasswordStatusOk if everything is OK, or specific(s) error(s) otherwise.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorPasswordStatus linphone_account_creator_set_password(LinphoneAccountCreator *creator, const char *password);
/**
* Get the password.
* @param[in] creator LinphoneAccountCreator object
* @return The password of the LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The password of the #LinphoneAccountCreator
**/
LINPHONE_PUBLIC const char * linphone_account_creator_get_password(const LinphoneAccountCreator *creator);
/**
* Set the ha1.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] ha1 The ha1 to set
* @return LinphoneAccountCreatorPasswordStatusOk if everything is OK, or a specific error otherwise.
* @return #LinphoneAccountCreatorPasswordStatusOk if everything is OK, or a specific error otherwise.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorPasswordStatus linphone_account_creator_set_ha1(LinphoneAccountCreator *creator, const char *ha1);
/**
* Get the ha1.
* @param[in] creator LinphoneAccountCreator object
* @return The ha1 of the LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The ha1 of the #LinphoneAccountCreator
**/
LINPHONE_PUBLIC const char * linphone_account_creator_get_ha1(const LinphoneAccountCreator *creator);
/**
* Set the activation code.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] activation_code The activation code to set
* @return LinphoneAccountCreatorActivationCodeStatusOk if everything is OK, or a specific error otherwise.
* @return #LinphoneAccountCreatorActivationCodeStatusOk if everything is OK, or a specific error otherwise.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorActivationCodeStatus linphone_account_creator_set_activation_code(LinphoneAccountCreator *creator, const char *activation_code);
/**
* Get the activation code.
* @param[in] creator LinphoneAccountCreator object
* @return The activation code of the LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The activation code of the #LinphoneAccountCreator
**/
LINPHONE_PUBLIC const char * linphone_account_creator_get_activation_code(const LinphoneAccountCreator *creator);
/**
* Set the language to use in email or SMS if supported.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] lang The language to use
* @return LinphoneAccountCreatorLanguageStatusOk if everything is OK, or a specific error otherwise.
* @return #LinphoneAccountCreatorLanguageStatusOk if everything is OK, or a specific error otherwise.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorLanguageStatus linphone_account_creator_set_language(LinphoneAccountCreator *creator, const char *lang);
/**
* Get the language use in email of SMS.
* @param[in] creator LinphoneAccountCreator object
* @return The language of the LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The language of the #LinphoneAccountCreator
**/
LINPHONE_PUBLIC const char * linphone_account_creator_get_language(const LinphoneAccountCreator *creator);
/**
* Set the display name.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] display_name The display name to set
* @return LinphoneAccountCreatorUsernameStatusOk if everything is OK, or a specific error otherwise.
* @return #LinphoneAccountCreatorUsernameStatusOk if everything is OK, or a specific error otherwise.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorUsernameStatus linphone_account_creator_set_display_name(LinphoneAccountCreator *creator, const char *display_name);
/**
* Get the display name.
* @param[in] creator LinphoneAccountCreator object
* @return The display name of the LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The display name of the #LinphoneAccountCreator
**/
LINPHONE_PUBLIC const char * linphone_account_creator_get_display_name(const LinphoneAccountCreator *creator);
/**
* Set the email.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] email The email to set
* @return LinphoneAccountCreatorEmailStatusOk if everything is OK, or a specific error otherwise.
* @return #LinphoneAccountCreatorEmailStatusOk if everything is OK, or a specific error otherwise.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorEmailStatus linphone_account_creator_set_email(LinphoneAccountCreator *creator, const char *email);
/**
* Get the email.
* @param[in] creator LinphoneAccountCreator object
* @return The email of the LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The email of the #LinphoneAccountCreator
**/
LINPHONE_PUBLIC const char * linphone_account_creator_get_email(const LinphoneAccountCreator *creator);
/**
* Set the domain.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] domain The domain to set
* @return LinphoneAccountCreatorDomainOk if everything is OK, or a specific error otherwise.
* @return #LinphoneAccountCreatorDomainOk if everything is OK, or a specific error otherwise.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorDomainStatus linphone_account_creator_set_domain(LinphoneAccountCreator *creator, const char *domain);
/**
* Get the domain.
* @param[in] creator LinphoneAccountCreator object
* @return The domain of the LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The domain of the #LinphoneAccountCreator
**/
LINPHONE_PUBLIC const char * linphone_account_creator_get_domain(const LinphoneAccountCreator *creator);
/**
* Set Transport
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] transport The transport to set
* @return LinphoneAccountCreatorTransportOk if everything is OK, or a specific error otherwise.
* @return #LinphoneAccountCreatorTransportOk if everything is OK, or a specific error otherwise.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorTransportStatus linphone_account_creator_set_transport(LinphoneAccountCreator *creator, LinphoneTransportType transport);
/**
* get Transport
* @param[in] creator LinphoneAccountCreator object
* @return The transport of LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The transport of #LinphoneAccountCreator
**/
LINPHONE_PUBLIC LinphoneTransportType linphone_account_creator_get_transport(const LinphoneAccountCreator *creator);
/**
* Set the route.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
* @param[in] route The route to set
* @return LinphoneAccountCreatorStatusRequestOk if everything is OK, or a specific error otherwise.
* @return #LinphoneAccountCreatorStatusRequestOk if everything is OK, or a specific error otherwise.
**/
LINPHONE_DEPRECATED LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_set_route(LinphoneAccountCreator *creator, const char *route);
/**
* Get the route.
* @param[in] creator LinphoneAccountCreator object
* @return The route of the LinphoneAccountCreator
* @param[in] creator #LinphoneAccountCreator object
* @return The route of the #LinphoneAccountCreator
**/
LINPHONE_DEPRECATED LINPHONE_PUBLIC const char * linphone_account_creator_get_route(const LinphoneAccountCreator *creator);
/**
* Get the LinphoneAccountCreatorCbs object associated with a LinphoneAccountCreator.
* @param[in] creator LinphoneAccountCreator object
* @return The LinphoneAccountCreatorCbs object associated with the LinphoneAccountCreator.
* Get the #LinphoneAccountCreatorCbs object associated with a LinphoneAccountCreator.
* @param[in] creator #LinphoneAccountCreator object
* @return The #LinphoneAccountCreatorCbs object associated with the LinphoneAccountCreator.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbs * linphone_account_creator_get_callbacks(const LinphoneAccountCreator *creator);
/**
* Get the LinphoneAccountCreatorService object associated with a LinphoneAccountCreator.
* @param[in] creator LinphoneAccountCreator object
* @return The LinphoneAccountCreatorService object associated with the LinphoneAccountCreator.
* Get the #LinphoneAccountCreatorService object associated with a LinphoneAccountCreator.
* @param[in] creator #LinphoneAccountCreator object
* @return The #LinphoneAccountCreatorService object associated with the LinphoneAccountCreator.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorService * linphone_account_creator_get_service(const LinphoneAccountCreator *creator);
@ -338,168 +338,168 @@ LINPHONE_PUBLIC LinphoneAccountCreatorService * linphone_account_creator_get_ser
/************************** Start Account Creator Cbs **************************/
/**
* Acquire a reference to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @return The same LinphoneAccountCreatorCbs object.
* Acquire a reference to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The same #LinphoneAccountCreatorCbs object.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbs * linphone_account_creator_cbs_ref(LinphoneAccountCreatorCbs *cbs);
/**
* Release a reference to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Release a reference to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_unref(LinphoneAccountCreatorCbs *cbs);
/**
* Retrieve the user pointer associated with a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @return The user pointer associated with the LinphoneAccountCreatorCbs object.
* Retrieve the user pointer associated with a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The user pointer associated with the #LinphoneAccountCreatorCbs object.
**/
LINPHONE_PUBLIC void *linphone_account_creator_cbs_get_user_data(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] ud The user pointer to associate with the LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] ud The user pointer to associate with the #LinphoneAccountCreatorCbs object.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_user_data(LinphoneAccountCreatorCbs *cbs, void *ud);
/**
* Get the create account request.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The current create account request.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_create_account(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] cb The create account request to be used.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_create_account(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
/**
* Get the is account exist request.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The current is account exist request.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_account_exist(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] cb The is account exist request to be used.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_is_account_exist(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
/**
* Get the activate account request.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The current activate account request.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_activate_account(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] cb The activate account request to be used.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_activate_account(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
/**
* Get the is account activated request.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The current is account activated request.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_account_activated(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] cb The is account activated request to be used.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_is_account_activated(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
/**
* Get the link account request.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The current link account request.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_link_account(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] cb The link account request to be used.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_link_account(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
/**
* Get the activate alias request.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The current link account request.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_activate_alias(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] cb The activate alias request to be used.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_activate_alias(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
/**
* Get the is alias used request.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The current is alias used request.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_alias_used(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] cb The is alias used request to be used.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_is_alias_used(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
/**
* Get the is account linked request.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The current is account linked request.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_account_linked(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] cb The is account linked request to be used.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_is_account_linked(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
/**
* Get the recover account request.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The current recover account request.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_recover_account(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] cb The recover account request to be used.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_recover_account(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
/**
* Get the update account request.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @return The current update account request.
**/
LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_update_account(const LinphoneAccountCreatorCbs *cbs);
/**
* Assign a user pointer to a LinphoneAccountCreatorCbs object.
* @param[in] cbs LinphoneAccountCreatorCbs object.
* Assign a user pointer to a #LinphoneAccountCreatorCbs object.
* @param[in] cbs #LinphoneAccountCreatorCbs object.
* @param[in] cb The update account request to be used.
**/
LINPHONE_PUBLIC void linphone_account_creator_cbs_set_update_account(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
@ -508,15 +508,15 @@ LINPHONE_PUBLIC void linphone_account_creator_cbs_set_update_account(LinphoneAcc
/**
* Create and configure a proxy config and a authentication info for an account creator
* @param[in] creator LinphoneAccountCreator object
* @return A LinphoneProxyConfig object if successful, NULL otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return A #LinphoneProxyConfig object if successful, NULL otherwise
**/
LINPHONE_PUBLIC LinphoneProxyConfig * linphone_account_creator_create_proxy_config(const LinphoneAccountCreator *creator);
/**
* Configure an account (create a proxy config and authentication info for it).
* @param[in] creator LinphoneAccountCreator object
* @return A LinphoneProxyConfig object if successful, NULL otherwise
* @param[in] creator #LinphoneAccountCreator object
* @return A #LinphoneProxyConfig object if successful, NULL otherwise
**/
LINPHONE_DEPRECATED LINPHONE_PUBLIC LinphoneProxyConfig * linphone_account_creator_configure(const LinphoneAccountCreator *creator);

100
include/linphone/account_creator_service.h
View file

@ -28,7 +28,7 @@ extern "C" {
/**
* Function to set custom server request.
* @param[in] creator LinphoneAccountCreator object
* @param[in] creator #LinphoneAccountCreator object
*/
typedef LinphoneAccountCreatorStatus (*LinphoneAccountCreatorRequestFunc)(LinphoneAccountCreator *creator);
@ -40,46 +40,46 @@ typedef LinphoneAccountCreatorStatus (*LinphoneAccountCreatorRequestFunc)(Linpho
/************************** Start Account Creator Requests **************************/
/**
* Create a new LinphoneAccountCreatorService object.
* @return a new LinphoneAccountCreatorService object.
* Create a new #LinphoneAccountCreatorService object.
* @return a new #LinphoneAccountCreatorService object.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorService * linphone_account_creator_service_new(void);
/**
* Acquire a reference to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* @return The same LinphoneAccountCreatorService object.
* Acquire a reference to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The same #LinphoneAccountCreatorService object.
* @donotwrap
**/
LinphoneAccountCreatorService * linphone_account_creator_service_ref(LinphoneAccountCreatorService *service);
/**
* Release a reference to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Release a reference to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @donotwrap
**/
void linphone_account_creator_service_unref(LinphoneAccountCreatorService *service);
/**
* Retrieve the user pointer associated with a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* @return The user pointer associated with the LinphoneAccountCreatorService object.
* Retrieve the user pointer associated with a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The user pointer associated with the #LinphoneAccountCreatorService object.
* @donotwrap
**/
LINPHONE_PUBLIC void *linphone_account_creator_service_get_user_data(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] ud The user pointer to associate with the LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] ud The user pointer to associate with the #LinphoneAccountCreatorService object.
* @donotwrap
**/
LINPHONE_PUBLIC void linphone_account_creator_service_set_user_data(LinphoneAccountCreatorService *service, void *ud);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The constructor of account creator requests.
* @donotwrap
**/
@ -87,15 +87,15 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_constructor_cb(Linphon
/**
* Get the constructor of account creator requests.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current constructor of create account request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_constructor_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The destructor.
* @donotwrap
**/
@ -103,7 +103,7 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_destructor_cb(Linphone
/**
* Get the destructor of create account request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current destructor of create account request.
* @donotwrap
**/
@ -111,15 +111,15 @@ LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_servi
/**
* Get the create account request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current create account request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_create_account_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The create account request to be used.
* @donotwrap
**/
@ -127,15 +127,15 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_create_account_cb(Linp
/**
* Get the is account exist request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current is account exist request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_is_account_exist_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The is account exist request to be used.
* @donotwrap
**/
@ -143,15 +143,15 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_is_account_exist_cb(Li
/**
* Get the activate account request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current activate account request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_activate_account_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The activate account request to be used.
* @donotwrap
**/
@ -159,15 +159,15 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_activate_account_cb(Li
/**
* Get the is account activated request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current is account activated request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_is_account_activated_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The is account activated request to be used.
* @donotwrap
**/
@ -175,15 +175,15 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_is_account_activated_c
/**
* Get the link account request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current link account request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_link_account_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The link account request to be used.
* @donotwrap
**/
@ -191,15 +191,15 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_link_account_cb(Linpho
/**
* Get the activate alias request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current link account request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_activate_alias_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The activate alias request to be used.
* @donotwrap
**/
@ -207,15 +207,15 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_activate_alias_cb(Linp
/**
* Get the is alias used request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current is alias used request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_is_alias_used_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The is alias used request to be used.
* @donotwrap
**/
@ -223,15 +223,15 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_is_alias_used_cb(Linph
/**
* Get the is account linked request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current is account linked request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_is_account_linked_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The is account linked request to be used.
* @donotwrap
**/
@ -239,15 +239,15 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_is_account_linked_cb(L
/**
* Get the recover account request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current recover account request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_recover_account_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The recover account request to be used.
* @donotwrap
**/
@ -255,15 +255,15 @@ LINPHONE_PUBLIC void linphone_account_creator_service_set_recover_account_cb(Lin
/**
* Get the update account request.
* @param[in] service LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @return The current update account request.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneAccountCreatorRequestFunc linphone_account_creator_service_get_update_account_cb(const LinphoneAccountCreatorService *service);
/**
* Assign a user pointer to a LinphoneAccountCreatorService object.
* @param[in] service LinphoneAccountCreatorService object.
* Assign a user pointer to a #LinphoneAccountCreatorService object.
* @param[in] service #LinphoneAccountCreatorService object.
* @param[in] cb The update account request to be used.
* @donotwrap
**/

42
include/linphone/api/c-address.h
View file

@ -34,23 +34,23 @@
*/
/**
* Constructs a LinphoneAddress object by parsing the user supplied address,
* Constructs a #LinphoneAddress object by parsing the user supplied address,
* given as a string.
**/
LINPHONE_PUBLIC LinphoneAddress *linphone_address_new (const char *address);
/**
* Clones a LinphoneAddress object.
* Clones a #LinphoneAddress object.
**/
LINPHONE_PUBLIC LinphoneAddress *linphone_address_clone (const LinphoneAddress *address);
/**
* Increment reference count of LinphoneAddress object.
* Increment reference count of #LinphoneAddress object.
**/
LINPHONE_PUBLIC LinphoneAddress *linphone_address_ref (LinphoneAddress *address);
/**
* Decrement reference count of LinphoneAddress object. When dropped to zero, memory is freed.
* Decrement reference count of #LinphoneAddress object. When dropped to zero, memory is freed.
**/
LINPHONE_PUBLIC void linphone_address_unref (LinphoneAddress *address);
@ -147,7 +147,7 @@ LINPHONE_PUBLIC const char *linphone_address_get_password (const LinphoneAddress
/**
* Set the password encoded in the address.
* It is used for basic authentication (not recommended).
* @param address the LinphoneAddress
* @param address the #LinphoneAddress
* @param password the password to set.
**/
LINPHONE_PUBLIC void linphone_address_set_password (LinphoneAddress *address, const char *password);
@ -170,19 +170,19 @@ LINPHONE_PUBLIC char *linphone_address_as_string (const LinphoneAddress *address
LINPHONE_PUBLIC char *linphone_address_as_string_uri_only (const LinphoneAddress *address);
/**
* Compare two LinphoneAddress ignoring tags and headers, basically just domain, username, and port.
* @param[in] address1 LinphoneAddress object
* @param[in] address2 LinphoneAddress object
* @return Boolean value telling if the LinphoneAddress objects are equal.
* Compare two #LinphoneAddress ignoring tags and headers, basically just domain, username, and port.
* @param[in] address1 #LinphoneAddress object
* @param[in] address2 #LinphoneAddress object
* @return Boolean value telling if the #LinphoneAddress objects are equal.
* @see linphone_address_equal()
**/
LINPHONE_PUBLIC bool_t linphone_address_weak_equal (const LinphoneAddress *address1, const LinphoneAddress *address2);
/**
* Compare two LinphoneAddress taking the tags and headers into account.
* @param[in] address1 LinphoneAddress object
* @param[in] address2 LinphoneAddress object
* @return Boolean value telling if the LinphoneAddress objects are equal.
* Compare two #LinphoneAddress taking the tags and headers into account.
* @param[in] address1 #LinphoneAddress object
* @param[in] address2 #LinphoneAddress object
* @return Boolean value telling if the #LinphoneAddress objects are equal.
* @see linphone_address_weak_equal()
*/
LINPHONE_PUBLIC bool_t linphone_address_equal (const LinphoneAddress *address1, const LinphoneAddress *address2);
@ -204,7 +204,7 @@ LINPHONE_PUBLIC void linphone_address_set_header (LinphoneAddress *address, cons
/**
* Tell whether a parameter is present in the address
* @param[in] address LinphoneAddress object
* @param[in] address #LinphoneAddress object
* @param[in] param_name The name of the parameter
* @return A boolean value telling whether the parameter is present in the address
*/
@ -212,7 +212,7 @@ LINPHONE_PUBLIC bool_t linphone_address_has_param (const LinphoneAddress *addres
/**
* Get the value of a parameter of the address
* @param[in] address LinphoneAddress object
* @param[in] address #LinphoneAddress object
* @param[in] param_name The name of the parameter
* @return The value of the parameter
*/
@ -220,7 +220,7 @@ LINPHONE_PUBLIC const char *linphone_address_get_param (const LinphoneAddress *a
/**
* Set the value of a parameter of the address
* @param[in] address LinphoneAddress object
* @param[in] address #LinphoneAddress object
* @param[in] param_name The name of the parameter
* @param[in] param_value The new value of the parameter
*/
@ -230,7 +230,7 @@ LINPHONE_PUBLIC void linphone_address_set_params (LinphoneAddress *address, cons
/**
* Tell whether a parameter is present in the URI of the address
* @param[in] address LinphoneAddress object
* @param[in] address #LinphoneAddress object
* @param[in] uri_param_name The name of the parameter
* @return A boolean value telling whether the parameter is present in the URI of the address
*/
@ -238,7 +238,7 @@ LINPHONE_PUBLIC bool_t linphone_address_has_uri_param (const LinphoneAddress *ad
/**
* Get the value of a parameter of the URI of the address
* @param[in] address LinphoneAddress object
* @param[in] address #LinphoneAddress object
* @param[in] uri_param_name The name of the parameter
* @return The value of the parameter
*/
@ -246,7 +246,7 @@ LINPHONE_PUBLIC const char *linphone_address_get_uri_param (const LinphoneAddres
/**
* Set the value of a parameter of the URI of the address
* @param[in] address LinphoneAddress object
* @param[in] address #LinphoneAddress object
* @param[in] uri_param_name The name of the parameter
* @param[in] uri_param_value The new value of the parameter
*/
@ -256,13 +256,13 @@ LINPHONE_PUBLIC void linphone_address_set_uri_params (LinphoneAddress *address,
/**
* Removes the value of a parameter of the URI of the address
* @param[in] address LinphoneAddress object
* @param[in] address #LinphoneAddress object
* @param[in] uri_param_name The name of the parameter
*/
LINPHONE_PUBLIC void linphone_address_remove_uri_param (LinphoneAddress *address, const char *uri_param_name);
/**
* Destroys a LinphoneAddress object (actually calls linphone_address_unref()).
* Destroys a #LinphoneAddress object (actually calls linphone_address_unref()).
* @deprecated Use linphone_address_unref() instead
* @donotwrap
**/

50
include/linphone/api/c-call-cbs.h
View file

@ -35,126 +35,126 @@
*/
/**
* Acquire a reference to the LinphoneCallCbs object.
* @param[in] cbs LinphoneCallCbs object.
* @return The same LinphoneCallCbs object.
* Acquire a reference to the #LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @return The same #LinphoneCallCbs object.
*/
LINPHONE_PUBLIC LinphoneCallCbs *linphone_call_cbs_ref (LinphoneCallCbs *cbs);
/**
* Release reference to the LinphoneCallCbs object.
* @param[in] cbs LinphoneCallCbs object.
* Release reference to the #LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
*/
LINPHONE_PUBLIC void linphone_call_cbs_unref (LinphoneCallCbs *cbs);
/**
* Retrieve the user pointer associated with the LinphoneCallCbs object.
* @param[in] cbs LinphoneCallCbs object.
* @return The user pointer associated with the LinphoneCallCbs object.
* Retrieve the user pointer associated with the #LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @return The user pointer associated with the #LinphoneCallCbs object.
*/
LINPHONE_PUBLIC void *linphone_call_cbs_get_user_data (const LinphoneCallCbs *cbs);
/**
* Assign a user pointer to the LinphoneCallCbs object.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] ud The user pointer to associate with the LinphoneCallCbs object.
* Assign a user pointer to the #LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @param[in] ud The user pointer to associate with the #LinphoneCallCbs object.
*/
LINPHONE_PUBLIC void linphone_call_cbs_set_user_data (LinphoneCallCbs *cbs, void *ud);
/**
* Get the dtmf received callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @return The current dtmf received callback.
*/
LINPHONE_PUBLIC LinphoneCallCbsDtmfReceivedCb linphone_call_cbs_get_dtmf_received (LinphoneCallCbs *cbs);
/**
* Set the dtmf received callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @param[in] cb The dtmf received callback to be used.
*/
LINPHONE_PUBLIC void linphone_call_cbs_set_dtmf_received (LinphoneCallCbs *cbs, LinphoneCallCbsDtmfReceivedCb cb);
/**
* Get the encryption changed callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @return The current encryption changed callback.
*/
LINPHONE_PUBLIC LinphoneCallCbsEncryptionChangedCb linphone_call_cbs_get_encryption_changed (LinphoneCallCbs *cbs);
/**
* Set the encryption changed callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @param[in] cb The encryption changed callback to be used.
*/
LINPHONE_PUBLIC void linphone_call_cbs_set_encryption_changed (LinphoneCallCbs *cbs, LinphoneCallCbsEncryptionChangedCb cb);
/**
* Get the info message received callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @return The current info message received callback.
*/
LINPHONE_PUBLIC LinphoneCallCbsInfoMessageReceivedCb linphone_call_cbs_get_info_message_received (LinphoneCallCbs *cbs);
/**
* Set the info message received callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @param[in] cb The info message received callback to be used.
*/
LINPHONE_PUBLIC void linphone_call_cbs_set_info_message_received (LinphoneCallCbs *cbs, LinphoneCallCbsInfoMessageReceivedCb cb);
/**
* Get the state changed callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @return The current state changed callback.
*/
LINPHONE_PUBLIC LinphoneCallCbsStateChangedCb linphone_call_cbs_get_state_changed (LinphoneCallCbs *cbs);
/**
* Set the state changed callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @param[in] cb The state changed callback to be used.
*/
LINPHONE_PUBLIC void linphone_call_cbs_set_state_changed (LinphoneCallCbs *cbs, LinphoneCallCbsStateChangedCb cb);
/**
* Get the stats updated callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @return The current stats updated callback.
*/
LINPHONE_PUBLIC LinphoneCallCbsStatsUpdatedCb linphone_call_cbs_get_stats_updated (LinphoneCallCbs *cbs);
/**
* Set the stats updated callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @param[in] cb The stats updated callback to be used.
*/
LINPHONE_PUBLIC void linphone_call_cbs_set_stats_updated (LinphoneCallCbs *cbs, LinphoneCallCbsStatsUpdatedCb cb);
/**
* Get the transfer state changed callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @return The current transfer state changed callback.
*/
LINPHONE_PUBLIC LinphoneCallCbsTransferStateChangedCb linphone_call_cbs_get_transfer_state_changed (LinphoneCallCbs *cbs);
/**
* Set the transfer state changed callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @param[in] cb The transfer state changed callback to be used.
*/
LINPHONE_PUBLIC void linphone_call_cbs_set_transfer_state_changed (LinphoneCallCbs *cbs, LinphoneCallCbsTransferStateChangedCb cb);
/**
* Get the ACK processing callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @return The current ack processing callback.
*/
LINPHONE_PUBLIC LinphoneCallCbsAckProcessingCb linphone_call_cbs_get_ack_processing (LinphoneCallCbs *cbs);
/**
* Set ACK processing callback.
* @param[in] cbs LinphoneCallCbs object.
* @param[in] cbs #LinphoneCallCbs object.
* @param[in] cb The ack processing callback to be used.
*/
LINPHONE_PUBLIC void linphone_call_cbs_set_ack_processing (LinphoneCallCbs *cbs, LinphoneCallCbsAckProcessingCb cb);

40
include/linphone/api/c-call-stats.h
View file

@ -46,29 +46,29 @@
/**
* Increment refcount.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @ingroup misc
**/
LINPHONE_PUBLIC LinphoneCallStats *linphone_call_stats_ref (LinphoneCallStats *stats);
/**
* Decrement refcount and possibly free the object.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @ingroup misc
**/
LINPHONE_PUBLIC void linphone_call_stats_unref (LinphoneCallStats *stats);
/**
* Gets the user data in the LinphoneCallStats object
* @param[in] stats the LinphoneCallStats
* Gets the user data in the #LinphoneCallStats object
* @param[in] stats the #LinphoneCallStats
* @return the user data
* @ingroup misc
*/
LINPHONE_PUBLIC void *linphone_call_stats_get_user_data (const LinphoneCallStats *stats);
/**
* Sets the user data in the LinphoneCallStats object
* @param[in] stats the LinphoneCallStats object
* Sets the user data in the #LinphoneCallStats object
* @param[in] stats the #LinphoneCallStats object
* @param[in] data the user data
* @ingroup misc
*/
@ -76,7 +76,7 @@ LINPHONE_PUBLIC void linphone_call_stats_set_user_data (LinphoneCallStats *stats
/**
* Get the type of the stream the stats refer to.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The type of the stream the stats refer to
*/
LINPHONE_PUBLIC LinphoneStreamType linphone_call_stats_get_type (const LinphoneCallStats *stats);
@ -107,14 +107,14 @@ LINPHONE_PUBLIC float linphone_call_stats_get_local_late_rate (const LinphoneCal
/**
* Gets the local interarrival jitter
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The interarrival jitter at last emitted sender report
**/
LINPHONE_PUBLIC float linphone_call_stats_get_sender_interarrival_jitter (const LinphoneCallStats *stats);
/**
* Gets the remote reported interarrival jitter
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The interarrival jitter at last received receiver report
**/
LINPHONE_PUBLIC float linphone_call_stats_get_receiver_interarrival_jitter (const LinphoneCallStats *stats);
@ -123,77 +123,77 @@ LINPHONE_PUBLIC const rtp_stats_t *linphone_call_stats_get_rtp_stats (const Linp
/**
* Gets the cumulative number of late packets
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The cumulative number of late packets
**/
LINPHONE_PUBLIC uint64_t linphone_call_stats_get_late_packets_cumulative_number (const LinphoneCallStats *stats);
/**
* Get the bandwidth measurement of the received stream, expressed in kbit/s, including IP/UDP/RTP headers.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The bandwidth measurement of the received stream in kbit/s.
*/
LINPHONE_PUBLIC float linphone_call_stats_get_download_bandwidth (const LinphoneCallStats *stats);
/**
* Get the bandwidth measurement of the sent stream, expressed in kbit/s, including IP/UDP/RTP headers.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The bandwidth measurement of the sent stream in kbit/s.
*/
LINPHONE_PUBLIC float linphone_call_stats_get_upload_bandwidth (const LinphoneCallStats *stats);
/**
* Get the bandwidth measurement of the received RTCP, expressed in kbit/s, including IP/UDP/RTP headers.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The bandwidth measurement of the received RTCP in kbit/s.
*/
LINPHONE_PUBLIC float linphone_call_stats_get_rtcp_download_bandwidth (const LinphoneCallStats *stats);
/**
* Get the bandwidth measurement of the sent RTCP, expressed in kbit/s, including IP/UDP/RTP headers.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The bandwidth measurement of the sent RTCP in kbit/s.
*/
LINPHONE_PUBLIC float linphone_call_stats_get_rtcp_upload_bandwidth( const LinphoneCallStats *stats);
/**
* Get the state of ICE processing.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The state of ICE processing.
*/
LINPHONE_PUBLIC LinphoneIceState linphone_call_stats_get_ice_state (const LinphoneCallStats *stats);
/**
* Get the state of uPnP processing.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The state of uPnP processing.
*/
LINPHONE_PUBLIC LinphoneUpnpState linphone_call_stats_get_upnp_state (const LinphoneCallStats *stats);
/**
* Get the IP address family of the remote peer.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The IP address family of the remote peer.
*/
LINPHONE_PUBLIC LinphoneAddressFamily linphone_call_stats_get_ip_family_of_remote (const LinphoneCallStats *stats);
/**
* Get the jitter buffer size in ms.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The jitter buffer size in ms.
*/
LINPHONE_PUBLIC float linphone_call_stats_get_jitter_buffer_size_ms (const LinphoneCallStats *stats);
/**
* Get the round trip delay in s.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The round trip delay in s.
*/
LINPHONE_PUBLIC float linphone_call_stats_get_round_trip_delay (const LinphoneCallStats *stats);
/**
* Get the estimated bandwidth measurement of the received stream, expressed in kbit/s, including IP/UDP/RTP headers.
* @param[in] stats LinphoneCallStats object
* @param[in] stats #LinphoneCallStats object
* @return The estimated bandwidth measurement of the received stream in kbit/s.
*/
LINPHONE_PUBLIC float linphone_call_stats_get_estimated_download_bandwidth(const LinphoneCallStats *stats);

122
include/linphone/api/c-call.h
View file

@ -68,8 +68,8 @@ LINPHONE_PUBLIC void linphone_call_set_user_data (LinphoneCall *call, void *ud);
/**
* Get the core that has created the specified call.
* @param[in] call LinphoneCall object
* @return The LinphoneCore object that has created the specified call.
* @param[in] call #LinphoneCall object
* @return The #LinphoneCore object that has created the specified call.
*/
LINPHONE_PUBLIC LinphoneCore * linphone_call_get_core (const LinphoneCall *call);
@ -80,7 +80,7 @@ LINPHONE_PUBLIC LinphoneCallState linphone_call_get_state (const LinphoneCall *c
/**
* Tell whether a call has been asked to autoanswer
* @param[in] call LinphoneCall object
* @param[in] call #LinphoneCall object
* @return A boolean value telling whether the call has been asked to autoanswer
**/
LINPHONE_PUBLIC bool_t linphone_call_asked_to_autoanswer (LinphoneCall *call);
@ -118,14 +118,14 @@ LINPHONE_PUBLIC LinphoneCallDir linphone_call_get_dir (const LinphoneCall *call)
/**
* Gets the call log associated to this call.
* @param[in] call LinphoneCall object
* @return The LinphoneCallLog associated with the specified LinphoneCall
* @param[in] call #LinphoneCall object
* @return The #LinphoneCallLog associated with the specified #LinphoneCall
**/
LINPHONE_PUBLIC LinphoneCallLog *linphone_call_get_call_log (const LinphoneCall *call);
/**
* Gets the refer-to uri (if the call was transfered).
* @param[in] call LinphoneCall object
* @param[in] call #LinphoneCall object
* @return The refer-to uri of the call (if it was transfered)
**/
LINPHONE_PUBLIC const char *linphone_call_get_refer_to (const LinphoneCall *call);
@ -143,7 +143,7 @@ LINPHONE_PUBLIC bool_t linphone_call_has_transfer_pending (const LinphoneCall *c
/**
* Gets the transferer if this call was started automatically as a result of an incoming transfer request.
* The call in which the transfer request was received is returned in this case.
* @param[in] call LinphoneCall object
* @param[in] call #LinphoneCall object
* @return The transferer call if the specified call was started automatically as a result of an incoming transfer request, NULL otherwise
**/
LINPHONE_PUBLIC LinphoneCall *linphone_call_get_transferer_call (const LinphoneCall *call);
@ -192,7 +192,7 @@ LINPHONE_PUBLIC bool_t linphone_call_camera_enabled (const LinphoneCall *lc);
/**
* Take a photo of currently received video 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.
* @param call a LinphoneCall
* @param call a #LinphoneCall
* @param file a path where to write the jpeg content.
* @return 0 if successfull, -1 otherwise (typically if jpeg format is not supported).
**/
@ -201,7 +201,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_take_video_snapshot (LinphoneCall *
/**
* Take a photo of currently captured video 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.
* @param call a LinphoneCall
* @param call a #LinphoneCall
* @param file a path where to write the jpeg content.
* @return 0 if successfull, -1 otherwise (typically if jpeg format is not supported).
**/
@ -214,8 +214,8 @@ LINPHONE_PUBLIC LinphoneReason linphone_call_get_reason (const LinphoneCall *cal
/**
* Returns full details about call errors or termination reasons.
* @param call LinphoneCall object on which we want the information error
* @return LinphoneErrorInfo object holding the reason error.
* @param call #LinphoneCall object on which we want the information error
* @return #LinphoneErrorInfo object holding the reason error.
*/
LINPHONE_PUBLIC const LinphoneErrorInfo *linphone_call_get_error_info (const LinphoneCall *call);
@ -231,7 +231,7 @@ LINPHONE_PUBLIC const char *linphone_call_get_remote_contact (LinphoneCall *call
/**
* Returns the ZRTP authentication token to verify.
* @param call the LinphoneCall
* @param call the #LinphoneCall
* @return the authentication token to verify.
**/
LINPHONE_PUBLIC const char *linphone_call_get_authentication_token (LinphoneCall *call);
@ -240,7 +240,7 @@ LINPHONE_PUBLIC const char *linphone_call_get_authentication_token (LinphoneCall
* Returns whether ZRTP authentication token is verified.
* If not, it must be verified by users as described in ZRTP procedure.
* Once done, the application must inform of the results with linphone_call_set_authentication_token_verified().
* @param call the LinphoneCall
* @param call the #LinphoneCall
* @return TRUE if authentication token is verifed, false otherwise.
**/
LINPHONE_PUBLIC bool_t linphone_call_get_authentication_token_verified (const LinphoneCall *call);
@ -248,7 +248,7 @@ LINPHONE_PUBLIC bool_t linphone_call_get_authentication_token_verified (const Li
/**
* Set the result of ZRTP short code verification by user.
* If remote party also does the same, it will update the ZRTP cache so that user's verification will not be required for the two users.
* @param call the LinphoneCall
* @param call the #LinphoneCall
* @param verified whether the ZRTP SAS is verified.
**/
LINPHONE_PUBLIC void linphone_call_set_authentication_token_verified (LinphoneCall *call, bool_t verified);
@ -291,7 +291,7 @@ LINPHONE_PUBLIC void linphone_call_zoom (LinphoneCall *call, float zoom_factor,
* Send the specified dtmf.
*
* The dtmf is automatically played to the user.
* @param call The LinphoneCall object
* @param call The #LinphoneCall object
* @param dtmf The dtmf name specified as a char, such as '0', '#' etc...
* @return 0 if successful, -1 on error.
**/
@ -302,7 +302,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_send_dtmf (LinphoneCall *call, char
*
* The dtmfs are automatically sent to remote, separated by some needed customizable delay.
* Sending is canceled if the call state changes to something not LinphoneCallStreamsRunning.
* @param call The LinphoneCall object
* @param call The #LinphoneCall object
* @param dtmfs A dtmf sequence such as '123#123123'
* @return -2 if there is already a DTMF sequence, -1 if call is not ready, 0 otherwise.
**/
@ -314,7 +314,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_send_dtmfs (LinphoneCall *call, con
* Please note that some DTMF could be already sent,
* depending on when this function call is delayed from #linphone_call_send_dtmfs. This
* function will be automatically called if call state change to anything but LinphoneCallStreamsRunning.
* @param call The LinphoneCall object
* @param call The #LinphoneCall object
**/
LINPHONE_PUBLIC void linphone_call_cancel_dtmfs (LinphoneCall *call);
@ -374,7 +374,7 @@ LINPHONE_PUBLIC RtpTransport *linphone_call_get_meta_rtcp_transport (const Linph
* Pauses the call. If a music file has been setup using linphone_core_set_play_file(),
* this file will be played to the remote user.
* The only way to resume a paused call is to call linphone_call_resume().
* @param[in] call LinphoneCall object
* @param[in] call #LinphoneCall object
* @return 0 on success, -1 on failure
* @see linphone_call_resume()
**/
@ -383,7 +383,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_pause (LinphoneCall *call);
/**
* Resumes a call.
* The call needs to have been paused previously with linphone_call_pause().
* @param[in] call LinphoneCall object
* @param[in] call #LinphoneCall object
* @return 0 on success, -1 on failure
* @see linphone_call_pause()
**/
@ -391,21 +391,21 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_resume (LinphoneCall *call);
/**
* Terminates a call.
* @param[in] call LinphoneCall object
* @param[in] call #LinphoneCall object
* @return 0 on success, -1 on failure
**/LINPHONE_PUBLIC LinphoneStatus linphone_call_terminate (LinphoneCall *call);
/**
* Terminates a call.
* @param[in] call LinphoneCall object
* @param[in] ei LinphoneErrorInfo
* @param[in] call #LinphoneCall object
* @param[in] ei #LinphoneErrorInfo
* @return 0 on success, -1 on failure
**/
LINPHONE_PUBLIC LinphoneStatus linphone_call_terminate_with_error_info (LinphoneCall *call, const LinphoneErrorInfo *ei);
/**
* Redirect the specified call to the given redirect URI.
* @param[in] call A LinphoneCall object
* @param[in] call A #LinphoneCall object
* @param[in] redirect_uri The URI to redirect the call to
* @return 0 if successful, -1 on error.
*/
@ -413,16 +413,16 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_redirect (LinphoneCall *call, const
/**
* Decline a pending incoming call, with a reason.
* @param[in] call A LinphoneCall object that must be in the IncomingReceived state
* @param[in] reason The reason for rejecting the call: LinphoneReasonDeclined or LinphoneReasonBusy
* @param[in] call A #LinphoneCall object that must be in the IncomingReceived state
* @param[in] reason The reason for rejecting the call: #LinphoneReasonDeclined or #LinphoneReasonBusy
* @return 0 on success, -1 on failure
**/
LINPHONE_PUBLIC LinphoneStatus linphone_call_decline (LinphoneCall *call, LinphoneReason reason);
/**
* Decline a pending incoming call, with a LinphoneErrorInfo object.
* @param[in] call A LinphoneCall object that must be in the IncomingReceived state
* @param[in] ei LinphoneErrorInfo containing more information on the call rejection.
* Decline a pending incoming call, with a #LinphoneErrorInfo object.
* @param[in] call A #LinphoneCall object that must be in the IncomingReceived state
* @param[in] ei #LinphoneErrorInfo containing more information on the call rejection.
* @return 0 on success, -1 on failure
*/
LINPHONE_PUBLIC int linphone_call_decline_with_error_info (LinphoneCall *call, const LinphoneErrorInfo *ei);
@ -432,9 +432,9 @@ LINPHONE_PUBLIC int linphone_call_decline_with_error_info (LinphoneCall *call, c
*
* Basically the application is notified of incoming calls within the
* call_state_changed callback of the #LinphoneCoreVTable structure, where it will receive
* a LinphoneCallIncoming event with the associated LinphoneCall object.
* a #LinphoneCallIncoming event with the associated #LinphoneCall object.
* The application can later accept the call using this method.
* @param[in] call A LinphoneCall object
* @param[in] call A #LinphoneCall object
* @return 0 on success, -1 on failure
**/
LINPHONE_PUBLIC LinphoneStatus linphone_call_accept (LinphoneCall *call);
@ -444,9 +444,9 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_accept (LinphoneCall *call);
*
* Basically the application is notified of incoming calls within the
* call_state_changed callback of the #LinphoneCoreVTable structure, where it will receive
* a LinphoneCallIncoming event with the associated LinphoneCall object.
* a #LinphoneCallIncoming event with the associated #LinphoneCall object.
* The application can later accept the call using this method.
* @param[in] call A LinphoneCall object
* @param[in] call A #LinphoneCall object
* @param[in] params The specific parameters for this call, for example whether video is accepted or not. Use NULL to use default parameters
* @return 0 on success, -1 on failure
**/
@ -455,7 +455,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_accept_with_params (LinphoneCall *c
/**
* Accept an early media session for an incoming call.
* This is identical as calling linphone_call_accept_early_media_with_params() with NULL parameters.
* @param[in] call A LinphoneCall object
* @param[in] call A #LinphoneCall object
* @return 0 if successful, -1 otherwise
* @see linphone_call_accept_early_media_with_params()
**/
@ -466,7 +466,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_accept_early_media (LinphoneCall *c
* This means the call is not accepted but audio & video streams can be established if the remote party supports early media.
* However, unlike after call acceptance, mic and camera input are not sent during early-media, though received audio & video are played normally.
* The call can then later be fully accepted using linphone_call_accept() or linphone_call_accept_with_params().
* @param[in] call A LinphoneCall object
* @param[in] call A #LinphoneCall object
* @param[in] params The call parameters to use (can be NULL)
* @return 0 if successful, -1 otherwise
**/
@ -475,35 +475,35 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_accept_early_media_with_params (Lin
/**
* Updates a running call according to supplied call parameters or parameters changed in the LinphoneCore.
* In this version this is limited to the following use cases:
* - setting up/down the video stream according to the video parameter of the LinphoneCallParams (see linphone_call_params_enable_video() ).
* - setting up/down the video stream according to the video parameter of the #LinphoneCallParams (see linphone_call_params_enable_video() ).
* - changing the size of the transmitted video after calling linphone_core_set_preferred_video_size()
* In case no changes are requested through the LinphoneCallParams argument, then this argument can be omitted and set to NULL.
* WARNING: Updating a call in the LinphoneCallPaused state will still result in a paused call even if the media directions set in the
* In case no changes are requested through the #LinphoneCallParams argument, then this argument can be omitted and set to NULL.
* WARNING: Updating a call in the #LinphoneCallPaused state will still result in a paused call even if the media directions set in the
* params are sendrecv. To resume a paused call, you need to call linphone_call_resume().
*
* @param[in] call A LinphoneCall object
* @param[in] call A #LinphoneCall object
* @param[in] params The new call parameters to use (may be NULL)
* @return 0 if successful, -1 otherwise.
**/
LINPHONE_PUBLIC LinphoneStatus linphone_call_update (LinphoneCall *call, const LinphoneCallParams *params);
/**
* When receiving a #LinphoneCallUpdatedByRemote state notification, prevent LinphoneCore from performing an automatic answer.
* When receiving a #LinphoneCallUpdatedByRemote state notification, prevent #LinphoneCore from performing an automatic answer.
*
* When receiving a #LinphoneCallUpdatedByRemote state notification (ie an incoming reINVITE), the default behaviour of
* LinphoneCore is defined by the "defer_update_default" option of the "sip" section of the config. If this option is 0 (the default)
* then the LinphoneCore automatically answers the reINIVTE with call parameters unchanged.
* #LinphoneCore is defined by the "defer_update_default" option of the "sip" section of the config. If this option is 0 (the default)
* then the #LinphoneCore automatically answers the reINIVTE with call parameters unchanged.
* However when for example when the remote party updated the call to propose a video stream, it can be useful
* to prompt the user before answering. This can be achieved by calling linphone_core_defer_call_update() during
* the call state notification, to deactivate the automatic answer that would just confirm the audio but reject the video.
* Then, when the user responds to dialog prompt, it becomes possible to call linphone_call_accept_update() to answer
* the reINVITE, with eventually video enabled in the LinphoneCallParams argument.
* the reINVITE, with eventually video enabled in the #LinphoneCallParams argument.
*
* The #LinphoneCallUpdatedByRemote notification can also arrive when receiving an INVITE without SDP. In such case, an unchanged offer is made
* in the 200Ok, and when the ACK containing the SDP answer is received, #LinphoneCallUpdatedByRemote is triggered to notify the application of possible
* changes in the media session. However in such case defering the update has no meaning since we just generating an offer.
*
* @param[in] call A LinphoneCall object
* @param[in] call A #LinphoneCall object
* @return 0 if successful, -1 if the linphone_call_defer_update() was done outside a valid #LinphoneCallUpdatedByRemote notification
**/
LINPHONE_PUBLIC LinphoneStatus linphone_call_defer_update (LinphoneCall *call);
@ -521,8 +521,8 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_defer_update (LinphoneCall *call);
* If params is not NULL, then the update will be accepted according to the parameters passed.
* Typical example is when a user accepts to start video, then params should indicate that video stream should be used
* (see linphone_call_params_enable_video()).
* @param[in] call A LinphoneCall object
* @param[in] params A LinphoneCallParams object describing the call parameters to accept
* @param[in] call A #LinphoneCall object
* @param[in] params A #LinphoneCallParams object describing the call parameters to accept
* @return 0 if successful, -1 otherwise (actually when this function call is performed outside ot #LinphoneCallUpdatedByRemote state)
**/
LINPHONE_PUBLIC LinphoneStatus linphone_call_accept_update (LinphoneCall *call, const LinphoneCallParams *params);
@ -706,8 +706,8 @@ LINPHONE_PUBLIC void linphone_call_stop_recording(LinphoneCall *call);
/**
* Get a player associated with the call to play a local file and stream it to the remote peer.
* @param[in] call LinphoneCall object
* @return A LinphonePlayer object
* @param[in] call #LinphoneCall object
* @return A #LinphonePlayer object
*/
LINPHONE_PUBLIC LinphonePlayer * linphone_call_get_player(LinphoneCall *call);
@ -729,7 +729,7 @@ LINPHONE_PUBLIC bool_t linphone_call_media_in_progress(const LinphoneCall *call)
LINPHONE_PUBLIC void linphone_call_ogl_render(const LinphoneCall *call);
/**
* Send a LinphoneInfoMessage through an established call
* Send a #LinphoneInfoMessage through an established call
* @param call the call
* @param info the info message
**/
@ -749,25 +749,25 @@ LINPHONE_PUBLIC LinphoneCallStats *linphone_call_get_video_stats(LinphoneCall *c
LINPHONE_PUBLIC LinphoneCallStats *linphone_call_get_text_stats(LinphoneCall *call);
/**
* Add a listener in order to be notified of LinphoneCall events. Once an event is received, registred LinphoneCallCbs are
* Add a listener in order to be notified of #LinphoneCall events. Once an event is received, registred #LinphoneCallCbs are
* invoked sequencially.
* @param[in] call LinphoneCall object to monitor.
* @param[in] cbs A LinphoneCallCbs object holding the callbacks you need. A reference is taken by the LinphoneCall until you invoke linphone_call_remove_callbacks().
* @param[in] call #LinphoneCall object to monitor.
* @param[in] cbs A #LinphoneCallCbs object holding the callbacks you need. A reference is taken by the #LinphoneCall until you invoke linphone_call_remove_callbacks().
*/
LINPHONE_PUBLIC void linphone_call_add_callbacks(LinphoneCall *call, LinphoneCallCbs *cbs);
/**
* Remove a listener from a LinphoneCall
* @param[in] call LinphoneCall object
* @param[in] cbs LinphoneCallCbs object to remove.
* Remove a listener from a #LinphoneCall
* @param[in] call #LinphoneCall object
* @param[in] cbs #LinphoneCallCbs object to remove.
*/
LINPHONE_PUBLIC void linphone_call_remove_callbacks(LinphoneCall *call, LinphoneCallCbs *cbs);
/**
* Gets the current LinphoneCallCbs.
* This is meant only to be called from a callback to be able to get the user_data associated with the LinphoneCallCbs that is calling the callback.
* @param[in] call LinphoneCall object
* @return The LinphoneCallCbs that has called the last callback
* This is meant only to be called from a callback to be able to get the user_data associated with the #LinphoneCallCbs that is calling the callback.
* @param[in] call #LinphoneCall object
* @return The #LinphoneCallCbs that has called the last callback
*/
LINPHONE_PUBLIC LinphoneCallCbs *linphone_call_get_current_callbacks(const LinphoneCall *call);
@ -777,16 +777,16 @@ LINPHONE_PUBLIC LinphoneCallCbs *linphone_call_get_current_callbacks(const Linph
* linphone_call_accept_with_params().
* However, in some cases it might be desirable from a software design standpoint to modify local parameters outside of the application layer, typically
* in the purpose of implementing a custom logic including special headers in INVITE or 200Ok requests, driven by a call_state_changed listener method.
* This function accepts to assign a new LinphoneCallParams only in LinphoneCallOutgoingInit and LinphoneCallIncomingReceived states.
* @param call the LinphoneCall object
* This function accepts to assign a new #LinphoneCallParams only in #LinphoneCallOutgoingInit and #LinphoneCallIncomingReceived states.
* @param call the #LinphoneCall object
**/
LINPHONE_PUBLIC void linphone_call_set_params(LinphoneCall *call, const LinphoneCallParams *params);
/**
* Returns local parameters associated with the call.
* This is typically the parameters passed at call initiation to linphone_core_invite_address_with_params() or linphone_call_accept_with_params(), or some default
* parameters if no LinphoneCallParams was explicitely passed during call initiation.
* @param call the LinphoneCall object
* parameters if no #LinphoneCallParams was explicitely passed during call initiation.
* @param call the #LinphoneCall object
* @return the call's local parameters.
**/
LINPHONE_PUBLIC const LinphoneCallParams * linphone_call_get_params(LinphoneCall *call);

26
include/linphone/api/c-callbacks.h
View file

@ -37,14 +37,14 @@
/**
* Callback for being notified of received DTMFs.
* @param call LinphoneCall object that received the dtmf
* @param call #LinphoneCall object that received the dtmf
* @param dtmf The ascii code of the dtmf
*/
typedef void (*LinphoneCallCbsDtmfReceivedCb)(LinphoneCall *call, int dtmf);
/**
* Call encryption changed callback.
* @param call LinphoneCall object whose encryption is changed.
* @param call #LinphoneCall object whose encryption is changed.
* @param on Whether encryption is activated.
* @param authentication_token An authentication_token, currently set for ZRTP kind of encryption only.
*/
@ -52,14 +52,14 @@ typedef void (*LinphoneCallCbsEncryptionChangedCb)(LinphoneCall *call, bool_t on
/**
* Callback for receiving info messages.
* @param call LinphoneCall whose info message belongs to.
* @param msg LinphoneInfoMessage object.
* @param call #LinphoneCall whose info message belongs to.
* @param msg #LinphoneInfoMessage object.
*/
typedef void (*LinphoneCallCbsInfoMessageReceivedCb)(LinphoneCall *call, const LinphoneInfoMessage *msg);
/**
* Call state notification callback.
* @param call LinphoneCall whose state is changed.
* @param call #LinphoneCall whose state is changed.
* @param cstate The new state of the call
* @param message An informational message about the state.
*/
@ -67,21 +67,21 @@ typedef void (*LinphoneCallCbsStateChangedCb)(LinphoneCall *call, LinphoneCallSt
/**
* Callback for receiving quality statistics for calls.
* @param call LinphoneCall object whose statistics are notified
* @param stats LinphoneCallStats object
* @param call #LinphoneCall object whose statistics are notified
* @param stats #LinphoneCallStats object
*/
typedef void (*LinphoneCallCbsStatsUpdatedCb)(LinphoneCall *call, const LinphoneCallStats *stats);
/**
* Callback for notifying progresses of transfers.
* @param call LinphoneCall that was transfered
* @param call #LinphoneCall that was transfered
* @param cstate The state of the call to transfer target at the far end.
*/
typedef void (*LinphoneCallCbsTransferStateChangedCb)(LinphoneCall *call, LinphoneCallState cstate);
/**
* Callback for notifying the processing SIP ACK messages.
* @param call LinphoneCall for which an ACK is being received or sent
* @param call #LinphoneCall for which an ACK is being received or sent
* @param ack the ACK message
* @param is_received if TRUE this ACK is an incoming one, otherwise it is an ACK about to be sent.
*/
@ -100,9 +100,9 @@ typedef void (*LinphoneCallCbsAckProcessingCb)(LinphoneCall *call, LinphoneHeade
/**
* Call back used to notify message delivery status
* @param msg #LinphoneChatMessage object
* @param status LinphoneChatMessageState
* @param status #LinphoneChatMessageState
* @param ud application user data
* @deprecated Use LinphoneChatMessageCbsMsgStateChangedCb instead.
* @deprecated Use #LinphoneChatMessageCbsMsgStateChangedCb instead.
* @donotwrap
*/
typedef void (*LinphoneChatMessageStateChangedCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
@ -110,7 +110,7 @@ typedef void (*LinphoneChatMessageStateChangedCb)(LinphoneChatMessage* msg,Linph
/**
* Call back used to notify message delivery status
* @param msg #LinphoneChatMessage object
* @param status LinphoneChatMessageState
* @param status #LinphoneChatMessageState
*/
typedef void (*LinphoneChatMessageCbsMsgStateChangedCb)(LinphoneChatMessage* msg, LinphoneChatMessageState state);
@ -128,7 +128,7 @@ typedef void (*LinphoneChatMessageCbsFileTransferRecvCb)(LinphoneChatMessage *me
* @param content #LinphoneContent outgoing content
* @param offset the offset in the file from where to get the data to be sent
* @param size the number of bytes expected by the framework
* @return A LinphoneBuffer object holding the data written by the application. An empty buffer means end of file.
* @return A #LinphoneBuffer object holding the data written by the application. An empty buffer means end of file.
*/
typedef LinphoneBuffer * (*LinphoneChatMessageCbsFileTransferSendCb)(LinphoneChatMessage *message, const LinphoneContent* content, size_t offset, size_t size);

2
include/linphone/api/c-chat-message-cbs.h
View file

@ -65,7 +65,7 @@ LINPHONE_PUBLIC void linphone_chat_message_cbs_set_user_data (LinphoneChatMessag
/**
* Get the message state changed callback.
* @param[in] cbs LinphoneChatMessageCbs object.
* @param[in] cbs #LinphoneChatMessageCbs object.
* @return The current message state changed callback.
*/
LINPHONE_PUBLIC LinphoneChatMessageCbsMsgStateChangedCb linphone_chat_message_cbs_get_msg_state_changed(const LinphoneChatMessageCbs *cbs);

54
include/linphone/api/c-chat-message.h
View file

@ -105,7 +105,7 @@ LINPHONE_PUBLIC const LinphoneAddress* linphone_chat_message_get_to_address(Linp
/**
* Get the content type of a chat message.
* @param[in] message LinphoneChatMessage object
* @param[in] message #LinphoneChatMessage object
* @return The content type of the chat message
*/
LINPHONE_PUBLIC const char * linphone_chat_message_get_content_type(LinphoneChatMessage *msg);
@ -113,7 +113,7 @@ LINPHONE_PUBLIC const char * linphone_chat_message_get_content_type(LinphoneChat
/**
* Set the content type of a chat message.
* This content type must match a content that is text representable, such as text/plain, text/html or image/svg+xml.
* @param[in] message LinphoneChatMessage object
* @param[in] message #LinphoneChatMessage object
* @param[in] content_type The new content type of the chat message
*/
LINPHONE_PUBLIC void linphone_chat_message_set_content_type(LinphoneChatMessage *msg, const char *content_type);
@ -128,7 +128,7 @@ LINPHONE_PUBLIC const char* linphone_chat_message_get_text(LinphoneChatMessage*
/**
* Get the message identifier.
* It is used to identify a message so that it can be notified as delivered and/or displayed.
* @param[in] cm LinphoneChatMessage object
* @param[in] cm #LinphoneChatMessage object
* @return The message identifier.
*/
LINPHONE_PUBLIC const char* linphone_chat_message_get_message_id(const LinphoneChatMessage *msg);
@ -160,7 +160,7 @@ LINPHONE_PUBLIC LinphoneChatRoom* linphone_chat_message_get_chat_room(const Linp
/**
* Get the path to the file to read from or write to during the file transfer.
* @param[in] msg LinphoneChatMessage object
* @param[in] msg #LinphoneChatMessage object
* @return The path to the file to use for the file transfer.
*/
LINPHONE_PUBLIC const char * linphone_chat_message_get_file_transfer_filepath(LinphoneChatMessage *msg);
@ -169,7 +169,7 @@ LINPHONE_PUBLIC const char * linphone_chat_message_get_file_transfer_filepath(Li
/**
* Get if a chat message is to be stored.
* @param[in] message LinphoneChatMessage object
* @param[in] message #LinphoneChatMessage object
* @return Whether or not the message is to be stored
*/
LINPHONE_PUBLIC bool_t linphone_chat_message_get_to_be_stored(const LinphoneChatMessage *message);
@ -177,7 +177,7 @@ LINPHONE_PUBLIC bool_t linphone_chat_message_get_to_be_stored(const LinphoneChat
/**
* Set if a chat message is to be stored.
* This content type must match a content that is text representable, such as text/plain, text/html or image/svg+xml.
* @param[in] message LinphoneChatMessage object
* @param[in] message #LinphoneChatMessage object
* @param[in] to_be_stored Whether or not the chat message is to be stored
*/
LINPHONE_PUBLIC void linphone_chat_message_set_to_be_stored(LinphoneChatMessage *message, bool_t to_be_stored);
@ -208,7 +208,7 @@ LINPHONE_PUBLIC const char* linphone_chat_message_get_external_body_url(const Li
/**
* Linphone message can carry external body as defined by rfc2017
*
* @param message a LinphoneChatMessage
* @param message a #LinphoneChatMessage
* @param url ex: access-type=URL; URL="http://www.foo.com/file"
*/
LINPHONE_PUBLIC void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
@ -217,20 +217,20 @@ LINPHONE_PUBLIC void linphone_chat_message_set_external_body_url(LinphoneChatMes
* Get the file_transfer_information (used by call backs to recover informations during a rcs file transfer)
*
* @param message #LinphoneChatMessage
* @return a pointer to the LinphoneContent structure or NULL if not present.
* @return a pointer to the #LinphoneContent structure or NULL if not present.
*/
LINPHONE_PUBLIC LinphoneContent* linphone_chat_message_get_file_transfer_information(LinphoneChatMessage* message);
/**
* Return whether or not a chat message is a file tranfer.
* @param[in] message LinphoneChatMessage object
* @param[in] message #LinphoneChatMessage object
* @return Whether or not the message is a file tranfer
*/
LINPHONE_PUBLIC bool_t linphone_chat_message_is_file_transfer(LinphoneChatMessage *message);
/**
* Return whether or not a chat message is a text.
* @param[in] message LinphoneChatMessage object
* @param[in] message #LinphoneChatMessage object
* @return Whether or not the message is a text
*/
LINPHONE_PUBLIC bool_t linphone_chat_message_is_text(LinphoneChatMessage *message);
@ -239,7 +239,7 @@ LINPHONE_PUBLIC bool_t linphone_chat_message_is_text(LinphoneChatMessage *messag
* Start the download of the file from remote server
*
* @param message #LinphoneChatMessage
* @param status_cb LinphoneChatMessageStateChangeCb status callback invoked when file is downloaded or could not be downloaded
* @param status_cb #LinphoneChatMessageStateChangeCb status callback invoked when file is downloaded or could not be downloaded
* @param ud user data
* @deprecated Use linphone_chat_message_download_file() instead.
* @donotwrap
@ -247,8 +247,8 @@ LINPHONE_PUBLIC bool_t linphone_chat_message_is_text(LinphoneChatMessage *messag
LINPHONE_PUBLIC LINPHONE_DEPRECATED void linphone_chat_message_start_file_download(LinphoneChatMessage* message, LinphoneChatMessageStateChangedCb status_cb, void* ud);
/**
* Start the download of the file referenced in a LinphoneChatMessage from remote server.
* @param[in] message LinphoneChatMessage object.
* Start the download of the file referenced in a #LinphoneChatMessage from remote server.
* @param[in] message #LinphoneChatMessage object.
*/
LINPHONE_PUBLIC LinphoneStatus linphone_chat_message_download_file(LinphoneChatMessage *message);
@ -260,13 +260,13 @@ LINPHONE_PUBLIC void linphone_chat_message_cancel_file_transfer(LinphoneChatMess
/**
* Send a chat message.
* @param[in] msg LinphoneChatMessage object
* @param[in] msg #LinphoneChatMessage object
*/
LINPHONE_PUBLIC void linphone_chat_message_send (LinphoneChatMessage *msg);
/**
* Resend a chat message if it is in the 'not delivered' state for whatever reason.
* @param[in] msg LinphoneChatMessage object
* @param[in] msg #LinphoneChatMessage object
* @deprecated Use linphone_chat_message_send instead.
* @donotwrap
*/
@ -313,14 +313,14 @@ LINPHONE_PUBLIC LinphoneReason linphone_chat_message_get_reason(LinphoneChatMess
/**
* Get full details about delivery error of a chat message.
* @param msg a LinphoneChatMessage
* @return a LinphoneErrorInfo describing the details.
* @param msg a #LinphoneChatMessage
* @return a #LinphoneErrorInfo describing the details.
**/
LINPHONE_PUBLIC const LinphoneErrorInfo *linphone_chat_message_get_error_info(const LinphoneChatMessage *msg);
/**
* Set the path to the file to read from or write to during the file transfer.
* @param[in] msg LinphoneChatMessage object
* @param[in] msg #LinphoneChatMessage object
* @param[in] filepath The path to the file to use for the file transfer.
*/
LINPHONE_PUBLIC void linphone_chat_message_set_file_transfer_filepath(LinphoneChatMessage *msg, const char *filepath);
@ -328,37 +328,37 @@ LINPHONE_PUBLIC void linphone_chat_message_set_file_transfer_filepath(LinphoneCh
/**
* Fulfill a chat message char by char. Message linked to a Real Time Text Call send char in realtime following RFC 4103/T.140
* To commit a message, use #linphone_chat_room_send_message
* @param[in] msg LinphoneChatMessage
* @param[in] msg #LinphoneChatMessage
* @param[in] character T.140 char
* @returns 0 if succeed.
*/
LINPHONE_PUBLIC LinphoneStatus linphone_chat_message_put_char(LinphoneChatMessage *msg,uint32_t character);
/**
* Get the LinphoneChatMessageCbs object associated with the LinphoneChatMessage.
* @param[in] msg LinphoneChatMessage object
* @return The LinphoneChatMessageCbs object associated with the LinphoneChatMessage.
* Get the #LinphoneChatMessageCbs object associated with the LinphoneChatMessage.
* @param[in] msg #LinphoneChatMessage object
* @return The #LinphoneChatMessageCbs object associated with the LinphoneChatMessage.
*/
LINPHONE_PUBLIC LinphoneChatMessageCbs * linphone_chat_message_get_callbacks(const LinphoneChatMessage *msg);
/**
* Adds a content to the ChatMessage
* @param[in] msg LinphoneChatMessage object
* @param[in] c_content LinphoneContent object
* @param[in] msg #LinphoneChatMessage object
* @param[in] c_content #LinphoneContent object
*/
LINPHONE_PUBLIC void linphone_chat_message_add_text_content(LinphoneChatMessage *msg, const char *c_content);
/**
* Returns true if the chat message has a text content
* @param[in] msg LinphoneChatMessage object
* @param[in] msg #LinphoneChatMessage object
* @return true if it has one, false otherwise
*/
LINPHONE_PUBLIC bool_t linphone_chat_message_has_text_content(const LinphoneChatMessage *msg);
/**
* Gets the text content if available as a string
* @param[in] msg LinphoneChatMessage object
* @return the LinphoneContent buffer if available, null otherwise
* @param[in] msg #LinphoneChatMessage object
* @return the #LinphoneContent buffer if available, null otherwise
*/
LINPHONE_PUBLIC const char* linphone_chat_message_get_text_content(const LinphoneChatMessage *msg);

60
include/linphone/api/c-chat-room-cbs.h
View file

@ -63,210 +63,210 @@ LINPHONE_PUBLIC void linphone_chat_room_cbs_set_user_data (LinphoneChatRoomCbs *
/**
* Get the is-composing received callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current is-composing received callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsIsComposingReceivedCb linphone_chat_room_cbs_get_is_composing_received (const LinphoneChatRoomCbs *cbs);
/**
* Set the is-composing received callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The is-composing received callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_is_composing_received (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsIsComposingReceivedCb cb);
/**
* Get the message received callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current message received callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsMessageReceivedCb linphone_chat_room_cbs_get_message_received (const LinphoneChatRoomCbs *cbs);
/**
* Set the message received callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The message received callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_message_received (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsMessageReceivedCb cb);
/**
* Get the chat message received callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current chat message received callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsChatMessageReceivedCb linphone_chat_room_cbs_get_chat_message_received (const LinphoneChatRoomCbs *cbs);
/**
* Set the chat message received callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The chat message received callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_chat_message_received (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsChatMessageReceivedCb cb);
/**
* Get the chat message sent callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current chat message sent callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsChatMessageSentCb linphone_chat_room_cbs_get_chat_message_sent (const LinphoneChatRoomCbs *cbs);
/**
* Set the chat message sent callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The chat message sent callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_chat_message_sent (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsChatMessageSentCb cb);
/**
* Get the participant added callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current participant added callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsParticipantAddedCb linphone_chat_room_cbs_get_participant_added (const LinphoneChatRoomCbs *cbs);
/**
* Set the participant added callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The participant added callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_participant_added (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsParticipantAddedCb cb);
/**
* Get the participant removed callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current participant removed callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsParticipantRemovedCb linphone_chat_room_cbs_get_participant_removed (const LinphoneChatRoomCbs *cbs);
/**
* Set the participant removed callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The participant removed callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_participant_removed (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsParticipantRemovedCb cb);
/**
* Get the participant admin status changed callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current participant admin status changed callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsParticipantAdminStatusChangedCb linphone_chat_room_cbs_get_participant_admin_status_changed (const LinphoneChatRoomCbs *cbs);
/**
* Set the participant admin status changed callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The participant admin status changed callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_participant_admin_status_changed (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsParticipantAdminStatusChangedCb cb);
/**
* Get the state changed callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current state changed callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsStateChangedCb linphone_chat_room_cbs_get_state_changed (const LinphoneChatRoomCbs *cbs);
/**
* Set the state changed callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The state changed callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_state_changed (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsStateChangedCb cb);
/**
* Get the subject changed callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current subject changed callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsSubjectChangedCb linphone_chat_room_cbs_get_subject_changed (const LinphoneChatRoomCbs *cbs);
/**
* Set the subject changed callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The subject changed callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_subject_changed (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsSubjectChangedCb cb);
/**
* Get the undecryptable message received callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current undecryptable message received callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsUndecryptableMessageReceivedCb linphone_chat_room_cbs_get_undecryptable_message_received (const LinphoneChatRoomCbs *cbs);
/**
* Set the undecryptable message received callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The undecryptable message received callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_undecryptable_message_received (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsUndecryptableMessageReceivedCb cb);
/**
* Get the participant device added callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current participant device added callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsParticipantDeviceAddedCb linphone_chat_room_cbs_get_participant_device_added (const LinphoneChatRoomCbs *cbs);
/**
* Set the participant device added callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The participant device added callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_participant_device_added (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsParticipantDeviceAddedCb cb);
/**
* Get the participant device removed callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @return The current participant device removed callback.
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsParticipantDeviceRemovedCb linphone_chat_room_cbs_get_participant_device_removed (const LinphoneChatRoomCbs *cbs);
/**
* Set the participant device removed callback.
* @param[in] cbs LinphoneChatRoomCbs object.
* @param[in] cbs #LinphoneChatRoomCbs object.
* @param[in] cb The participant device removed callback to be used.
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_participant_device_removed (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsParticipantDeviceRemovedCb cb);
/**
* Get the conference address generation callback.
* @param[in] cbs LinphoneChatRoomCbs object
* @param[in] cbs #LinphoneChatRoomCbs object
* @return The current conference address generation callback
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsConferenceAddressGenerationCb linphone_chat_room_cbs_get_conference_address_generation (const LinphoneChatRoomCbs *cbs);
/**
* Set the conference address generation callback.
* @param[in] cbs LinphoneChatRoomCbs object
* @param[in] cbs #LinphoneChatRoomCbs object
* @param[in] cb The conference address generation callback to be used
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_conference_address_generation (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsConferenceAddressGenerationCb cb);
/**
* Get the participant device getting callback.
* @param[in] cbs LinphoneChatRoomCbs object
* @param[in] cbs #LinphoneChatRoomCbs object
* @return The participant device getting callback
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsParticipantDeviceFetchedCb linphone_chat_room_cbs_get_participant_device_fetched (const LinphoneChatRoomCbs *cbs);
/**
* Set the participant device getting callback.
* @param[in] cbs LinphoneChatRoomCbs object
* @param[in] cbs #LinphoneChatRoomCbs object
* @param[in] cb The participant device getting callback to be used
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_participant_device_fetched (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsParticipantDeviceFetchedCb cb);
/**
* Get the participants capabilities callback.
* @param[in] cbs LinphoneChatRoomCbs object
* @param[in] cbs #LinphoneChatRoomCbs object
* @return The participants capabilities getting callback
*/
LINPHONE_PUBLIC LinphoneChatRoomCbsParticipantsCapabilitiesCheckedCb linphone_chat_room_cbs_get_participants_capabilities_checked (const LinphoneChatRoomCbs *cbs);
/**
* Set the participants capabilities callback.
* @param[in] cbs LinphoneChatRoomCbs object
* @param[in] cbs #LinphoneChatRoomCbs object
* @param[in] cb The participants capabilities callback to be used
*/
LINPHONE_PUBLIC void linphone_chat_room_cbs_set_participants_capabilities_checked (LinphoneChatRoomCbs *cbs, LinphoneChatRoomCbsParticipantsCapabilitiesCheckedCb cb);

72
include/linphone/api/c-chat-room.h
View file

@ -118,11 +118,11 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED void linphone_chat_room_send_message(Linphon
/**
* Send a message to peer member of this chat room.
* @param[in] cr LinphoneChatRoom object
* @param[in] msg LinphoneChatMessage object
* The state of the message sending will be notified via the callbacks defined in the LinphoneChatMessageCbs object that can be obtained
* @param[in] cr #LinphoneChatRoom object
* @param[in] msg #LinphoneChatMessage object
* The state of the message sending will be notified via the callbacks defined in the #LinphoneChatMessageCbs object that can be obtained
* by calling linphone_chat_message_get_callbacks().
* The LinphoneChatMessage reference is transfered to the function and thus doesn't need to be unref'd by the application.
* The #LinphoneChatMessage reference is transfered to the function and thus doesn't need to be unref'd by the application.
* @deprecated Use linphone_chat_message_send() instead.
* @donotwrap
*/
@ -130,8 +130,8 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED void linphone_chat_room_send_chat_message(Li
/**
* Used to receive a chat message when using async mechanism with IM encryption engine
* @param[in] cr LinphoneChatRoom object
* @param[in] msg LinphoneChatMessage object
* @param[in] cr #LinphoneChatRoom object
* @param[in] msg #LinphoneChatMessage object
*/
LINPHONE_PUBLIC void linphone_chat_room_receive_chat_message (LinphoneChatRoom *cr, LinphoneChatMessage *msg);
@ -255,28 +255,28 @@ LINPHONE_PUBLIC bool_t linphone_chat_room_lime_available(LinphoneChatRoom *cr);
/**
* get Curent Call associated to this chatroom if any
* To commit a message, use #linphone_chat_room_send_message
* @param[in] room LinphoneChatRomm
* @returns LinphoneCall or NULL.
* @param[in] room #LinphoneChatRomm
* @returns #LinphoneCall or NULL.
*/
LINPHONE_PUBLIC LinphoneCall *linphone_chat_room_get_call(const LinphoneChatRoom *room);
/**
* Get the LinphoneChatRoomCbs object associated with the LinphoneChatRoom.
* @param[in] cr LinphoneChatRoom object
* @return The LinphoneChatRoomCbs object associated with the LinphoneChatRoom
* Get the #LinphoneChatRoomCbs object associated with the LinphoneChatRoom.
* @param[in] cr #LinphoneChatRoom object
* @return The #LinphoneChatRoomCbs object associated with the #LinphoneChatRoom
*/
LINPHONE_PUBLIC LinphoneChatRoomCbs * linphone_chat_room_get_callbacks (const LinphoneChatRoom *cr);
/**
* Get the state of the chat room.
* @param[in] cr LinphoneChatRoom object
* @param[in] cr #LinphoneChatRoom object
* @return The state of the chat room
*/
LINPHONE_PUBLIC LinphoneChatRoomState linphone_chat_room_get_state (const LinphoneChatRoom *cr);
/**
* Return whether or not the chat room has been left.
* @param[in] cr LinphoneChatRoom object
* @param[in] cr #LinphoneChatRoom object
* @return whether or not the chat room has been left
*/
LINPHONE_PUBLIC bool_t linphone_chat_room_has_been_left (const LinphoneChatRoom *cr);
@ -284,7 +284,7 @@ LINPHONE_PUBLIC bool_t linphone_chat_room_has_been_left (const LinphoneChatRoom
/**
* Add a participant to a chat room. This may fail if this type of chat room does not handle participants.
* Use linphone_chat_room_can_handle_participants() to know if this chat room handles participants.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @param[in] addr The address of the participant to add to the chat room
*/
LINPHONE_PUBLIC void linphone_chat_room_add_participant (LinphoneChatRoom *cr, const LinphoneAddress *addr);
@ -292,21 +292,21 @@ LINPHONE_PUBLIC void linphone_chat_room_add_participant (LinphoneChatRoom *cr, c
/**
* Add several participants to a chat room at once. This may fail if this type of chat room does not handle participants.
* Use linphone_chat_room_can_handle_participants() to know if this chat room handles participants.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @param[in] addresses \bctbx_list{LinphoneAddress}
*/
LINPHONE_PUBLIC void linphone_chat_room_add_participants (LinphoneChatRoom *cr, const bctbx_list_t *addresses);
/**
* Tells whether a chat room is able to handle participants.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @return A boolean value telling whether the chat room can handle participants or not
*/
LINPHONE_PUBLIC bool_t linphone_chat_room_can_handle_participants (const LinphoneChatRoom *cr);
/**
* Find a participant of a chat room from its address.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @param[in] addr The address to search in the list of participants of the chat room
* @return The participant if found, NULL otherwise.
*/
@ -314,14 +314,14 @@ LINPHONE_PUBLIC LinphoneParticipant *linphone_chat_room_find_participant (const
/**
* Get the capabilities of a chat room.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @return The capabilities of the chat room
*/
LINPHONE_PUBLIC LinphoneChatRoomCapabilitiesMask linphone_chat_room_get_capabilities (const LinphoneChatRoom *cr);
/**
* Check if a chat room has given capabilities.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @param[in] mask A Capabilities mask
* @return True if the mask matches, false otherwise
*/
@ -329,62 +329,62 @@ LINPHONE_PUBLIC bool_t linphone_chat_room_has_capability(const LinphoneChatRoom
/**
* Get the conference address of the chat room.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @return The conference address of the chat room or NULL if this type of chat room is not conference based
*/
LINPHONE_PUBLIC const LinphoneAddress *linphone_chat_room_get_conference_address (const LinphoneChatRoom *cr);
/**
* Get the participant representing myself in the chat room.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @return The participant representing myself in the conference.
*/
LINPHONE_PUBLIC LinphoneParticipant *linphone_chat_room_get_me (const LinphoneChatRoom *cr);
/**
* Get the number of participants in the chat room (that is without ourselves).
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @return The number of participants in the chat room
*/
LINPHONE_PUBLIC int linphone_chat_room_get_nb_participants (const LinphoneChatRoom *cr);
/**
* Get the list of participants of a chat room.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @return \bctbx_list{LinphoneParticipant}
*/
LINPHONE_PUBLIC bctbx_list_t * linphone_chat_room_get_participants (const LinphoneChatRoom *cr);
/**
* Get the subject of a chat room.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @return The subject of the chat room
*/
LINPHONE_PUBLIC const char * linphone_chat_room_get_subject (const LinphoneChatRoom *cr);
/**
* Leave a chat room.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
*/
LINPHONE_PUBLIC void linphone_chat_room_leave (LinphoneChatRoom *cr);
/**
* Remove a participant of a chat room.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @param[in] participant The participant to remove from the chat room
*/
LINPHONE_PUBLIC void linphone_chat_room_remove_participant (LinphoneChatRoom *cr, LinphoneParticipant *participant);
/**
* Remove several participants of a chat room at once.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @param[in] participants \bctbx_list{LinphoneParticipant}
*/
LINPHONE_PUBLIC void linphone_chat_room_remove_participants (LinphoneChatRoom *cr, const bctbx_list_t *participants);
/**
* Change the admin status of a participant of a chat room (you need to be an admin yourself to do this).
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @param[in] participant The Participant for which to change the admin status
* @param[in] isAdmin A boolean value telling whether the participant should now be an admin or not
*/
@ -392,30 +392,30 @@ LINPHONE_PUBLIC void linphone_chat_room_set_participant_admin_status (LinphoneCh
/**
* Set the subject of a chat room.
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @param[in] subject The new subject to set for the chat room
*/
LINPHONE_PUBLIC void linphone_chat_room_set_subject (LinphoneChatRoom *cr, const char *subject);
/**
* Gets the list of participants that are currently composing
* @param[in] cr A LinphoneChatRoom object
* @param[in] cr A #LinphoneChatRoom object
* @return \bctbx_list{LinphoneAddress} list of addresses that are in the is_composing state
*/
LINPHONE_PUBLIC const bctbx_list_t * linphone_chat_room_get_composing_addresses(LinphoneChatRoom *cr);
/**
* Set the conference address of a group chat room. This function needs to be called from the
* LinphoneChatRoomCbsConferenceAddressGenerationCb callback and only there.
* @param[in] cr A LinphoneChatRoom object
* #LinphoneChatRoomCbsConferenceAddressGenerationCb callback and only there.
* @param[in] cr A #LinphoneChatRoom object
* @param[in] confAddr The conference address to be used by the group chat room
*/
LINPHONE_PUBLIC void linphone_chat_room_set_conference_address (LinphoneChatRoom *cr, const LinphoneAddress *confAddr);
/**
* Set the participant device. This function needs to be called from the
* LinphoneChatRoomCbsParticipantDeviceFetchedCb callback and only there.
* @param[in] cr A LinphoneChatRoom object
* #LinphoneChatRoomCbsParticipantDeviceFetchedCb callback and only there.
* @param[in] cr A #LinphoneChatRoom object
* @param[in] partAddr The participant address
* @param[in] partDevices \bctbx_list{LinphoneAddress} list of the participant devices to be used by the group chat room
*/
@ -423,8 +423,8 @@ LINPHONE_PUBLIC void linphone_chat_room_set_participant_devices (LinphoneChatRoo
/**
* Set the participant device. This function needs to be called from the
* LinphoneChatRoomCbsParticipantsCapabilitiesCheckedCb callback and only there.
* @param[in] cr A LinphoneChatRoom object
* #LinphoneChatRoomCbsParticipantsCapabilitiesCheckedCb callback and only there.
* @param[in] cr A #LinphoneChatRoom object
* @param[in] deviceAddr The device address
* @param[in] participantsCompatible \bctbx_list{LinphoneAddress}
*/

12
include/linphone/api/c-participant.h
View file

@ -34,39 +34,39 @@
*/
/**
* Increment reference count of LinphoneParticipant object.
* Increment reference count of #LinphoneParticipant object.
**/
LINPHONE_PUBLIC LinphoneParticipant *linphone_participant_ref (LinphoneParticipant *participant);
/**
* Decrement reference count of LinphoneParticipant object.
* Decrement reference count of #LinphoneParticipant object.
**/
LINPHONE_PUBLIC void linphone_participant_unref (LinphoneParticipant *participant);
/**
* Retrieve the user pointer associated with the conference participant.
* @param[in] participant A LinphoneParticipant object
* @param[in] participant A #LinphoneParticipant object
* @return The user pointer associated with the participant.
**/
LINPHONE_PUBLIC void * linphone_participant_get_user_data(const LinphoneParticipant *participant);
/**
* Assign a user pointer to the conference participant.
* @param[in] participant A LinphoneParticipant object
* @param[in] participant A #LinphoneParticipant object
* @param[in] ud The user pointer to associate with the participant
**/
LINPHONE_PUBLIC void linphone_participant_set_user_data(LinphoneParticipant *participant, void *ud);
/**
* Get the address of a conference participant.
* @param[in] participant A LinphoneParticipant object
* @param[in] participant A #LinphoneParticipant object
* @return The address of the participant
*/
LINPHONE_PUBLIC const LinphoneAddress * linphone_participant_get_address (const LinphoneParticipant *participant);
/**
* Tells whether a conference participant is an administrator of the conference.
* @param[in] participant A LinphoneParticipant object
* @param[in] participant A #LinphoneParticipant object
* @return A boolean value telling whether the participant is an administrator
*/
LINPHONE_PUBLIC bool_t linphone_participant_is_admin (const LinphoneParticipant *participant);

30
include/linphone/api/c-types.h
View file

@ -61,11 +61,11 @@
/**
* Object that represents a SIP address.
*
* The LinphoneAddress is an opaque object to represents SIP addresses, ie
* The #LinphoneAddress is an opaque object to represents SIP addresses, ie
* the content of SIP's 'from' and 'to' headers.
* A SIP address is made of display name, username, domain name, port, and various
* uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
* The LinphoneAddress has methods to extract and manipulate all parts of the address.
* The #LinphoneAddress has methods to extract and manipulate all parts of the address.
* When some part of the address (for example the username) is empty, the accessor methods
* return NULL.
* @ingroup linphone_address
@ -77,7 +77,7 @@ typedef struct _LinphoneAddress LinphoneAddress;
// -----------------------------------------------------------------------------
/**
* The LinphoneCall object represents a call issued or received by the LinphoneCore
* The #LinphoneCall object represents a call issued or received by the #LinphoneCore
* @ingroup call_control
**/
typedef struct _LinphoneCall LinphoneCall;
@ -86,11 +86,11 @@ typedef struct _LinphoneCall LinphoneCall;
typedef void (*LinphoneCallCbFunc) (LinphoneCall *call, void *ud);
/**
* That class holds all the callbacks which are called by LinphoneCall objects.
* That class holds all the callbacks which are called by #LinphoneCall objects.
*
* Use linphone_factory_create_call_cbs() to create an instance. Then, call the
* callback setters on the events you need to monitor and pass the object to
* a LinphoneCall instance through linphone_call_add_callbacks().
* a #LinphoneCall instance through linphone_call_add_callbacks().
* @ingroup call_control
*/
typedef struct _LinphoneCallCbs LinphoneCallCbs;
@ -106,7 +106,7 @@ typedef struct _LinphoneCallCbs LinphoneCallCbs;
typedef struct _LinphoneChatMessage LinphoneChatMessage;
/**
* An object to handle the callbacks for the handling a LinphoneChatMessage objects.
* An object to handle the callbacks for the handling a #LinphoneChatMessage objects.
* @ingroup chatroom
*/
typedef struct _LinphoneChatMessageCbs LinphoneChatMessageCbs;
@ -119,13 +119,13 @@ typedef struct _LinphoneChatMessageCbs LinphoneChatMessageCbs;
typedef struct _LinphoneChatRoom LinphoneChatRoom;
/**
* A mask of LinphoneChatRoomCapabilities
* A mask of #LinphoneChatRoomCapabilities
* @ingroup chatroom
*/
typedef int LinphoneChatRoomCapabilitiesMask;
/**
* An object to handle the callbacks for the handling a LinphoneChatRoom objects.
* An object to handle the callbacks for the handling a #LinphoneChatRoom objects.
* @ingroup chatroom
*/
typedef struct _LinphoneChatRoomCbs LinphoneChatRoomCbs;
@ -151,7 +151,7 @@ typedef struct _LinphoneEventLog LinphoneEventLog;
typedef struct _LinphoneDialPlan LinphoneDialPlan;
/**
* The LinphoneParticipant object represents a participant of a conference.
* The #LinphoneParticipant object represents a participant of a conference.
* @ingroup misc
**/
typedef struct _LinphoneParticipant LinphoneParticipant;
@ -165,7 +165,7 @@ typedef struct _LinphoneParticipant LinphoneParticipant;
// -----------------------------------------------------------------------------
/**
* LinphoneCallState enum represents the different state a call can reach into.
* #LinphoneCallState enum represents the different state a call can reach into.
* The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
* @ingroup call_control
**/
@ -176,25 +176,25 @@ L_DECLARE_C_ENUM(CallState, L_ENUM_VALUES_CALL_SESSION_STATE);
// -----------------------------------------------------------------------------
/**
* LinphoneChatMessageDirection is used to indicate if a message is outgoing or incoming.
* #LinphoneChatMessageDirection is used to indicate if a message is outgoing or incoming.
* @ingroup chatroom
*/
L_DECLARE_C_ENUM(ChatMessageDirection, L_ENUM_VALUES_CHAT_MESSAGE_DIRECTION);
/**
* LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
* #LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
* @ingroup chatroom
*/
L_DECLARE_C_ENUM(ChatMessageState, L_ENUM_VALUES_CHAT_MESSAGE_STATE);
/**
* LinphoneChatRoomCapabilities is used to indicated the capabilities of a chat room.
* #LinphoneChatRoomCapabilities is used to indicated the capabilities of a chat room.
* @ingroup chatroom
*/
L_DECLARE_C_ENUM_FIXED_VALUES(ChatRoomCapabilities, L_ENUM_VALUES_CHAT_ROOM_CAPABILITIES);
/**
* LinphoneChatRoomState is used to indicate the current state of a chat room.
* #LinphoneChatRoomState is used to indicate the current state of a chat room.
* @ingroup chatroom
*/
L_DECLARE_C_ENUM(ChatRoomState, L_ENUM_VALUES_CHAT_ROOM_STATE);
@ -204,7 +204,7 @@ L_DECLARE_C_ENUM(ChatRoomState, L_ENUM_VALUES_CHAT_ROOM_STATE);
// -----------------------------------------------------------------------------
/**
* LinphoneEventLogType is used to indicate the type of an event. Useful for cast.
* #LinphoneEventLogType is used to indicate the type of an event. Useful for cast.
* @ingroup events
*/
L_DECLARE_C_ENUM(EventLogType, L_ENUM_VALUES_EVENT_LOG_TYPE);

4
include/linphone/auth_info.h
View file

@ -29,7 +29,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/**
* Safely cast a belle_sip_object_t into LinphoneAuthInfo
* Safely cast a belle_sip_object_t into #LinphoneAuthInfo
*/
#define LINPHONE_AUTH_INFO(obj) BELLE_SIP_CAST(obj, LinphoneAuthInfo)
@ -48,7 +48,7 @@ extern "C" {
* @param ha1 The ha1-encrypted password if password is not given in clear text.
* @param realm The authentication domain (which can be larger than the sip domain. Unfortunately many SIP servers don't use this parameter.
* @param domain The SIP domain for which this authentication information is valid, if it has to be restricted for a single SIP domain.
* @return A #LinphoneAuthInfo object. linphone_auth_info_destroy() must be used to destroy it when no longer needed. The LinphoneCore makes a copy of LinphoneAuthInfo
* @return A #LinphoneAuthInfo object. linphone_auth_info_destroy() must be used to destroy it when no longer needed. The #LinphoneCore makes a copy of #LinphoneAuthInfo
* passed through linphone_core_add_auth_info().
**/
LINPHONE_PUBLIC LinphoneAuthInfo *linphone_auth_info_new(

40
include/linphone/buffer.h
View file

@ -35,63 +35,63 @@ extern "C" {
*/
/**
* Create a new empty LinphoneBuffer object.
* @return A new LinphoneBuffer object.
* Create a new empty #LinphoneBuffer object.
* @return A new #LinphoneBuffer object.
*/
LINPHONE_PUBLIC LinphoneBuffer * linphone_buffer_new(void);
/**
* Create a new LinphoneBuffer object from existing data.
* Create a new #LinphoneBuffer object from existing data.
* @param[in] data The initial data to store in the LinphoneBuffer.
* @param[in] size The size of the initial data to stroe in the LinphoneBuffer.
* @return A new LinphoneBuffer object.
* @return A new #LinphoneBuffer object.
*/
LINPHONE_PUBLIC LinphoneBuffer * linphone_buffer_new_from_data(const uint8_t *data, size_t size);
/**
* Create a new LinphoneBuffer object from a string.
* Create a new #LinphoneBuffer object from a string.
* @param[in] data The initial string content of the LinphoneBuffer.
* @return A new LinphoneBuffer object.
* @return A new #LinphoneBuffer object.
*/
LINPHONE_PUBLIC LinphoneBuffer * linphone_buffer_new_from_string(const char *data);
/**
* Acquire a reference to the buffer.
* @param[in] buffer LinphoneBuffer object.
* @return The same LinphoneBuffer object.
* @param[in] buffer #LinphoneBuffer object.
* @return The same #LinphoneBuffer object.
**/
LINPHONE_PUBLIC LinphoneBuffer * linphone_buffer_ref(LinphoneBuffer *buffer);
/**
* Release reference to the buffer.
* @param[in] buffer LinphoneBuffer object.
* @param[in] buffer #LinphoneBuffer object.
**/
LINPHONE_PUBLIC void linphone_buffer_unref(LinphoneBuffer *buffer);
/**
* Retrieve the user pointer associated with the buffer.
* @param[in] buffer LinphoneBuffer object.
* @param[in] buffer #LinphoneBuffer object.
* @return The user pointer associated with the buffer.
**/
LINPHONE_PUBLIC void *linphone_buffer_get_user_data(const LinphoneBuffer *buffer);
/**
* Assign a user pointer to the buffer.
* @param[in] buffer LinphoneBuffer object.
* @param[in] buffer #LinphoneBuffer object.
* @param[in] ud The user pointer to associate with the buffer.
**/
LINPHONE_PUBLIC void linphone_buffer_set_user_data(LinphoneBuffer *buffer, void *ud);
/**
* Get the content of the data buffer.
* @param[in] buffer LinphoneBuffer object.
* @param[in] buffer #LinphoneBuffer object.
* @return The content of the data buffer.
*/
LINPHONE_PUBLIC const uint8_t * linphone_buffer_get_content(const LinphoneBuffer *buffer);
/**
* Set the content of the data buffer.
* @param[in] buffer LinphoneBuffer object.
* @param[in] buffer #LinphoneBuffer object.
* @param[in] content The content of the data buffer.
* @param[in] size The size of the content of the data buffer.
*/
@ -99,36 +99,36 @@ LINPHONE_PUBLIC void linphone_buffer_set_content(LinphoneBuffer *buffer, const u
/**
* Get the string content of the data buffer.
* @param[in] buffer LinphoneBuffer object
* @param[in] buffer #LinphoneBuffer object
* @return The string content of the data buffer.
*/
LINPHONE_PUBLIC const char * linphone_buffer_get_string_content(const LinphoneBuffer *buffer);
/**
* Set the string content of the data buffer.
* @param[in] buffer LinphoneBuffer object.
* @param[in] buffer #LinphoneBuffer object.
* @param[in] content The string content of the data buffer.
*/
LINPHONE_PUBLIC void linphone_buffer_set_string_content(LinphoneBuffer *buffer, const char *content);
/**
* Get the size of the content of the data buffer.
* @param[in] buffer LinphoneBuffer object.
* @param[in] buffer #LinphoneBuffer object.
* @return The size of the content of the data buffer.
*/
LINPHONE_PUBLIC size_t linphone_buffer_get_size(const LinphoneBuffer *buffer);
/**
* Set the size of the content of the data buffer.
* @param[in] buffer LinphoneBuffer object
* @param[in] buffer #LinphoneBuffer object
* @param[in] size The size of the content of the data buffer.
*/
LINPHONE_PUBLIC void linphone_buffer_set_size(LinphoneBuffer *buffer, size_t size);
/**
* Tell whether the LinphoneBuffer is empty.
* @param[in] buffer LinphoneBuffer object
* @return A boolean value telling whether the LinphoneBuffer is empty or not.
* Tell whether the #LinphoneBuffer is empty.
* @param[in] buffer #LinphoneBuffer object
* @return A boolean value telling whether the #LinphoneBuffer is empty or not.
*/
LINPHONE_PUBLIC bool_t linphone_buffer_is_empty(const LinphoneBuffer *buffer);

42
include/linphone/call_log.h
View file

@ -38,35 +38,35 @@ extern "C" {
/**
* Get the call ID used by the call.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The call ID used by the call as a string.
**/
LINPHONE_PUBLIC const char * linphone_call_log_get_call_id(const LinphoneCallLog *cl);
/**
* Get the direction of the call.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The direction of the call.
**/
LINPHONE_PUBLIC LinphoneCallDir linphone_call_log_get_dir(const LinphoneCallLog *cl);
/**
* Get the duration of the call since connected.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The duration of the call in seconds.
**/
LINPHONE_PUBLIC int linphone_call_log_get_duration(const LinphoneCallLog *cl);
/**
* Get the origin address (ie from) of the call.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The origin address (ie from) of the call.
**/
LINPHONE_PUBLIC const LinphoneAddress * linphone_call_log_get_from_address(const LinphoneCallLog *cl);
/**
* Get the RTP statistics computed locally regarding the call.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The RTP statistics that have been computed locally for the call.
* @donotwrap
**/
@ -74,7 +74,7 @@ LINPHONE_PUBLIC const rtp_stats_t * linphone_call_log_get_local_stats(const Linp
/**
* Get the overall quality indication of the call.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The overall quality indication of the call.
**/
LINPHONE_PUBLIC float linphone_call_log_get_quality(const LinphoneCallLog *cl);
@ -85,14 +85,14 @@ LINPHONE_PUBLIC float linphone_call_log_get_quality(const LinphoneCallLog *cl);
* The reference key can be for example an id to an external database.
* It is stored in the config file, thus can survive to process exits/restarts.
*
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The reference key string that has been associated to the call log, or NULL if none has been associated.
**/
LINPHONE_PUBLIC const char * linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
/**
* Get the remote address (that is from or to depending on call direction).
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The remote address of the call.
**/
LINPHONE_PUBLIC LinphoneAddress * linphone_call_log_get_remote_address(const LinphoneCallLog *cl);
@ -100,7 +100,7 @@ LINPHONE_PUBLIC LinphoneAddress * linphone_call_log_get_remote_address(const Lin
/**
* Get the RTP statistics computed by the remote end and sent back via RTCP.
* @note Not implemented yet.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The RTP statistics that have been computed by the remote end for the call.
* @donotwrap
**/
@ -108,21 +108,21 @@ LINPHONE_PUBLIC const rtp_stats_t * linphone_call_log_get_remote_stats(const Lin
/**
* Get the start date of the call.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The date of the beginning of the call.
**/
LINPHONE_PUBLIC time_t linphone_call_log_get_start_date(const LinphoneCallLog *cl);
/**
* Get the status of the call.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The status of the call.
**/
LINPHONE_PUBLIC LinphoneCallStatus linphone_call_log_get_status(const LinphoneCallLog *cl);
/**
* Get the destination address (ie to) of the call.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The destination address (ie to) of the call.
**/
LINPHONE_PUBLIC const LinphoneAddress * linphone_call_log_get_to_address(const LinphoneCallLog *cl);
@ -133,14 +133,14 @@ LINPHONE_PUBLIC const LinphoneAddress * linphone_call_log_get_to_address(const L
* The reference key can be for example an id to an external database.
* It is stored in the config file, thus can survive to process exits/restarts.
*
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @param[in] refkey The reference key string to associate to the call log.
**/
LINPHONE_PUBLIC void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
/**
* Tell whether video was enabled at the end of the call or not.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return A boolean value telling whether video was enabled at the end of the call.
**/
LINPHONE_PUBLIC bool_t linphone_call_log_video_enabled(const LinphoneCallLog *cl);
@ -148,7 +148,7 @@ LINPHONE_PUBLIC bool_t linphone_call_log_video_enabled(const LinphoneCallLog *cl
/**
* Get a human readable string describing the call.
* @note: the returned string must be freed by the application (use ms_free()).
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return A human readable string describing the call.
**/
LINPHONE_PUBLIC char * linphone_call_log_to_str(const LinphoneCallLog *cl);
@ -174,28 +174,28 @@ LINPHONE_PUBLIC const LinphoneErrorInfo *linphone_call_log_get_error_info(const
/**
* Get the user data associated with the call log.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The user data associated with the call log.
**/
LINPHONE_PUBLIC void *linphone_call_log_get_user_data(const LinphoneCallLog *cl);
/**
* Assign a user data to the call log.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @param[in] ud The user data to associate with the call log.
**/
LINPHONE_PUBLIC void linphone_call_log_set_user_data(LinphoneCallLog *cl, void *ud);
/**
* Acquire a reference to the call log.
* @param[in] cl LinphoneCallLog object
* @return The same LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
* @return The same #LinphoneCallLog object
**/
LINPHONE_PUBLIC LinphoneCallLog * linphone_call_log_ref(LinphoneCallLog *cl);
/**
* Release a reference to the call log.
* @param[in] cl LinphoneCallLog object
* @param[in] cl #LinphoneCallLog object
**/
LINPHONE_PUBLIC void linphone_call_log_unref(LinphoneCallLog *cl);
@ -218,7 +218,7 @@ LINPHONE_PUBLIC void linphone_call_log_unref(LinphoneCallLog *cl);
/**
* Destroy a LinphoneCallLog.
* @param cl LinphoneCallLog object
* @param cl #LinphoneCallLog object
* @deprecated Use linphone_call_log_unref() instead.
* @donotwrap
*/

76
include/linphone/call_params.h
View file

@ -48,22 +48,22 @@ extern "C" {
LINPHONE_PUBLIC void linphone_call_params_add_custom_header(LinphoneCallParams *cp, const char *header_name, const char *header_value);
/**
* Copy an existing LinphoneCallParams object to a new LinphoneCallParams object.
* @param[in] cp The LinphoneCallParams object to copy.
* @return A copy of the LinphoneCallParams object.
* Copy an existing #LinphoneCallParams object to a new #LinphoneCallParams object.
* @param[in] cp The #LinphoneCallParams object to copy.
* @return A copy of the #LinphoneCallParams object.
**/
LINPHONE_PUBLIC LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
/**
* Indicate whether sending of early media was enabled.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return A boolean value telling whether sending of early media was enabled.
**/
LINPHONE_PUBLIC bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
/**
* Enable sending of real early media (during outgoing calls).
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] enabled A boolean value telling whether to enable early media sending or not.
**/
LINPHONE_PUBLIC void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
@ -73,21 +73,21 @@ LINPHONE_PUBLIC void linphone_call_params_enable_early_media_sending(LinphoneCal
* Configuring a call to low bandwidth mode will result in the core to activate several settings for the call in order to ensure that bitrate usage
* is lowered to the minimum possible. Typically, ptime (packetization time) will be increased, audio codec's output bitrate will be targetted to 20kbit/s provided
* that it is achievable by the codec selected after SDP handshake. Video is automatically disabled.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] enabled A boolean value telling whether to activate the low bandwidth mode or not.
**/
LINPHONE_PUBLIC void linphone_call_params_enable_low_bandwidth(LinphoneCallParams *cp, bool_t enabled);
/**
* Enable audio stream.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] enabled A boolean value telling whether to enable audio or not.
**/
LINPHONE_PUBLIC void linphone_call_params_enable_audio(LinphoneCallParams *cp, bool_t enabled);
/**
* Enable video stream.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] enabled A boolean value telling whether to enable video or not.
**/
LINPHONE_PUBLIC void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
@ -106,36 +106,36 @@ LINPHONE_PUBLIC const char *linphone_call_params_get_custom_header(const Linphon
* that function does not return TRUE even if the conference is running.<br/>
* If you want to test whether the conference is running, you should test
* whether linphone_core_get_conference() return a non-null pointer.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return A boolean value telling whether the call is part of the locally managed conference.
**/
LINPHONE_PUBLIC bool_t linphone_call_params_get_local_conference_mode(const LinphoneCallParams *cp);
/**
* Get the kind of media encryption selected for the call.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return The kind of media encryption selected for the call.
**/
LINPHONE_PUBLIC LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
/**
* Get requested level of privacy for the call.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return The privacy mode used for the call.
**/
LINPHONE_PUBLIC LinphonePrivacyMask linphone_call_params_get_privacy(const LinphoneCallParams *cp);
/**
* Get the framerate of the video that is received.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return The actual received framerate in frames per seconds, 0 if not available.
*/
LINPHONE_PUBLIC float linphone_call_params_get_received_framerate(const LinphoneCallParams *cp);
/**
* Get the definition of the received video.
* @param[in] cp LinphoneCallParams object
* @return The received LinphoneVideoDefinition
* @param[in] cp #LinphoneCallParams object
* @return The received #LinphoneVideoDefinition
*/
LINPHONE_PUBLIC const LinphoneVideoDefinition * linphone_call_params_get_received_video_definition(const LinphoneCallParams *cp);
@ -150,7 +150,7 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED MSVideoSize linphone_call_params_get_receive
/**
* Get the path for the audio recording of the call.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return The path to the audio recording of the call.
**/
LINPHONE_PUBLIC const char *linphone_call_params_get_record_file(const LinphoneCallParams *cp);
@ -164,15 +164,15 @@ LINPHONE_PUBLIC const char * linphone_call_params_get_rtp_profile(const Linphone
/**
* Get the framerate of the video that is sent.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return The actual sent framerate in frames per seconds, 0 if not available.
*/
LINPHONE_PUBLIC float linphone_call_params_get_sent_framerate(const LinphoneCallParams *cp);
/**
* Get the definition of the sent video.
* @param[in] cp LinphoneCallParams object
* @return The sent LinphoneVideoDefinition
* @param[in] cp #LinphoneCallParams object
* @return The sent #LinphoneVideoDefinition
*/
LINPHONE_PUBLIC const LinphoneVideoDefinition * linphone_call_params_get_sent_video_definition(const LinphoneCallParams *cp);
@ -188,7 +188,7 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED MSVideoSize linphone_call_params_get_sent_vi
/**
* Get the session name of the media session (ie in SDP).
* Subject from the SIP message can be retrieved using linphone_call_params_get_custom_header() and is different.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return The session name of the media session.
**/
LINPHONE_PUBLIC const char *linphone_call_params_get_session_name(const LinphoneCallParams *cp);
@ -250,7 +250,7 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED const OrtpPayloadType *linphone_call_params_
* An application that would have reliable way to know network capacity may not use activate_edge_workarounds=1 but instead manually configure
* low bandwidth mode with linphone_call_params_enable_low_bandwidth().
* When enabled, this param may transform a call request with video in audio only mode.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return A boolean value telling whether the low bandwidth mode has been configured/detected.
*/
LINPHONE_PUBLIC bool_t linphone_call_params_low_bandwidth_enabled(const LinphoneCallParams *cp);
@ -258,14 +258,14 @@ LINPHONE_PUBLIC bool_t linphone_call_params_low_bandwidth_enabled(const Linphone
/**
* Refine bandwidth settings for this call by setting a bandwidth limit for audio streams.
* As a consequence, codecs whose bitrates are not compatible with this limit won't be used.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] bw The audio bandwidth limit to set in kbit/s.
**/
LINPHONE_PUBLIC void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
/**
* Set requested media encryption for a call.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] enc The media encryption to use for the call.
**/
LINPHONE_PUBLIC void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption enc);
@ -273,7 +273,7 @@ LINPHONE_PUBLIC void linphone_call_params_set_media_encryption(LinphoneCallParam
/**
* Set requested level of privacy for the call.
* \xmlonly <language-tags>javascript</language-tags> \endxmlonly
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] privacy The privacy mode to used for the call.
**/
LINPHONE_PUBLIC void linphone_call_params_set_privacy(LinphoneCallParams *cp, LinphonePrivacyMask privacy);
@ -283,7 +283,7 @@ LINPHONE_PUBLIC void linphone_call_params_set_privacy(LinphoneCallParams *cp, Li
* This function must be used before the call parameters are assigned to the call.
* The call recording can be started and paused after the call is established with
* linphone_call_start_recording() and linphone_call_pause_recording().
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] path A string containing the path and filename of the file where audio/video streams are to be written.
* The filename must have either .mkv or .wav extention. The video stream will be written only if a MKV file is given.
**/
@ -292,49 +292,49 @@ LINPHONE_PUBLIC void linphone_call_params_set_record_file(LinphoneCallParams *cp
/**
* Set the session name of the media session (ie in SDP).
* Subject from the SIP message (which is different) can be set using linphone_call_params_set_custom_header().
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] name The session name to be used.
**/
LINPHONE_PUBLIC void linphone_call_params_set_session_name(LinphoneCallParams *cp, const char *name);
/**
* Tell whether audio is enabled or not.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return A boolean value telling whether audio is enabled or not.
**/
LINPHONE_PUBLIC bool_t linphone_call_params_audio_enabled(const LinphoneCallParams *cp);
/**
* Tell whether video is enabled or not.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return A boolean value telling whether video is enabled or not.
**/
LINPHONE_PUBLIC bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
/**
* Get the audio stream direction.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return The audio stream direction associated with the call params.
**/
LINPHONE_PUBLIC LinphoneMediaDirection linphone_call_params_get_audio_direction(const LinphoneCallParams *cp);
/**
* Get the video stream direction.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return The video stream direction associated with the call params.
**/
LINPHONE_PUBLIC LinphoneMediaDirection linphone_call_params_get_video_direction(const LinphoneCallParams *cp);
/**
* Set the audio stream direction.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] dir The audio stream direction associated with this call params.
**/
LINPHONE_PUBLIC void linphone_call_params_set_audio_direction(LinphoneCallParams *cp, LinphoneMediaDirection dir);
/**
* Set the video stream direction.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] dir The video stream direction associated with this call params.
**/
LINPHONE_PUBLIC void linphone_call_params_set_video_direction(LinphoneCallParams *cp, LinphoneMediaDirection dir);
@ -356,28 +356,28 @@ void linphone_call_params_set_avpf_rr_interval(LinphoneCallParams *params, uint1
/**
* Get the user data associated with the call params.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return The user data associated with the call params.
**/
LINPHONE_PUBLIC void *linphone_call_params_get_user_data(const LinphoneCallParams *cp);
/**
* Assign a user data to the call params.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @param[in] ud The user data to associate with the call params.
**/
LINPHONE_PUBLIC void linphone_call_params_set_user_data(LinphoneCallParams *cp, void *ud);
/**
* Acquire a reference to the call params.
* @param[in] cp LinphoneCallParams object
* @return The same LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
* @return The same #LinphoneCallParams object
**/
LINPHONE_PUBLIC LinphoneCallParams * linphone_call_params_ref(LinphoneCallParams *cp);
/**
* Release a reference to the call params.
* @param[in] cp LinphoneCallParams object
* @param[in] cp #LinphoneCallParams object
**/
LINPHONE_PUBLIC void linphone_call_params_unref(LinphoneCallParams *cp);
@ -497,8 +497,8 @@ LINPHONE_PUBLIC void linphone_call_params_clear_custom_sdp_media_attributes(Linp
#define linphone_call_params_local_conference_mode linphone_call_params_get_local_conference_mode
/**
* Destroy a LinphoneCallParams object.
* @param[in] cp LinphoneCallParams object
* Destroy a #LinphoneCallParams object.
* @param[in] cp #LinphoneCallParams object
* @deprecated Use linphone_call_params_unref() instead.
* @donotwrap
**/

108
include/linphone/callbacks.h
View file

@ -40,9 +40,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
/**
* Callback notifying that a new LinphoneCall (either incoming or outgoing) has been created.
* @param[in] lc LinphoneCore object that has created the call
* @param[in] call The newly created LinphoneCall object
* Callback notifying that a new #LinphoneCall (either incoming or outgoing) has been created.
* @param[in] lc #LinphoneCore object that has created the call
* @param[in] call The newly created #LinphoneCall object
*/
typedef void (*LinphoneCoreCbsCallCreatedCb)(LinphoneCore *lc, LinphoneCall *call);
@ -61,7 +61,7 @@ typedef LinphoneCoreCbsGlobalStateChangedCb LinphoneCoreGlobalStateChangedCb;
/**
* Call state notification callback.
* @param lc the LinphoneCore
* @param lc the #LinphoneCore
* @param call the call object whose state is changed.
* @param cstate the new state of the call
* @param message a non NULL informational message about the state.
@ -75,7 +75,7 @@ typedef LinphoneCoreCbsCallStateChangedCb LinphoneCoreCallStateChangedCb;
/**
* Call encryption changed callback.
* @param lc the LinphoneCore
* @param lc the #LinphoneCore
* @param call the call on which encryption is changed.
* @param on whether encryption is activated.
* @param authentication_token an authentication_token, currently set for ZRTP kind of encryption only.
@ -140,7 +140,7 @@ typedef LinphoneCoreCbsNewSubscriptionRequestedCb LinphoneCoreNewSubscriptionReq
/**
* Callback for requesting authentication information to application or user.
* @param lc the LinphoneCore
* @param lc the #LinphoneCore
* @param realm the realm (domain) on which authentication is required.
* @param username the username that needs to be authenticated.
* @param domain the domain on which authentication is required.
@ -150,8 +150,8 @@ typedef void (*LinphoneCoreAuthInfoRequestedCb)(LinphoneCore *lc, const char *re
/**
* Callback for requesting authentication information to application or user.
* @param lc the LinphoneCore
* @param auth_info a LinphoneAuthInfo pre-filled with username, realm and domain values as much as possible
* @param lc the #LinphoneCore
* @param auth_info a #LinphoneAuthInfo pre-filled with username, realm and domain values as much as possible
* @param method the type of authentication requested
* Application shall reply to this callback using linphone_core_add_auth_info().
*/
@ -165,7 +165,7 @@ typedef LinphoneCoreCbsAuthenticationRequestedCb LinphoneCoreAuthenticationReque
/**
* Callback to notify a new call-log entry has been added.
* This is done typically when a call terminates.
* @param lc the LinphoneCore
* @param lc the #LinphoneCore
* @param newcl the new call log entry added.
*/
typedef void (*LinphoneCoreCbsCallLogUpdatedCb)(LinphoneCore *lc, LinphoneCallLog *newcl);
@ -190,7 +190,7 @@ typedef void (*LinphoneCoreTextMessageReceivedCb)(LinphoneCore *lc, LinphoneChat
* Chat message callback prototype
* @param lc #LinphoneCore object
* @param room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case \link #LinphoneAddress the from \endlink is not present in any chat room.
* @param LinphoneChatMessage incoming message
* @param #LinphoneChatMessage incoming message
*/
typedef void (*LinphoneCoreCbsMessageReceivedCb)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
@ -203,7 +203,7 @@ typedef LinphoneCoreCbsMessageReceivedCb LinphoneCoreMessageReceivedCb;
* Chat message not decrypted callback prototype
* @param lc #LinphoneCore object
* @param room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case \link #LinphoneAddress the from \endlink is not present in any chat room.
* @param LinphoneChatMessage incoming message
* @param #LinphoneChatMessage incoming message
*/
typedef void (*LinphoneCoreCbsMessageReceivedUnableDecryptCb)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
@ -281,7 +281,7 @@ typedef LinphoneCoreCbsBuddyInfoUpdatedCb LinphoneCoreBuddyInfoUpdatedCb;
/**
* Callback for notifying progresses of transfers.
* @param lc the LinphoneCore
* @param lc the #LinphoneCore
* @param transfered the call that was transfered
* @param new_call_state the state of the call to transfer target at the far end.
*/
@ -294,7 +294,7 @@ typedef LinphoneCoreCbsTransferStateChangedCb LinphoneCoreTransferStateChangedCb
/**
* Callback for receiving quality statistics for calls.
* @param lc the LinphoneCore
* @param lc the #LinphoneCore
* @param call the call
* @param stats the call statistics.
*/
@ -307,7 +307,7 @@ typedef LinphoneCoreCbsCallStatsUpdatedCb LinphoneCoreCallStatsUpdatedCb;
/**
* Callback prototype for receiving info messages.
* @param lc the LinphoneCore
* @param lc the #LinphoneCore
* @param call the call whose info message belongs to.
* @param msg the info message.
*/
@ -320,7 +320,7 @@ typedef LinphoneCoreCbsInfoReceivedCb LinphoneCoreInfoReceivedCb;
/**
* Callback prototype for configuring status changes notification
* @param lc the LinphoneCore
* @param lc the #LinphoneCore
* @param message informational message.
*/
typedef void (*LinphoneCoreCbsConfiguringStatusCb)(LinphoneCore *lc, LinphoneConfiguringState status, const char *message);
@ -332,7 +332,7 @@ typedef LinphoneCoreCbsConfiguringStatusCb LinphoneCoreConfiguringStatusCb;
/**
* Callback prototype for reporting network change either automatically detected or notified by #linphone_core_set_network_reachable.
* @param lc the LinphoneCore
* @param lc the #LinphoneCore
* @param reachable true if network is reachable.
*/
typedef void (*LinphoneCoreCbsNetworkReachableCb)(LinphoneCore *lc, bool_t reachable);
@ -344,7 +344,7 @@ typedef LinphoneCoreCbsNetworkReachableCb LinphoneCoreNetworkReachableCb;
/**
* Callback prototype for reporting log collection upload state change.
* @param[in] lc LinphoneCore object
* @param[in] lc #LinphoneCore object
* @param[in] state The state of the log collection upload
* @param[in] info Additional information: error message in case of error state, URL of uploaded file in case of success.
*/
@ -357,7 +357,7 @@ typedef LinphoneCoreCbsLogCollectionUploadStateChangedCb LinphoneCoreLogCollecti
/**
* Callback prototype for reporting log collection upload progress indication.
* @param[in] lc LinphoneCore object
* @param[in] lc #LinphoneCore object
*/
typedef void (*LinphoneCoreCbsLogCollectionUploadProgressIndicationCb)(LinphoneCore *lc, size_t offset, size_t total);
@ -368,8 +368,8 @@ typedef LinphoneCoreCbsLogCollectionUploadProgressIndicationCb LinphoneCoreLogCo
/**
* Callback prototype for reporting when a friend list has been added to the core friends list.
* @param[in] lc LinphoneCore object
* @param[in] list LinphoneFriendList object
* @param[in] lc #LinphoneCore object
* @param[in] list #LinphoneFriendList object
*/
typedef void (*LinphoneCoreCbsFriendListCreatedCb) (LinphoneCore *lc, LinphoneFriendList *list);
@ -380,8 +380,8 @@ typedef LinphoneCoreCbsFriendListCreatedCb LinphoneCoreFriendListCreatedCb;
/**
* Callback prototype for reporting when a friend list has been removed from the core friends list.
* @param[in] lc LinphoneCore object
* @param[in] list LinphoneFriendList object
* @param[in] lc #LinphoneCore object
* @param[in] list #LinphoneFriendList object
*/
typedef void (*LinphoneCoreCbsFriendListRemovedCb) (LinphoneCore *lc, LinphoneFriendList *list);
@ -392,16 +392,16 @@ typedef LinphoneCoreCbsFriendListRemovedCb LinphoneCoreFriendListRemovedCb;
/**
* Callback prototype for reporting the result of a version update check.
* @param[in] lc LinphoneCore object
* @param[in] lc #LinphoneCore object
* @param[in] result The result of the version update check
* @param[in] url The url where to download the new version if the result is LinphoneVersionUpdateCheckNewVersionAvailable
* @param[in] url The url where to download the new version if the result is #LinphoneVersionUpdateCheckNewVersionAvailable
*/
typedef void (*LinphoneCoreCbsVersionUpdateCheckResultReceivedCb) (LinphoneCore *lc, LinphoneVersionUpdateCheckResult result, const char *version, const char *url);
/**
* Callback prototype telling that a LinphoneChatRoom state has changed.
* @param[in] lc LinphoneCore object
* @param[in] cr The LinphoneChatRoom object for which the state has changed
* Callback prototype telling that a #LinphoneChatRoom state has changed.
* @param[in] lc #LinphoneCore object
* @param[in] cr The #LinphoneChatRoom object for which the state has changed
*/
typedef void (*LinphoneCoreCbsChatRoomStateChangedCb) (LinphoneCore *lc, LinphoneChatRoom *cr, LinphoneChatRoomState state);
@ -455,29 +455,29 @@ typedef LinphoneCoreCbsPublishStateChangedCb LinphoneCorePublishStateChangedCb;
/**
* Callback used to notify a new contact has been created on the CardDAV server and downloaded locally
* @param list The LinphoneFriendList object the new contact is added to
* @param lf The LinphoneFriend object that has been created
* @param list The #LinphoneFriendList object the new contact is added to
* @param lf The #LinphoneFriend object that has been created
**/
typedef void (*LinphoneFriendListCbsContactCreatedCb)(LinphoneFriendList *list, LinphoneFriend *lf);
/**
* Callback used to notify a contact has been deleted on the CardDAV server
* @param list The LinphoneFriendList object a contact has been removed from
* @param lf The LinphoneFriend object that has been deleted
* @param list The #LinphoneFriendList object a contact has been removed from
* @param lf The #LinphoneFriend object that has been deleted
**/
typedef void (*LinphoneFriendListCbsContactDeletedCb)(LinphoneFriendList *list, LinphoneFriend *lf);
/**
* Callback used to notify a contact has been updated on the CardDAV server
* @param list The LinphoneFriendList object in which a contact has been updated
* @param new_friend The new LinphoneFriend object corresponding to the updated contact
* @param old_friend The old LinphoneFriend object before update
* @param list The #LinphoneFriendList object in which a contact has been updated
* @param new_friend The new #LinphoneFriend object corresponding to the updated contact
* @param old_friend The old #LinphoneFriend object before update
**/
typedef void (*LinphoneFriendListCbsContactUpdatedCb)(LinphoneFriendList *list, LinphoneFriend *new_friend, LinphoneFriend *old_friend);
/**
* Callback used to notify the status of the synchronization has changed
* @param list The LinphoneFriendList object for which the status has changed
* @param list The #LinphoneFriendList object for which the status has changed
* @param status The new synchronisation status
* @param msg An additional information on the status update
**/
@ -513,44 +513,44 @@ typedef void (*LinphoneCoreCbsEcCalibrationAudioInitCb)(LinphoneCore *lc);
typedef void (*LinphoneCoreCbsEcCalibrationAudioUninitCb)(LinphoneCore *lc);
/**
* Callback to decrypt incoming LinphoneChatMessage
* Callback to decrypt incoming #LinphoneChatMessage
* @param engine ImEncryptionEngine object
* @param room LinphoneChatRoom object
* @param msg LinphoneChatMessage object
* @param room #LinphoneChatRoom object
* @param msg #LinphoneChatMessage object
* @return -1 if nothing to be done, 0 on success or an integer > 0 for error
*/
typedef int (*LinphoneImEncryptionEngineCbsIncomingMessageCb)(LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg);
/**
* Callback to encrypt outgoing LinphoneChatMessage
* @param engine LinphoneImEncryptionEngine object
* @param room LinphoneChatRoom object
* @param msg LinphoneChatMessage object
* Callback to encrypt outgoing #LinphoneChatMessage
* @param engine #LinphoneImEncryptionEngine object
* @param room #LinphoneChatRoom object
* @param msg #LinphoneChatMessage object
* @return -1 if nothing to be done, 0 on success or an integer > 0 for error
*/
typedef int (*LinphoneImEncryptionEngineCbsOutgoingMessageCb)(LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg);
/**
* Callback to know whether or not the engine will encrypt files before uploading them
* @param engine LinphoneImEncryptionEngine object
* @param room LinphoneChatRoom object
* @param engine #LinphoneImEncryptionEngine object
* @param room #LinphoneChatRoom object
* @return TRUE if files will be encrypted, FALSE otherwise
*/
typedef bool_t (*LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb)(LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room);
/**
* Callback to generate the key used to encrypt the files before uploading them
* Key can be stored in the LinphoneContent object inside the LinphoneChatMessage using linphone_content_set_key
* @param engine LinphoneImEncryptionEngine object
* @param room LinphoneChatRoom object
* @param msg LinphoneChatMessage object
* Key can be stored in the #LinphoneContent object inside the #LinphoneChatMessage using linphone_content_set_key
* @param engine #LinphoneImEncryptionEngine object
* @param room #LinphoneChatRoom object
* @param msg #LinphoneChatMessage object
*/
typedef void (*LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb)(LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg);
/**
* Callback to decrypt downloading file
* @param engine LinphoneImEncryptionEngine object
* @param msg LinphoneChatMessage object
* @param engine #LinphoneImEncryptionEngine object
* @param msg #LinphoneChatMessage object
* @param offset The current offset of the upload
* @param[in] buffer Encrypted data buffer
* @param[in] size Size of the encrypted data buffer and maximum size of the decrypted data buffer
@ -561,8 +561,8 @@ typedef int (*LinphoneImEncryptionEngineCbsDownloadingFileCb)(LinphoneImEncrypti
/**
* Callback to encrypt uploading file
* @param engine LinphoneImEncryptionEngine object
* @param msg LinphoneChatMessage object
* @param engine #LinphoneImEncryptionEngine object
* @param msg #LinphoneChatMessage object
* @param offset The current offset of the upload
* @param[in] buffer Encrypted data buffer
* @param[in,out] size Size of the plain data buffer and the size of the encrypted data buffer once encryption is done
@ -573,7 +573,7 @@ typedef int (*LinphoneImEncryptionEngineCbsUploadingFileCb)(LinphoneImEncryption
/**
* Callback used to notify the response to an XML-RPC request.
* @param[in] request LinphoneXmlRpcRequest object
* @param[in] request #LinphoneXmlRpcRequest object
**/
typedef void (*LinphoneXmlRpcRequestCbsResponseCb)(LinphoneXmlRpcRequest *request);
@ -588,7 +588,7 @@ typedef void (*LinphoneXmlRpcRequestCbsResponseCb)(LinphoneXmlRpcRequest *reques
/**
* Callback for notifying end of play (file).
* @param[in] player The LinphonePlayer object
* @param[in] player The #LinphonePlayer object
**/
typedef void (*LinphonePlayerCbsEofReachedCb)(LinphonePlayer *obj);

2
include/linphone/conference.h
View file

@ -118,7 +118,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_conference_remove_participant(LinphoneCo
LINPHONE_PUBLIC bctbx_list_t *linphone_conference_get_participants(const LinphoneConference *obj);
/**
* Invite participants to the conference, by supplying a list of LinphoneAddress
* Invite participants to the conference, by supplying a list of #LinphoneAddress
* @param obj The conference.
* @param addresses \bctbx_list{LinphoneAddress}
* @param params #LinphoneCallParams to use for inviting the participants.

56
include/linphone/content.h
View file

@ -36,69 +36,69 @@ extern "C" {
/**
* Acquire a reference to the content.
* @param[in] content LinphoneContent object.
* @return The same LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return The same #LinphoneContent object.
**/
LINPHONE_PUBLIC LinphoneContent * linphone_content_ref(LinphoneContent *content);
/**
* Release reference to the content.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
**/
LINPHONE_PUBLIC void linphone_content_unref(LinphoneContent *content);
/**
* Retrieve the user pointer associated with the content.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return The user pointer associated with the content.
**/
LINPHONE_PUBLIC void *linphone_content_get_user_data(const LinphoneContent *content);
/**
* Assign a user pointer to the content.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] ud The user pointer to associate with the content.
**/
LINPHONE_PUBLIC void linphone_content_set_user_data(LinphoneContent *content, void *ud);
/**
* Get the mime type of the content data.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return The mime type of the content data, for example "application".
*/
LINPHONE_PUBLIC const char * linphone_content_get_type(const LinphoneContent *content);
/**
* Set the mime type of the content data.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] type The mime type of the content data, for example "application".
*/
LINPHONE_PUBLIC void linphone_content_set_type(LinphoneContent *content, const char *type);
/**
* Get the mime subtype of the content data.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return The mime subtype of the content data, for example "html".
*/
LINPHONE_PUBLIC const char * linphone_content_get_subtype(const LinphoneContent *content);
/**
* Set the mime subtype of the content data.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] subtype The mime subtype of the content data, for example "html".
*/
LINPHONE_PUBLIC void linphone_content_set_subtype(LinphoneContent *content, const char *subtype);
/**
* Get the content data buffer, usually a string.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return The content data buffer.
*/
LINPHONE_PUBLIC uint8_t * linphone_content_get_buffer(const LinphoneContent *content);
/**
* Set the content data buffer, usually a string.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] buffer The content data buffer.
* @param[in] size The size of the content data buffer.
*/
@ -106,87 +106,87 @@ LINPHONE_PUBLIC void linphone_content_set_buffer(LinphoneContent *content, const
/**
* Get the string content data buffer.
* @param[in] content LinphoneContent object
* @param[in] content #LinphoneContent object
* @return The string content data buffer.
*/
LINPHONE_PUBLIC const char * linphone_content_get_string_buffer(const LinphoneContent *content);
/**
* Set the string content data buffer.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] buffer The string content data buffer.
*/
LINPHONE_PUBLIC void linphone_content_set_string_buffer(LinphoneContent *content, const char *buffer);
/**
* Get the content data buffer size, excluding null character despite null character is always set for convenience.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return The content data buffer size.
*/
LINPHONE_PUBLIC size_t linphone_content_get_size(const LinphoneContent *content);
/**
* Set the content data size, excluding null character despite null character is always set for convenience.
* @param[in] content LinphoneContent object
* @param[in] content #LinphoneContent object
* @param[in] size The content data buffer size.
*/
LINPHONE_PUBLIC void linphone_content_set_size(LinphoneContent *content, size_t size);
/**
* Get the encoding of the data buffer, for example "gzip".
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return The encoding of the data buffer.
*/
LINPHONE_PUBLIC const char * linphone_content_get_encoding(const LinphoneContent *content);
/**
* Set the encoding of the data buffer, for example "gzip".
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] encoding The encoding of the data buffer.
*/
LINPHONE_PUBLIC void linphone_content_set_encoding(LinphoneContent *content, const char *encoding);
/**
* 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.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return The name of the content.
*/
LINPHONE_PUBLIC const char * linphone_content_get_name(const LinphoneContent *content);
/**
* 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.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] name The name of the content.
*/
LINPHONE_PUBLIC void linphone_content_set_name(LinphoneContent *content, const char *name);
/**
* Tell whether a content is a multipart content.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return A boolean value telling whether the content is multipart or not.
*/
LINPHONE_PUBLIC bool_t linphone_content_is_multipart(const LinphoneContent *content);
/**
* Get a part from a multipart content according to its index.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] idx The index of the part to get.
* @return A LinphoneContent object holding the part if found, NULL otherwise.
* @return A #LinphoneContent object holding the part if found, NULL otherwise.
*/
LINPHONE_PUBLIC LinphoneContent * linphone_content_get_part(const LinphoneContent *content, int idx);
/**
* Find a part from a multipart content looking for a part header with a specified value.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] header_name The name of the header to look for.
* @param[in] header_value The value of the header to look for.
* @return A LinphoneContent object object the part if found, NULL otherwise.
* @return A #LinphoneContent object object the part if found, NULL otherwise.
*/
LINPHONE_PUBLIC LinphoneContent * linphone_content_find_part_by_header(const LinphoneContent *content, const char *header_name, const char *header_value);
/**
* Get a custom header value of a content.
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] header_name The name of the header to get the value from.
* @return The value of the header if found, NULL otherwise.
*/
@ -194,21 +194,21 @@ LINPHONE_PUBLIC const char * linphone_content_get_custom_header(const LinphoneCo
/**
* Get the key associated with a RCS file transfer message if encrypted
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return The key to encrypt/decrypt the file associated to this content.
*/
LINPHONE_PUBLIC const char *linphone_content_get_key(const LinphoneContent *content);
/**
* Get the size of key associated with a RCS file transfer message if encrypted
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @return The key size in bytes
*/
LINPHONE_PUBLIC size_t linphone_content_get_key_size(const LinphoneContent *content);
/**
* Set the key associated with a RCS file transfer message if encrypted
* @param[in] content LinphoneContent object.
* @param[in] content #LinphoneContent object.
* @param[in] key The key to be used to encrypt/decrypt file associated to this content.
* @param[in] keyLength The lengh of the key.
*/

810
include/linphone/core.h
View file

File diff suppressed because it is too large Load diff

36
include/linphone/error_info.h
View file

@ -32,9 +32,9 @@ extern "C" {
*/
/**
* Create an empty LinphoneErrorInfo object.
* The LinphoneErrorInfo object carries these fields:
* - a LinphoneReason enum member giving overall signification of the error reported.
* 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
@ -63,10 +63,10 @@ LINPHONE_PUBLIC void linphone_error_info_unref(LinphoneErrorInfo *ei);
LINPHONE_PUBLIC LinphoneReason linphone_error_info_get_reason(const LinphoneErrorInfo *ei);
/**
* Get pointer to chained LinphoneErrorInfo set in sub_ei.
* Get pointer to chained #LinphoneErrorInfo set in sub_ei.
* It corresponds to a Reason header in a received SIP response.
* @param ei ErrorInfo object
* @return LinphoneErrorInfo pointer defined in the ei object.
* @return #LinphoneErrorInfo pointer defined in the ei object.
*/
LINPHONE_PUBLIC LinphoneErrorInfo* linphone_error_info_get_sub_error_info(const LinphoneErrorInfo *ei);
@ -102,10 +102,10 @@ LINPHONE_PUBLIC const char * linphone_error_info_get_warnings(const LinphoneErro
LINPHONE_PUBLIC int linphone_error_info_get_protocol_code(const LinphoneErrorInfo *ei);
/**
* Assign information to a LinphoneErrorInfo object.
* Assign information to a #LinphoneErrorInfo object.
* @param[in] ei ErrorInfo object
* @param[in] protocol protocol name
* @param[in] reason reason from LinphoneReason enum
* @param[in] reason reason from #LinphoneReason enum
* @param[in] code protocol code
* @param[in] status_string description of the reason
* @param[in] warning warning message
@ -113,44 +113,44 @@ LINPHONE_PUBLIC int linphone_error_info_get_protocol_code(const LinphoneErrorInf
LINPHONE_PUBLIC void linphone_error_info_set(LinphoneErrorInfo *ei, const char *protocol, LinphoneReason reason, int code, const char *status_string, const char *warning);
/**
* 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.
* @param[in] ei LinphoneErrorInfo object to which the other LinphoneErrorInfo will be appended as ei->sub_ei.
* @param[in] appended_ei LinphoneErrorInfo to append
* 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.
* @param[in] ei #LinphoneErrorInfo object to which the other #LinphoneErrorInfo will be appended as ei->sub_ei.
* @param[in] appended_ei #LinphoneErrorInfo to append
*/
LINPHONE_PUBLIC void linphone_error_info_set_sub_error_info(LinphoneErrorInfo *ei, LinphoneErrorInfo *appended_ei);
/**
* Assign reason LinphoneReason to a LinphoneErrorInfo object.
* Assign reason #LinphoneReason to a #LinphoneErrorInfo object.
* @param[in] ei ErrorInfo object
* @param[in] reason reason from LinphoneReason enum
* @param[in] reason reason from #LinphoneReason enum
*/
LINPHONE_PUBLIC void linphone_error_info_set_reason(LinphoneErrorInfo *ei, LinphoneReason reason);
/**
* Assign protocol name to a LinphoneErrorInfo object.
* Assign protocol name to a #LinphoneErrorInfo object.
* @param[in] ei ErrorInfo object
* @param[in] proto the protocol name
*/
LINPHONE_PUBLIC void linphone_error_info_set_protocol(LinphoneErrorInfo *ei, const char *proto);
/**
* Assign protocol code to a LinphoneErrorInfo object.
* Assign protocol code to a #LinphoneErrorInfo object.
* @param[in] ei ErrorInfo object
* @param[in] code the protocol code
*/
LINPHONE_PUBLIC void linphone_error_info_set_protocol_code(LinphoneErrorInfo *ei, int code);
/**
* Assign phrase to a LinphoneErrorInfo object.
* Assign phrase to a #LinphoneErrorInfo object.
* @param[in] ei ErrorInfo object
* @param[in] phrase the phrase explaining the error
*/
LINPHONE_PUBLIC void linphone_error_info_set_phrase(LinphoneErrorInfo *ei, const char *phrase);
/**
* Assign warnings to a LinphoneErrorInfo object.
* Assign warnings to a #LinphoneErrorInfo object.
* @param[in] ei ErrorInfo object
* @param[in] phrase the warnings
*/

20
include/linphone/event.h
View file

@ -33,7 +33,7 @@ extern "C" {
/**
* Send a subscription previously created by linphone_core_create_subscribe().
* @param ev the LinphoneEvent
* @param ev the #LinphoneEvent
* @param body optional content to attach with the subscription.
* @return 0 if successful, -1 otherwise.
**/
@ -41,14 +41,14 @@ LINPHONE_PUBLIC LinphoneStatus linphone_event_send_subscribe(LinphoneEvent *ev,
/**
* Update (refresh) an outgoing subscription, changing the body.
* @param lev a LinphoneEvent
* @param lev a #LinphoneEvent
* @param body an optional body to include in the subscription update, may be NULL.
**/
LINPHONE_PUBLIC LinphoneStatus linphone_event_update_subscribe(LinphoneEvent *lev, const LinphoneContent *body);
/**
* Refresh an outgoing subscription keeping the same body.
* @param lev LinphoneEvent object.
* @param lev #LinphoneEvent object.
* @return 0 if successful, -1 otherwise.
*/
LINPHONE_PUBLIC LinphoneStatus linphone_event_refresh_subscribe(LinphoneEvent *lev);
@ -88,7 +88,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_event_update_publish(LinphoneEvent *lev,
/**
* Refresh an outgoing publish keeping the same body.
* @param lev LinphoneEvent object.
* @param lev #LinphoneEvent object.
* @return 0 if successful, -1 otherwise.
*/
LINPHONE_PUBLIC LinphoneStatus linphone_event_refresh_publish(LinphoneEvent *lev);
@ -140,7 +140,7 @@ LINPHONE_PUBLIC void *linphone_event_get_user_data(const LinphoneEvent *ev);
/**
* Add a custom header to an outgoing susbscription or publish.
* @param ev the LinphoneEvent
* @param ev the #LinphoneEvent
* @param name header's name
* @param value the header's value.
**/
@ -148,7 +148,7 @@ LINPHONE_PUBLIC void linphone_event_add_custom_header(LinphoneEvent *ev, const c
/**
* Obtain the value of a given header for an incoming subscription.
* @param ev the LinphoneEvent
* @param ev the #LinphoneEvent
* @param name header's name
* @return the header's value or NULL if such header doesn't exist.
**/
@ -156,14 +156,14 @@ LINPHONE_PUBLIC const char *linphone_event_get_custom_header(LinphoneEvent *ev,
/**
* Terminate an incoming or outgoing subscription that was previously acccepted, or a previous publication.
* The LinphoneEvent shall not be used anymore after this operation, unless the application explicitely took a reference on the object with
* The #LinphoneEvent shall not be used anymore after this operation, unless the application explicitely took a reference on the object with
* linphone_event_ref().
**/
LINPHONE_PUBLIC void linphone_event_terminate(LinphoneEvent *lev);
/**
* Increase reference count of LinphoneEvent.
* By default LinphoneEvents created by the core are owned by the core only.
* By default #LinphoneEvents created by the core are owned by the core only.
* An application that wishes to retain a reference to it must call linphone_event_ref().
* When this reference is no longer needed, linphone_event_unref() must be called.
*
@ -193,13 +193,13 @@ LINPHONE_PUBLIC const LinphoneAddress *linphone_event_get_resource(const Linphon
/**
* Get the "contact" address of the subscription.
* @param[in] lev LinphoneEvent object
* @param[in] lev #LinphoneEvent object
* @return The "contact" address of the subscription
*/
LINPHONE_PUBLIC const LinphoneAddress *linphone_event_get_remote_contact (const LinphoneEvent *lev);
/**
* Returns back pointer to the LinphoneCore that created this LinphoneEvent
* Returns back pointer to the #LinphoneCore that created this #LinphoneEvent
**/
LINPHONE_PUBLIC LinphoneCore *linphone_event_get_core(const LinphoneEvent *lev);

150
include/linphone/factory.h
View file

@ -47,7 +47,7 @@ LINPHONE_PUBLIC void linphone_factory_clean(void);
/**
* Instanciate a #LinphoneCore object.
*
* The LinphoneCore object is the primary handle for doing all phone actions.
* The #LinphoneCore object is the primary handle for doing all phone actions.
* It should be unique within your application.
* @param factory The #LinphoneFactory singleton.
* @param cbs a #LinphoneCoreCbs object holding your application callbacks. A reference
@ -74,7 +74,7 @@ LINPHONE_DEPRECATED LINPHONE_PUBLIC LinphoneCore *linphone_factory_create_core(
/**
* Instanciate a #LinphoneCore object.
*
* The LinphoneCore object is the primary handle for doing all phone actions.
* The #LinphoneCore object is the primary handle for doing all phone actions.
* It should be unique within your application.
* @param factory The #LinphoneFactory singleton.
* @param cbs a #LinphoneCoreCbs object holding your application callbacks. A reference
@ -105,13 +105,13 @@ LINPHONE_DEPRECATED LINPHONE_PUBLIC LinphoneCore *linphone_factory_create_core_2
/**
* Instantiate a #LinphoneCore object.
*
* The LinphoneCore object is the primary handle for doing all phone actions. It should be unique within your
* The #LinphoneCore object is the primary handle for doing all phone actions. It should be unique within your
* application.
* The LinphoneCore object is not started automatically, you need to call linphone_core_start() to that effect.
* The #LinphoneCore object is not started automatically, you need to call linphone_core_start() to that effect.
* @param[in] factory The #LinphoneFactory singleton.
* @param[in] config_path A path to a config file. If it does not exists it will be created. The config file is used to
* store all settings, proxies... so that all these settings become persistent over the life of the LinphoneCore object.
* It is allowed to set a NULL config file. In that case LinphoneCore will not store any settings.
* store all settings, proxies... so that all these settings become persistent over the life of the #LinphoneCore object.
* It is allowed to set a NULL config file. In that case #LinphoneCore will not store any settings.
* @param[in] factory_config_path A path to a read-only config file that can be used to store hard-coded preferences
* such as proxy settings or internal preferences. The settings in this factory file always override the ones in the
* normal config file. It is optional, use NULL if unneeded.
@ -127,15 +127,15 @@ LINPHONE_PUBLIC LinphoneCore *linphone_factory_create_core_3 (
);
/**
* Instantiates a LinphoneCore object with a given LpConfig.
* Instantiates a #LinphoneCore object with a given LpConfig.
*
* @param factory The #LinphoneFactory singleton.
* The LinphoneCore object is the primary handle for doing all phone actions.
* The #LinphoneCore object is the primary handle for doing all phone actions.
* It should be unique within your application.
* @param cbs a #LinphoneCoreCbs object holding your application callbacks. A reference
* will be taken on it until the destruciton of the core or the unregistration
* with linphone_core_remove_cbs().
* @param config a pointer to an LpConfig object holding the configuration of the LinphoneCore to be instantiated.
* @param config a pointer to an LpConfig object holding the configuration of the #LinphoneCore to be instantiated.
* @see linphone_core_new
* @deprecated 2018-01-10: Use linphone_factory_create_core_with_config_3() instead
*/
@ -146,15 +146,15 @@ LINPHONE_DEPRECATED LINPHONE_PUBLIC LinphoneCore *linphone_factory_create_core_w
);
/**
* Instantiates a LinphoneCore object with a given LpConfig.
* Instantiates a #LinphoneCore object with a given LpConfig.
*
* @param factory The #LinphoneFactory singleton.
* The LinphoneCore object is the primary handle for doing all phone actions.
* The #LinphoneCore object is the primary handle for doing all phone actions.
* It should be unique within your application.
* @param cbs a #LinphoneCoreCbs object holding your application callbacks. A reference
* will be taken on it until the destruciton of the core or the unregistration
* with linphone_core_remove_cbs().
* @param config a pointer to an LpConfig object holding the configuration of the LinphoneCore to be instantiated.
* @param config a pointer to an LpConfig object holding the configuration of the #LinphoneCore to be instantiated.
* @param user_data an application pointer associated with the returned core.
* @param system_context a pointer to a system object required by the core to operate. Currently it is required to pass an android Context on android, pass NULL on other platforms.
* @see linphone_core_new
@ -169,13 +169,13 @@ LINPHONE_DEPRECATED LINPHONE_PUBLIC LinphoneCore *linphone_factory_create_core_w
);
/**
* Instantiate a LinphoneCore object with a given LinphoneConfig.
* Instantiate a #LinphoneCore object with a given LinphoneConfig.
*
* The LinphoneCore object is the primary handle for doing all phone actions. It should be unique within your
* The #LinphoneCore object is the primary handle for doing all phone actions. It should be unique within your
* application.
* The LinphoneCore object is not started automatically, you need to call linphone_core_start() to that effect.
* The #LinphoneCore object is not started automatically, you need to call linphone_core_start() to that effect.
* @param[in] factory The #LinphoneFactory singleton.
* @param[in] config A #LinphoneConfig object holding the configuration for the LinphoneCore to be instantiated.
* @param[in] config A #LinphoneConfig object holding the configuration for the #LinphoneCore to be instantiated.
* @param[in] system_context A pointer to a system object required by the core to operate. Currently it is required to
* pass an android Context on android, pass NULL on other platforms.
* @see linphone_factory_create_core_3
@ -212,15 +212,15 @@ LINPHONE_PUBLIC LinphoneAddress *linphone_factory_create_address(const LinphoneF
* @param ha1 The ha1-encrypted password if password is not given in clear text.
* @param realm The authentication domain (which can be larger than the sip domain. Unfortunately many SIP servers don't use this parameter.
* @param domain The SIP domain for which this authentication information is valid, if it has to be restricted for a single SIP domain.
* @return A #LinphoneAuthInfo object. linphone_auth_info_destroy() must be used to destroy it when no longer needed. The LinphoneCore makes a copy of LinphoneAuthInfo
* @return A #LinphoneAuthInfo object. linphone_auth_info_destroy() must be used to destroy it when no longer needed. The #LinphoneCore makes a copy of #LinphoneAuthInfo
* passed through linphone_core_add_auth_info().
*/
LINPHONE_PUBLIC LinphoneAuthInfo *linphone_factory_create_auth_info(const LinphoneFactory *factory, const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm, const char *domain);
/**
* Create a LinphoneCallCbs object that holds callbacks for events happening on a call.
* @param[in] factory LinphoneFactory singletion object
* @return A new LinphoneCallCbs object
* Create a #LinphoneCallCbs object that holds callbacks for events happening on a call.
* @param[in] factory #LinphoneFactory singletion object
* @return A new #LinphoneCallCbs object
*/
LINPHONE_PUBLIC LinphoneCallCbs * linphone_factory_create_call_cbs(const LinphoneFactory *factory);
@ -232,32 +232,32 @@ LINPHONE_PUBLIC LinphoneCallCbs * linphone_factory_create_call_cbs(const Linphon
LINPHONE_PUBLIC LinphoneVcard *linphone_factory_create_vcard(LinphoneFactory *factory);
/**
* Create a LinphoneVideoDefinition from a given width and height
* @param[in] factory LinphoneFactory singleton object
* Create a #LinphoneVideoDefinition from a given width and height
* @param[in] factory #LinphoneFactory singleton object
* @param[in] width The width of the created video definition
* @param[in] height The height of the created video definition
* @return A new LinphoneVideoDefinition object
* @return A new #LinphoneVideoDefinition object
*/
LINPHONE_PUBLIC LinphoneVideoDefinition * linphone_factory_create_video_definition(const LinphoneFactory *factory, unsigned int width, unsigned int height);
/**
* Create a LinphoneVideoDefinition from a given standard definition name
* @param[in] factory LinphoneFactory singleton object
* Create a #LinphoneVideoDefinition from a given standard definition name
* @param[in] factory #LinphoneFactory singleton object
* @param[in] name The standard definition name of the video definition to create
* @return A new LinphoneVideoDefinition object
* @return A new #LinphoneVideoDefinition object
*/
LINPHONE_PUBLIC LinphoneVideoDefinition * linphone_factory_create_video_definition_from_name(const LinphoneFactory *factory, const char *name);
/**
* Get the list of standard video definitions supported by Linphone.
* @param[in] factory LinphoneFactory singleton object
* @param[in] factory #LinphoneFactory singleton object
* @return \bctbx_list{LinphoneVideoDefinition}
*/
LINPHONE_PUBLIC const bctbx_list_t * linphone_factory_get_supported_video_definitions(const LinphoneFactory *factory);
/**
* Get the top directory where the resources are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @return The path to the top directory where the resources are located
*/
LINPHONE_PUBLIC const char * linphone_factory_get_top_resources_dir(const LinphoneFactory *factory);
@ -265,195 +265,195 @@ LINPHONE_PUBLIC const char * linphone_factory_get_top_resources_dir(const Linpho
/**
* Set the top directory where the resources are located.
* If you only define this top directory, the other resources directory will automatically be derived form this one.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @param[in] path The path to the top directory where the resources are located
*/
LINPHONE_PUBLIC void linphone_factory_set_top_resources_dir(LinphoneFactory *factory, const char *path);
/**
* Get the directory where the data resources are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @return The path to the directory where the data resources are located
*/
LINPHONE_PUBLIC const char * linphone_factory_get_data_resources_dir(LinphoneFactory *factory);
/**
* Set the directory where the data resources are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @param[in] path The path where the data resources are located
*/
LINPHONE_PUBLIC void linphone_factory_set_data_resources_dir(LinphoneFactory *factory, const char *path);
/**
* Get the directory where the sound resources are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @return The path to the directory where the sound resources are located
*/
LINPHONE_PUBLIC const char * linphone_factory_get_sound_resources_dir(LinphoneFactory *factory);
/**
* Set the directory where the sound resources are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @param[in] path The path where the sound resources are located
*/
LINPHONE_PUBLIC void linphone_factory_set_sound_resources_dir(LinphoneFactory *factory, const char *path);
/**
* Get the directory where the ring resources are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @return The path to the directory where the ring resources are located
*/
LINPHONE_PUBLIC const char * linphone_factory_get_ring_resources_dir(LinphoneFactory *factory);
/**
* Set the directory where the ring resources are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @param[in] path The path where the ring resources are located
*/
LINPHONE_PUBLIC void linphone_factory_set_ring_resources_dir(LinphoneFactory *factory, const char *path);
/**
* Get the directory where the image resources are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @return The path to the directory where the image resources are located
*/
LINPHONE_PUBLIC const char * linphone_factory_get_image_resources_dir(LinphoneFactory *factory);
/**
* Set the directory where the image resources are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @param[in] path The path where the image resources are located
*/
LINPHONE_PUBLIC void linphone_factory_set_image_resources_dir(LinphoneFactory *factory, const char *path);
/**
* Get the directory where the mediastreamer2 plugins are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @return The path to the directory where the mediastreamer2 plugins are located, or NULL if it has not been set
*/
LINPHONE_PUBLIC const char * linphone_factory_get_msplugins_dir(LinphoneFactory *factory);
/**
* Set the directory where the mediastreamer2 plugins are located.
* @param[in] factory LinphoneFactory object
* @param[in] factory #LinphoneFactory object
* @param[in] path The path to the directory where the mediastreamer2 plugins are located
*/
LINPHONE_PUBLIC void linphone_factory_set_msplugins_dir(LinphoneFactory *factory, const char *path);
/**
* Creates an object LinphoneErrorInfo.
* @param[in] factory LinphoneFactory object
* @return LinphoneErrorInfo object.
* @param[in] factory #LinphoneFactory object
* @return #LinphoneErrorInfo object.
*/
LINPHONE_PUBLIC LinphoneErrorInfo *linphone_factory_create_error_info(LinphoneFactory *factory);
/**
* Creates an object LinphoneRange.
* @param[in] factory LinphoneFactory object
* @return LinphoneRange object.
* @param[in] factory #LinphoneFactory object
* @return #LinphoneRange object.
*/
LINPHONE_PUBLIC LinphoneRange *linphone_factory_create_range(LinphoneFactory *factory);
/**
* Creates an object LinphoneTransports.
* @param[in] factory LinphoneFactory object
* @return LinphoneTransports object.
* @param[in] factory #LinphoneFactory object
* @return #LinphoneTransports object.
*/
LINPHONE_PUBLIC LinphoneTransports *linphone_factory_create_transports(LinphoneFactory *factory);
/**
* Creates an object LinphoneVideoActivationPolicy.
* @param[in] factory LinphoneFactory object
* @return LinphoneVideoActivationPolicy object.
* @param[in] factory #LinphoneFactory object
* @return #LinphoneVideoActivationPolicy object.
*/
LINPHONE_PUBLIC LinphoneVideoActivationPolicy *linphone_factory_create_video_activation_policy(LinphoneFactory *factory);
/**
* Returns a bctbx_list_t of all DialPlans
* @param[in] factory the LinphoneFactory object
* @param[in] factory the #LinphoneFactory object
* @return \bctbx_list{LinphoneDialPlan} a list of DialPlan
*/
LINPHONE_PUBLIC const bctbx_list_t * linphone_factory_get_dial_plans(const LinphoneFactory *factory);
/**
* Creates an object LinphoneContent
* @param[in] factory the LinphoneFactory
* @return a LinphoneContent
* Creates an object #LinphoneContent
* @param[in] factory the #LinphoneFactory
* @return a #LinphoneContent
*/
LINPHONE_PUBLIC LinphoneContent *linphone_factory_create_content(LinphoneFactory *factory);
/**
* Creates an object LinphoneBuffer
* @param[in] factory the LinphoneFactory
* @return a LinphoneBuffer
* Creates an object #LinphoneBuffer
* @param[in] factory the #LinphoneFactory
* @return a #LinphoneBuffer
*/
LINPHONE_PUBLIC LinphoneBuffer *linphone_factory_create_buffer(LinphoneFactory *factory);
/**
* Creates an object LinphoneBuffer
* @param[in] factory the LinphoneFactory
* Creates an object #LinphoneBuffer
* @param[in] factory the #LinphoneFactory
* @param[in] data the data to set in the buffer
* @param[in] size the size of the data
* @return a LinphoneBuffer
* @return a #LinphoneBuffer
*/
LINPHONE_PUBLIC LinphoneBuffer *linphone_factory_create_buffer_from_data(LinphoneFactory *factory, const uint8_t *data, size_t size);
/**
* Creates an object LinphoneBuffer
* @param[in] factory the LinphoneFactory
* Creates an object #LinphoneBuffer
* @param[in] factory the #LinphoneFactory
* @param[in] data the data to set in the buffer
* @return a LinphoneBuffer
* @return a #LinphoneBuffer
*/
LINPHONE_PUBLIC LinphoneBuffer *linphone_factory_create_buffer_from_string(LinphoneFactory *factory, const char *data);
/**
* Creates an object LinphoneConfig
* @param[in] factory the LinphoneFactory
* Creates an object #LinphoneConfig
* @param[in] factory the #LinphoneFactory
* @param[in] the path of the config
* @return a LinphoneConfig
* @return a #LinphoneConfig
*/
LINPHONE_PUBLIC LinphoneConfig *linphone_factory_create_config(LinphoneFactory *factory, const char *path);
/**
* Creates an object LinphoneConfig
* @param[in] factory the LinphoneFactory
* Creates an object #LinphoneConfig
* @param[in] factory the #LinphoneFactory
* @param[in] the path of the config
* @param[in] the path of the factory
* @return a LinphoneConfig
* @return a #LinphoneConfig
*/
LINPHONE_PUBLIC LinphoneConfig *linphone_factory_create_config_with_factory(LinphoneFactory *factory, const char *path, const char *factory_path);
/**
* Creates an object LinphoneConfig
* @param[in] factory the LinphoneFactory
* @return a LinphoneConfig
* Creates an object #LinphoneConfig
* @param[in] factory the #LinphoneFactory
* @return a #LinphoneConfig
*/
LINPHONE_PUBLIC LinphoneConfig *linphone_factory_create_config_from_string(LinphoneFactory *factory, const char *data);
/**
* Gets the user data in the LinphoneFactory object
* @param[in] factory the LinphoneFactory
* Gets the user data in the #LinphoneFactory object
* @param[in] factory the #LinphoneFactory
* @return the user data
*/
LINPHONE_PUBLIC void *linphone_factory_get_user_data(const LinphoneFactory *factory);
/**
* Sets the user data in the LinphoneFactory object
* @param[in] factory the LinphoneFactory object
* Sets the user data in the #LinphoneFactory object
* @param[in] factory the #LinphoneFactory object
* @param[in] data the user data
*/
LINPHONE_PUBLIC void linphone_factory_set_user_data(LinphoneFactory *factory, void *data);
/**
* Sets the log collection path
* @param[in] factory the LinphoneFactory
* @param[in] factory the #LinphoneFactory
* @param[in] the path of the logs
*/
LINPHONE_PUBLIC void linphone_factory_set_log_collection_path(LinphoneFactory *factory, const char *path);
/**
* Enables or disables log collection
* @param[in] factory the LinphoneFactory
* @param[in] factory the #LinphoneFactory
* @param[in] the policy for log collection
*/
LINPHONE_PUBLIC void linphone_factory_enable_log_collection(LinphoneFactory *factory, LinphoneLogCollectionState state);

22
include/linphone/friend.h
View file

@ -56,7 +56,7 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED LinphoneFriend *linphone_friend_new_with_add
/**
* Destroy a LinphoneFriend.
* @param lf LinphoneFriend object
* @param lf #LinphoneFriend object
* @deprecated Use linphone_friend_unref() instead.
* @donotwrap
*/
@ -77,7 +77,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_friend_set_address(LinphoneFriend *fr, c
/**
* Get address of this friend.
* @note the LinphoneAddress object returned is hold by the LinphoneFriend, however calling several time this function may return different objects.
* @note the #LinphoneAddress object returned is hold by the LinphoneFriend, however calling several time this function may return different objects.
* @param lf #LinphoneFriend object
* @return #LinphoneAddress
*/
@ -215,7 +215,7 @@ LINPHONE_PUBLIC const LinphonePresenceModel * linphone_friend_get_presence_model
/**
* Get the consolidated presence of a friend.
* @param[in] lf LinphoneFriend object
* @param[in] lf #LinphoneFriend object
* @return The consolidated presence of the friend
*/
LINPHONE_PUBLIC LinphoneConsolidatedPresence linphone_friend_get_consolidated_presence(const LinphoneFriend *lf);
@ -285,39 +285,39 @@ LINPHONE_PUBLIC bool_t linphone_friend_in_list(const LinphoneFriend *lf);
/**
* Acquire a reference to the linphone friend.
* @param[in] lf LinphoneFriend object
* @return The same LinphoneFriend object
* @param[in] lf #LinphoneFriend object
* @return The same #LinphoneFriend object
**/
LINPHONE_PUBLIC LinphoneFriend * linphone_friend_ref(LinphoneFriend *lf);
/**
* Release a reference to the linphone friend.
* @param[in] lf LinphoneFriend object
* @param[in] lf #LinphoneFriend object
**/
LINPHONE_PUBLIC void linphone_friend_unref(LinphoneFriend *lf);
/**
* Returns the LinphoneCore object managing this friend, if any.
* @param[in] fr LinphoneFriend object
* Returns the #LinphoneCore object managing this friend, if any.
* @param[in] fr #LinphoneFriend object
*/
LINPHONE_PUBLIC LinphoneCore *linphone_friend_get_core(const LinphoneFriend *fr);
/**
* Returns the vCard object associated to this friend, if any
* @param[in] fr LinphoneFriend object
* @param[in] fr #LinphoneFriend object
*/
LINPHONE_PUBLIC LinphoneVcard* linphone_friend_get_vcard(LinphoneFriend *fr);
/**
* Binds a vCard object to a friend
* @param[in] fr LinphoneFriend object
* @param[in] fr #LinphoneFriend object
* @param[in] vcard The vCard object to bind
*/
LINPHONE_PUBLIC void linphone_friend_set_vcard(LinphoneFriend *fr, LinphoneVcard *vcard);
/**
* Creates a vCard object associated to this friend if there isn't one yet and if the full name is available, either by the parameter or the one in the friend's SIP URI
* @param[in] fr LinphoneFriend object
* @param[in] fr #LinphoneFriend object
* @param[in] name The full name of the friend or NULL to use the one from the friend's SIP URI
* @return true if the vCard has been created, false if it wasn't possible (for exemple if name and the friend's SIP URI are null or if the friend's SIP URI doesn't have a display name), or if there is already one vcard
*/

144
include/linphone/friendlist.h
View file

@ -36,126 +36,126 @@ extern "C" {
/**
* Acquire a reference to the friend list.
* @param[in] list LinphoneFriendList object.
* @return The same LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @return The same #LinphoneFriendList object.
**/
LINPHONE_PUBLIC LinphoneFriendList * linphone_friend_list_ref(LinphoneFriendList *list);
/**
* Release reference to the friend list.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
**/
LINPHONE_PUBLIC void linphone_friend_list_unref(LinphoneFriendList *list);
/**
* Retrieve the user pointer associated with the friend list.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @return The user pointer associated with the friend list.
**/
LINPHONE_PUBLIC void * linphone_friend_list_get_user_data(const LinphoneFriendList *list);
/**
* Assign a user pointer to the friend list.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @param[in] ud The user pointer to associate with the friend list.
**/
LINPHONE_PUBLIC void linphone_friend_list_set_user_data(LinphoneFriendList *list, void *ud);
/**
* Get the display name of the friend list.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @return The display name of the friend list.
**/
LINPHONE_PUBLIC const char * linphone_friend_list_get_display_name(const LinphoneFriendList *list);
/**
* Set the display name of the friend list.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @param[in] display_name The new display name of the friend list.
**/
LINPHONE_PUBLIC void linphone_friend_list_set_display_name(LinphoneFriendList *list, const char *display_name);
/**
* Get the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @return The RLS URI associated with the friend list.
**/
LINPHONE_PUBLIC const char * linphone_friend_list_get_rls_uri(const LinphoneFriendList *list);
/**
* Set the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @param[in] rls_uri The RLS URI to associate with the friend list.
**/
LINPHONE_PUBLIC void linphone_friend_list_set_rls_uri(LinphoneFriendList *list, const char *rls_uri);
/**
* Get the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @return The RLS URI associated with the friend list.
**/
LINPHONE_PUBLIC const LinphoneAddress * linphone_friend_list_get_rls_address(const LinphoneFriendList *list);
/**
* Set the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @param[in] rls_addr The RLS URI to associate with the friend list.
**/
LINPHONE_PUBLIC void linphone_friend_list_set_rls_address(LinphoneFriendList *list, const LinphoneAddress *rls_addr);
/**
* Add a friend to a friend list. If or when a remote CardDAV server will be attached to the list, the friend will be sent to the server.
* @param[in] list LinphoneFriendList object.
* @param[in] lf LinphoneFriend object to add to the friend list.
* @return LinphoneFriendListOK if successfully added, LinphoneFriendListInvalidFriend if the friend is not valid.
* @param[in] list #LinphoneFriendList object.
* @param[in] lf #LinphoneFriend object to add to the friend list.
* @return #LinphoneFriendListOK if successfully added, #LinphoneFriendListInvalidFriend if the friend is not valid.
**/
LINPHONE_PUBLIC LinphoneFriendListStatus linphone_friend_list_add_friend(LinphoneFriendList *list, LinphoneFriend *lf);
/**
* Add a friend to a friend list. The friend will never be sent to a remote CardDAV server.
* Warning! LinphoneFriends added this way will be removed on the next synchronization, and the callback contact_deleted will be called.
* @param[in] list LinphoneFriendList object.
* @param[in] lf LinphoneFriend object to add to the friend list.
* @return LinphoneFriendListOK if successfully added, LinphoneFriendListInvalidFriend if the friend is not valid.
* Warning! #LinphoneFriends added this way will be removed on the next synchronization, and the callback contact_deleted will be called.
* @param[in] list #LinphoneFriendList object.
* @param[in] lf #LinphoneFriend object to add to the friend list.
* @return #LinphoneFriendListOK if successfully added, #LinphoneFriendListInvalidFriend if the friend is not valid.
**/
LINPHONE_PUBLIC LinphoneFriendListStatus linphone_friend_list_add_local_friend(LinphoneFriendList *list, LinphoneFriend *lf);
/**
* Remove a friend from a friend list.
* @param[in] list LinphoneFriendList object.
* @param[in] lf LinphoneFriend object to remove from the friend list.
* @return LinphoneFriendListOK if removed successfully, LinphoneFriendListNonExistentFriend if the friend is not in the list.
* @param[in] list #LinphoneFriendList object.
* @param[in] lf #LinphoneFriend object to remove from the friend list.
* @return #LinphoneFriendListOK if removed successfully, #LinphoneFriendListNonExistentFriend if the friend is not in the list.
**/
LINPHONE_PUBLIC LinphoneFriendListStatus linphone_friend_list_remove_friend(LinphoneFriendList *list, LinphoneFriend *lf);
/**
* Retrieves the list of LinphoneFriend from this LinphoneFriendList.
* @param[in] list LinphoneFriendList object
* @return \bctbx_list{LinphoneFriend} a list of LinphoneFriend
* Retrieves the list of #LinphoneFriend from this LinphoneFriendList.
* @param[in] list #LinphoneFriendList object
* @return \bctbx_list{LinphoneFriend} a list of #LinphoneFriend
*/
LINPHONE_PUBLIC const bctbx_list_t * linphone_friend_list_get_friends(const LinphoneFriendList *list);
/**
* Find a friend in the friend list using a LinphoneAddress.
* @param[in] list LinphoneFriendList object.
* @param[in] address LinphoneAddress object of the friend we want to search for.
* @return A LinphoneFriend if found, NULL otherwise.
* @param[in] list #LinphoneFriendList object.
* @param[in] address #LinphoneAddress object of the friend we want to search for.
* @return A #LinphoneFriend if found, NULL otherwise.
**/
LINPHONE_PUBLIC LinphoneFriend * linphone_friend_list_find_friend_by_address(const LinphoneFriendList *list, const LinphoneAddress *address);
/**
* Find a friend in the friend list using an URI string.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @param[in] uri A string containing the URI of the friend we want to search for.
* @return A LinphoneFriend if found, NULL otherwise.
* @return A #LinphoneFriend if found, NULL otherwise.
**/
LINPHONE_PUBLIC LinphoneFriend * linphone_friend_list_find_friend_by_uri(const LinphoneFriendList *list, const char *uri);
/**
* Find a friend in the friend list using a ref key.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @param[in] ref_key The ref key string of the friend we want to search for.
* @return A LinphoneFriend if found, NULL otherwise.
* @return A #LinphoneFriend if found, NULL otherwise.
**/
LINPHONE_PUBLIC LinphoneFriend * linphone_friend_list_find_friend_by_ref_key(const LinphoneFriendList *list, const char *ref_key);
@ -168,174 +168,174 @@ LINPHONE_PUBLIC void linphone_friend_list_update_subscriptions(LinphoneFriendLis
/**
* Notify our presence to all the friends in the friend list that have subscribed to our presence directly (not using a RLS).
* @param[in] list LinphoneFriendList object.
* @param[in] presence LinphonePresenceModel object.
* @param[in] list #LinphoneFriendList object.
* @param[in] presence #LinphonePresenceModel object.
**/
LINPHONE_PUBLIC void linphone_friend_list_notify_presence(LinphoneFriendList *list, LinphonePresenceModel *presence);
/**
* Get the URI associated with the friend list.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @return The URI associated with the friend list.
**/
LINPHONE_PUBLIC const char * linphone_friend_list_get_uri(const LinphoneFriendList *list);
/**
* Set the URI associated with the friend list.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @param[in] uri The URI to associate with the friend list.
**/
LINPHONE_PUBLIC void linphone_friend_list_set_uri(LinphoneFriendList *list, const char *uri);
/**
* Sets the revision from the last synchronization.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
* @param[in] rev The revision
*/
LINPHONE_PUBLIC void linphone_friend_list_update_revision(LinphoneFriendList *list, int rev);
/**
* Get the LinphoneFriendListCbs object associated with a LinphoneFriendList.
* @param[in] list LinphoneFriendList object
* @return The LinphoneFriendListCbs object associated with the LinphoneFriendList.
* Get the #LinphoneFriendListCbs object associated with a LinphoneFriendList.
* @param[in] list #LinphoneFriendList object
* @return The #LinphoneFriendListCbs object associated with the LinphoneFriendList.
**/
LINPHONE_PUBLIC LinphoneFriendListCbs * linphone_friend_list_get_callbacks(const LinphoneFriendList *list);
/**
* Acquire a reference to a LinphoneFriendListCbs object.
* @param[in] cbs LinphoneFriendListCbs object.
* @return The same LinphoneFriendListCbs object.
* Acquire a reference to a #LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @return The same #LinphoneFriendListCbs object.
**/
LINPHONE_PUBLIC LinphoneFriendListCbs * linphone_friend_list_cbs_ref(LinphoneFriendListCbs *cbs);
/**
* Release a reference to a LinphoneFriendListCbs object.
* @param[in] cbs LinphoneFriendListCbs object.
* Release a reference to a #LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
**/
LINPHONE_PUBLIC void linphone_friend_list_cbs_unref(LinphoneFriendListCbs *cbs);
/**
* Retrieve the user pointer associated with a LinphoneFriendListCbs object.
* @param[in] cbs LinphoneFriendListCbs object.
* @return The user pointer associated with the LinphoneFriendListCbs object.
* Retrieve the user pointer associated with a #LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @return The user pointer associated with the #LinphoneFriendListCbs object.
**/
LINPHONE_PUBLIC void *linphone_friend_list_cbs_get_user_data(const LinphoneFriendListCbs *cbs);
/**
* Assign a user pointer to a LinphoneFriendListCbs object.
* @param[in] cbs LinphoneFriendListCbs object.
* @param[in] ud The user pointer to associate with the LinphoneFriendListCbs object.
* Assign a user pointer to a #LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @param[in] ud The user pointer to associate with the #LinphoneFriendListCbs object.
**/
LINPHONE_PUBLIC void linphone_friend_list_cbs_set_user_data(LinphoneFriendListCbs *cbs, void *ud);
/**
* Get the contact created callback.
* @param[in] cbs LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @return The current contact created callback.
**/
LINPHONE_PUBLIC LinphoneFriendListCbsContactCreatedCb linphone_friend_list_cbs_get_contact_created(const LinphoneFriendListCbs *cbs);
/**
* Set the contact created callback.
* @param[in] cbs LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @param[in] cb The contact created to be used.
**/
LINPHONE_PUBLIC void linphone_friend_list_cbs_set_contact_created(LinphoneFriendListCbs *cbs, LinphoneFriendListCbsContactCreatedCb cb);
/**
* Get the contact deleted callback.
* @param[in] cbs LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @return The current contact deleted callback.
**/
LINPHONE_PUBLIC LinphoneFriendListCbsContactDeletedCb linphone_friend_list_cbs_get_contact_deleted(const LinphoneFriendListCbs *cbs);
/**
* Set the contact deleted callback.
* @param[in] cbs LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @param[in] cb The contact deleted to be used.
**/
LINPHONE_PUBLIC void linphone_friend_list_cbs_set_contact_deleted(LinphoneFriendListCbs *cbs, LinphoneFriendListCbsContactDeletedCb cb);
/**
* Get the contact updated callback.
* @param[in] cbs LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @return The current contact updated callback.
**/
LINPHONE_PUBLIC LinphoneFriendListCbsContactUpdatedCb linphone_friend_list_cbs_get_contact_updated(const LinphoneFriendListCbs *cbs);
/**
* Set the contact updated callback.
* @param[in] cbs LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @param[in] cb The contact updated to be used.
**/
LINPHONE_PUBLIC void linphone_friend_list_cbs_set_contact_updated(LinphoneFriendListCbs *cbs, LinphoneFriendListCbsContactUpdatedCb cb);
/**
* Get the sync status changed callback.
* @param[in] cbs LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @return The current sync status changedcallback.
**/
LINPHONE_PUBLIC LinphoneFriendListCbsSyncStateChangedCb linphone_friend_list_cbs_get_sync_status_changed(const LinphoneFriendListCbs *cbs);
/**
* Set the contact updated callback.
* @param[in] cbs LinphoneFriendListCbs object.
* @param[in] cbs #LinphoneFriendListCbs object.
* @param[in] cb The sync status changed to be used.
**/
LINPHONE_PUBLIC void linphone_friend_list_cbs_set_sync_status_changed(LinphoneFriendListCbs *cbs, LinphoneFriendListCbsSyncStateChangedCb cb);
/**
* Starts a CardDAV synchronization using value set using linphone_friend_list_set_uri.
* @param[in] list LinphoneFriendList object.
* @param[in] list #LinphoneFriendList object.
*/
LINPHONE_PUBLIC void linphone_friend_list_synchronize_friends_from_server(LinphoneFriendList *list);
/**
* Goes through all the LinphoneFriend that are dirty and does a CardDAV PUT to update the server.
* @param[in] list LinphoneFriendList object.
* Goes through all the #LinphoneFriend that are dirty and does a CardDAV PUT to update the server.
* @param[in] list #LinphoneFriendList object.
*/
LINPHONE_PUBLIC void linphone_friend_list_update_dirty_friends(LinphoneFriendList *list);
/**
* Returns the LinphoneCore object attached to this LinphoneFriendList.
* @param[in] list LinphoneFriendList object.
* @return a LinphoneCore object
* Returns the #LinphoneCore object attached to this LinphoneFriendList.
* @param[in] list #LinphoneFriendList object.
* @return a #LinphoneCore object
*/
LINPHONE_PUBLIC LinphoneCore* linphone_friend_list_get_core(const LinphoneFriendList *list);
/**
* Creates and adds LinphoneFriend objects to LinphoneFriendList from a file that contains the vCard(s) to parse
* @param[in] list the LinphoneFriendList object
* Creates and adds #LinphoneFriend objects to #LinphoneFriendList from a file that contains the vCard(s) to parse
* @param[in] list the #LinphoneFriendList object
* @param[in] vcard_file the path to a file that contains the vCard(s) to parse
* @return the amount of linphone friends created
*/
LINPHONE_PUBLIC LinphoneStatus linphone_friend_list_import_friends_from_vcard4_file(LinphoneFriendList *list, const char *vcard_file);
/**
* Creates and adds LinphoneFriend objects to LinphoneFriendList from a buffer that contains the vCard(s) to parse
* @param[in] list the LinphoneFriendList object
* Creates and adds #LinphoneFriend objects to #LinphoneFriendList from a buffer that contains the vCard(s) to parse
* @param[in] list the #LinphoneFriendList object
* @param[in] vcard_buffer the buffer that contains the vCard(s) to parse
* @return the amount of linphone friends created
*/
LINPHONE_PUBLIC LinphoneStatus linphone_friend_list_import_friends_from_vcard4_buffer(LinphoneFriendList *list, const char *vcard_buffer);
/**
* Creates and export LinphoneFriend objects from LinphoneFriendList to a file using vCard 4 format
* @param[in] list the LinphoneFriendList object
* Creates and export #LinphoneFriend objects from #LinphoneFriendList to a file using vCard 4 format
* @param[in] list the #LinphoneFriendList object
* @param[in] vcard_file the path to a file that will contain the vCards
*/
LINPHONE_PUBLIC void linphone_friend_list_export_friends_as_vcard4_file(LinphoneFriendList *list, const char *vcard_file);
/**
* Enable subscription to NOTIFYes of all friends list
* @param[in] list the LinphoneFriendList object
* @param[in] list the #LinphoneFriendList object
* @param[in] enabled should subscription be enabled or not
*/
LINPHONE_PUBLIC void linphone_friend_list_enable_subscriptions(LinphoneFriendList *list, bool_t enabled);
/**
* Gets whether subscription to NOTIFYes of all friends list are enabled or not
* @param[in] list the LinphoneFriendList object
* @param[in] list the #LinphoneFriendList object
* @return Whether subscriptions are enabled or not
*/
LINPHONE_PUBLIC bool_t linphone_friend_list_subscriptions_enabled(LinphoneFriendList *list);

6
include/linphone/headers.h
View file

@ -46,7 +46,7 @@ LINPHONE_PUBLIC void linphone_headers_unref(LinphoneHeaders *obj);
/**
* Search for a given header name and return its value.
* @param obj the LinphoneHeaders object
* @param obj the #LinphoneHeaders object
* @param name the header's name
* @return the header's value or NULL if not found.
**/
@ -55,7 +55,7 @@ LINPHONE_PUBLIC const char* linphone_headers_get_value(LinphoneHeaders *obj, con
/**
* Add given header name and corresponding value.
* @param obj the LinphoneHeaders object
* @param obj the #LinphoneHeaders object
* @param name the header's name
* @param the header's value
**/
@ -63,7 +63,7 @@ LINPHONE_PUBLIC void linphone_headers_add(LinphoneHeaders *obj, const char *name
/**
* Add given header name and corresponding value.
* @param obj the LinphoneHeaders object
* @param obj the #LinphoneHeaders object
* @param name the header's name
* @param the header's value
**/

66
include/linphone/im_encryption_engine.h
View file

@ -33,30 +33,30 @@ extern "C" {
/**
* Acquire a reference to the LinphoneImEncryptionEngineCbs.
* @param[in] cbs LinphoneImEncryptionEngineCbs object.
* @return The same LinphoneImEncryptionEngineCbs object.
* @param[in] cbs #LinphoneImEncryptionEngineCbs object.
* @return The same #LinphoneImEncryptionEngineCbs object.
* @donotwrap
**/
LinphoneImEncryptionEngineCbs * linphone_im_encryption_engine_cbs_ref(LinphoneImEncryptionEngineCbs *cbs);
/**
* Release reference to the LinphoneImEncryptionEngineCbs.
* @param[in] cbs LinphoneImEncryptionEngineCbs object.
* @param[in] cbs #LinphoneImEncryptionEngineCbs object.
* @donotwrap
**/
void linphone_im_encryption_engine_cbs_unref(LinphoneImEncryptionEngineCbs *cbs);
/**
* Gets the user data in the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the LinphoneImEncryptionEngineCbs
* Gets the user data in the #LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs
* @return the user data
* @donotwrap
*/
LINPHONE_PUBLIC void *linphone_im_encryption_engine_cbs_get_user_data(const LinphoneImEncryptionEngineCbs *cbs);
/**
* Sets the user data in the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* Sets the user data in the #LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @param[in] data the user data
* @donotwrap
*/
@ -64,54 +64,54 @@ LINPHONE_PUBLIC void linphone_im_encryption_engine_cbs_set_user_data(LinphoneImE
/**
* Acquire a reference to the LinphoneImEncryptionEngine.
* @param[in] imee LinphoneImEncryptionEngine object.
* @return The same LinphoneImEncryptionEngine object.
* @param[in] imee #LinphoneImEncryptionEngine object.
* @return The same #LinphoneImEncryptionEngine object.
* @donotwrap
**/
LINPHONE_PUBLIC LinphoneImEncryptionEngine * linphone_im_encryption_engine_ref(LinphoneImEncryptionEngine *imee);
/**
* Release reference to the LinphoneImEncryptionEngine.
* @param[in] imee LinphoneImEncryptionEngine object.
* @param[in] imee #LinphoneImEncryptionEngine object.
* @donotwrap
**/
LINPHONE_PUBLIC void linphone_im_encryption_engine_unref(LinphoneImEncryptionEngine *imee);
/**
* Gets the user data in the LinphoneImEncryptionEngine object
* @param[in] imee the LinphoneImEncryptionEngine
* Gets the user data in the #LinphoneImEncryptionEngine object
* @param[in] imee the #LinphoneImEncryptionEngine
* @return the user data
* @donotwrap
*/
LINPHONE_PUBLIC void *linphone_im_encryption_engine_get_user_data(const LinphoneImEncryptionEngine *imee);
/**
* Sets the user data in the LinphoneImEncryptionEngine object
* @param[in] imee the LinphoneImEncryptionEngine object
* Sets the user data in the #LinphoneImEncryptionEngine object
* @param[in] imee the #LinphoneImEncryptionEngine object
* @param[in] data the user data
* @donotwrap
*/
LINPHONE_PUBLIC void linphone_im_encryption_engine_set_user_data(LinphoneImEncryptionEngine *imee, void *data);
/**
* Gets the LinphoneCore object that created the IM encryption engine
* @param[in] imee LinphoneImEncryptionEngine object
* @return The LinphoneCore object that created the IM encryption engine
* Gets the #LinphoneCore object that created the IM encryption engine
* @param[in] imee #LinphoneImEncryptionEngine object
* @return The #LinphoneCore object that created the IM encryption engine
* @donotwrap
*/
LINPHONE_PUBLIC LinphoneCore * linphone_im_encryption_engine_get_core(LinphoneImEncryptionEngine *imee);
/**
* Gets the LinphoneImEncryptionEngineCbs object that holds the callbacks
* @param[in] imee the LinphoneImEncryptionEngine object
* @return the LinphoneImEncryptionEngineCbs object
* Gets the #LinphoneImEncryptionEngineCbs object that holds the callbacks
* @param[in] imee the #LinphoneImEncryptionEngine object
* @return the #LinphoneImEncryptionEngineCbs object
* @donotwrap
*/
LINPHONE_PUBLIC LinphoneImEncryptionEngineCbs* linphone_im_encryption_engine_get_callbacks(const LinphoneImEncryptionEngine *imee);
/**
* Gets the callback that will decrypt the chat messages upon reception
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @return the callback
* @donotwrap
*/
@ -119,7 +119,7 @@ LINPHONE_PUBLIC LinphoneImEncryptionEngineCbsIncomingMessageCb linphone_im_encry
/**
* Sets the callback that will decrypt the chat messages upon reception
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @param[in] cb the callback to call
* @donotwrap
*/
@ -127,7 +127,7 @@ LINPHONE_PUBLIC void linphone_im_encryption_engine_cbs_set_process_incoming_mess
/**
* Gets the callback that will encrypt the chat messages before sending them
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @return the callback
* @donotwrap
*/
@ -135,7 +135,7 @@ LINPHONE_PUBLIC LinphoneImEncryptionEngineCbsOutgoingMessageCb linphone_im_encry
/**
* Sets the callback that will encrypt the chat messages before sending them
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @param[in] cb the callback to call
* @donotwrap
*/
@ -143,7 +143,7 @@ LINPHONE_PUBLIC void linphone_im_encryption_engine_cbs_set_process_outgoing_mess
/**
* Gets the callback that will decrypt the files while downloading them
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @return the callback
* @donotwrap
*/
@ -151,7 +151,7 @@ LINPHONE_PUBLIC LinphoneImEncryptionEngineCbsDownloadingFileCb linphone_im_encry
/**
* Sets the callback that will decrypt the files while downloading them
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @param[in] cb the callback to call
* @donotwrap
*/
@ -159,7 +159,7 @@ LINPHONE_PUBLIC void linphone_im_encryption_engine_cbs_set_process_downloading_f
/**
* Gets the callback that will will encrypt the files while uploading them
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @return the callback
* @donotwrap
*/
@ -167,7 +167,7 @@ LINPHONE_PUBLIC LinphoneImEncryptionEngineCbsUploadingFileCb linphone_im_encrypt
/**
* Sets the callback that will encrypt the files while uploading them
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @param[in] cb the callback to call
* @donotwrap
*/
@ -175,7 +175,7 @@ LINPHONE_PUBLIC void linphone_im_encryption_engine_cbs_set_process_uploading_fil
/**
* Gets the callback telling wheter or not to encrypt the files
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @return the callback
* @donotwrap
*/
@ -183,7 +183,7 @@ LINPHONE_PUBLIC LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferC
/**
* Sets the callback telling wheter or not to encrypt the files
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @param[in] cb the callback to call
* @donotwrap
*/
@ -191,7 +191,7 @@ LINPHONE_PUBLIC void linphone_im_encryption_engine_cbs_set_is_encryption_enabled
/**
* Gets the callback that will generate the key to encrypt the file before uploading it
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @return the callback
* @donotwrap
*/
@ -199,14 +199,14 @@ LINPHONE_PUBLIC LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb linphone_
/**
* Sets the callback that will generate the key to encrypt the file before uploading it
* @param[in] cbs the LinphoneImEncryptionEngineCbs object
* @param[in] cbs the #LinphoneImEncryptionEngineCbs object
* @param[in] cb the callback to call
* @donotwrap
*/
LINPHONE_PUBLIC void linphone_im_encryption_engine_cbs_set_generate_file_transfer_key(LinphoneImEncryptionEngineCbs *cbs, LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb cb);
/** Set a chat message text to be sent by #linphone_chat_room_send_message
* @param[in] msg LinphoneChatMessage
* @param[in] msg #LinphoneChatMessage
* @param[in] text Const char *
* @returns 0 if succeed.
* @donotwrap

50
include/linphone/im_notif_policy.h
View file

@ -35,124 +35,124 @@ extern "C" {
*/
/**
* Acquire a reference to the LinphoneImNotifPolicy object.
* @param[in] policy LinphoneImNotifPolicy object.
* @return The same LinphoneImNotifPolicy object.
* Acquire a reference to the #LinphoneImNotifPolicy object.
* @param[in] policy #LinphoneImNotifPolicy object.
* @return The same #LinphoneImNotifPolicy object.
**/
LINPHONE_PUBLIC LinphoneImNotifPolicy * linphone_im_notif_policy_ref(LinphoneImNotifPolicy *policy);
/**
* Release reference to the LinphoneImNotifPolicy object.
* @param[in] policy LinphoneImNotifPolicy object.
* Release reference to the #LinphoneImNotifPolicy object.
* @param[in] policy #LinphoneImNotifPolicy object.
**/
LINPHONE_PUBLIC void linphone_im_notif_policy_unref(LinphoneImNotifPolicy *policy);
/**
* Retrieve the user pointer associated with the LinphoneImNotifPolicy object.
* @param[in] policy LinphoneImNotifPolicy object.
* @return The user pointer associated with the LinphoneImNotifPolicy object.
* Retrieve the user pointer associated with the #LinphoneImNotifPolicy object.
* @param[in] policy #LinphoneImNotifPolicy object.
* @return The user pointer associated with the #LinphoneImNotifPolicy object.
**/
LINPHONE_PUBLIC void *linphone_im_notif_policy_get_user_data(const LinphoneImNotifPolicy *policy);
/**
* Assign a user pointer to the LinphoneImNotifPolicy object.
* @param[in] policy LinphoneImNotifPolicy object.
* @param[in] ud The user pointer to associate with the LinphoneImNotifPolicy object.
* Assign a user pointer to the #LinphoneImNotifPolicy object.
* @param[in] policy #LinphoneImNotifPolicy object.
* @param[in] ud The user pointer to associate with the #LinphoneImNotifPolicy object.
**/
LINPHONE_PUBLIC void linphone_im_notif_policy_set_user_data(LinphoneImNotifPolicy *policy, void *ud);
/**
* Clear an IM notif policy (deactivate all receiving and sending of notifications).
* @param[in] policy LinphoneImNotifPolicy object.
* @param[in] policy #LinphoneImNotifPolicy object.
*/
LINPHONE_PUBLIC void linphone_im_notif_policy_clear(LinphoneImNotifPolicy *policy);
/**
* Enable all receiving and sending of notifications.
* @param[in] policy LinphoneImNotifPolicy object.
* @param[in] policy #LinphoneImNotifPolicy object.
*/
LINPHONE_PUBLIC void linphone_im_notif_policy_enable_all(LinphoneImNotifPolicy *policy);
/**
* Tell whether is_composing notifications are being sent.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @return Boolean value telling whether is_composing notifications are being sent.
*/
LINPHONE_PUBLIC bool_t linphone_im_notif_policy_get_send_is_composing(const LinphoneImNotifPolicy *policy);
/**
* Enable is_composing notifications sending.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @param[in] enable Boolean value telling whether to send is_composing notifications.
*/
LINPHONE_PUBLIC void linphone_im_notif_policy_set_send_is_composing(LinphoneImNotifPolicy *policy, bool_t enable);
/**
* Tell whether is_composing notifications are being notified when received.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @return Boolean value telling whether is_composing notifications are being notified when received.
*/
LINPHONE_PUBLIC bool_t linphone_im_notif_policy_get_recv_is_composing(const LinphoneImNotifPolicy *policy);
/**
* Enable is_composing notifications receiving.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @param[in] enable Boolean value telling whether to notify received is_composing notifications.
*/
LINPHONE_PUBLIC void linphone_im_notif_policy_set_recv_is_composing(LinphoneImNotifPolicy *policy, bool_t enable);
/**
* Tell whether imdn delivered notifications are being sent.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @return Boolean value telling whether imdn delivered notifications are being sent.
*/
LINPHONE_PUBLIC bool_t linphone_im_notif_policy_get_send_imdn_delivered(const LinphoneImNotifPolicy *policy);
/**
* Enable imdn delivered notifications sending.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @param[in] enable Boolean value telling whether to send imdn delivered notifications.
*/
LINPHONE_PUBLIC void linphone_im_notif_policy_set_send_imdn_delivered(LinphoneImNotifPolicy *policy, bool_t enable);
/**
* Tell whether imdn delivered notifications are being notified when received.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @return Boolean value telling whether imdn delivered notifications are being notified when received.
*/
LINPHONE_PUBLIC bool_t linphone_im_notif_policy_get_recv_imdn_delivered(const LinphoneImNotifPolicy *policy);
/**
* Enable imdn delivered notifications receiving.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @param[in] enable Boolean value telling whether to notify received imdn delivered notifications.
*/
LINPHONE_PUBLIC void linphone_im_notif_policy_set_recv_imdn_delivered(LinphoneImNotifPolicy *policy, bool_t enable);
/**
* Tell whether imdn displayed notifications are being sent.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @return Boolean value telling whether imdn displayed notifications are being sent.
*/
LINPHONE_PUBLIC bool_t linphone_im_notif_policy_get_send_imdn_displayed(const LinphoneImNotifPolicy *policy);
/**
* Enable imdn displayed notifications sending.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @param[in] enable Boolean value telling whether to send imdn displayed notifications.
*/
LINPHONE_PUBLIC void linphone_im_notif_policy_set_send_imdn_displayed(LinphoneImNotifPolicy *policy, bool_t enable);
/**
* Tell whether imdn displayed notifications are being notified when received.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @return Boolean value telling whether imdn displayed notifications are being notified when received.
*/
LINPHONE_PUBLIC bool_t linphone_im_notif_policy_get_recv_imdn_displayed(const LinphoneImNotifPolicy *policy);
/**
* Enable imdn displayed notifications receiving.
* @param[in] policy LinphoneImNotifPolicy object
* @param[in] policy #LinphoneImNotifPolicy object
* @param[in] enable Boolean value telling whether to notify received imdn displayed notifications.
*/
LINPHONE_PUBLIC void linphone_im_notif_policy_set_recv_imdn_displayed(LinphoneImNotifPolicy *policy, bool_t enable);

2
include/linphone/info_message.h
View file

@ -55,7 +55,7 @@ LINPHONE_PUBLIC const char *linphone_info_message_get_header(const LinphoneInfoM
* Assign a content to the info message.
* @param im the linphone info message
* @param content the content described as a #LinphoneContent structure.
* All fields of the LinphoneContent are copied, thus the application can destroy/modify/recycloe the content object freely ater the function returns.
* All fields of the #LinphoneContent are copied, thus the application can destroy/modify/recycloe the content object freely ater the function returns.
**/
LINPHONE_PUBLIC void linphone_info_message_set_content(LinphoneInfoMessage *im, const LinphoneContent *content);

56
include/linphone/lpconfig.h
View file

@ -33,7 +33,7 @@
*/
/**
* Safely downcast a belle_sip_object into LinphoneConfig
* Safely downcast a belle_sip_object into #LinphoneConfig
*/
#define LINPHONE_CONFIG(obj) BELLE_SIP_CAST(obj, LinphoneConfig);
@ -42,59 +42,59 @@ extern "C" {
#endif
/**
* Instantiates a LinphoneConfig object from a user config file.
* 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.
* @ingroup misc
* @param filename the filename of the config file to read to fill the instantiated LinphoneConfig
* @param filename the filename of the config file to read to fill the instantiated #LinphoneConfig
* @see linphone_config_new_with_factory
*/
LINPHONE_PUBLIC LinphoneConfig * linphone_config_new(const char *filename);
/**
* Instantiates a LinphoneConfig object from a user provided 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.
* @ingroup misc
* @param buffer the buffer from which the LinphoneConfig will be retrieved. We expect the buffer to be null-terminated.
* @param buffer the buffer from which the #LinphoneConfig will be retrieved. We expect the buffer to be null-terminated.
* @see linphone_config_new_with_factory
* @see linphone_config_new
*/
LINPHONE_PUBLIC LinphoneConfig * linphone_config_new_from_buffer(const char *buffer);
/**
* Instantiates a LinphoneConfig object from a user config file and a factory config file.
* 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.
* @ingroup misc
* @param config_filename the filename of the user config file to read to fill the instantiated LinphoneConfig
* @param factory_config_filename the filename of the factory config file to read to fill the instantiated LinphoneConfig
* @param config_filename the filename of the user config file to read to fill the instantiated #LinphoneConfig
* @param factory_config_filename the filename of the factory config file to read to fill the instantiated #LinphoneConfig
* @see linphone_config_new
*
* The user config file is read first to fill the LinphoneConfig and then the factory config file is read.
* 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_PUBLIC LinphoneConfig * linphone_config_new_with_factory(const char *config_filename, const char *factory_config_filename);
/**
* Reads a user config file and fill the LinphoneConfig with the read config values.
* Reads a user config file and fill the #LinphoneConfig with the read config values.
* @ingroup misc
* @param lpconfig The LinphoneConfig object to fill with the content of the file
* @param filename The filename of the config file to read to fill the LinphoneConfig
* @param lpconfig The #LinphoneConfig object to fill with the content of the file
* @param filename The filename of the config file to read to fill the #LinphoneConfig
*/
LINPHONE_PUBLIC LinphoneStatus linphone_config_read_file(LinphoneConfig *lpconfig, const char *filename);
/**
* Reads a xml config file and fill the LinphoneConfig with the read config dynamic values.
* Reads a xml config file and fill the #LinphoneConfig with the read config dynamic values.
* @ingroup misc
* @param lpconfig The LinphoneConfig object to fill with the content of the file
* @param filename The filename of the config file to read to fill the LinphoneConfig
* @param lpconfig The #LinphoneConfig object to fill with the content of the file
* @param filename The filename of the config file to read to fill the #LinphoneConfig
*/
LINPHONE_PUBLIC const char* linphone_config_load_from_xml_file(LinphoneConfig *lpc, const char *filename);
/**
* Reads a xml config string and fill the LinphoneConfig with the read config dynamic values.
* Reads a xml config string and fill the #LinphoneConfig with the read config dynamic values.
* @ingroup misc
* @param lpconfig The LinphoneConfig object to fill with the content of the file
* @param buffer The string of the config file to fill the LinphoneConfig
* @param lpconfig The #LinphoneConfig object to fill with the content of the file
* @param buffer The string of the config file to fill the #LinphoneConfig
* @return 0 in case of success
*/
LINPHONE_PUBLIC LinphoneStatus linphone_config_load_from_xml_string(LpConfig *lpc, const char *buffer);
@ -214,7 +214,7 @@ LINPHONE_PUBLIC void linphone_config_clean_section(LinphoneConfig *lpconfig, con
/**
* Returns 1 if a given section with a given key is present in the configuration.
* @param[in] lpconfig The LinphoneConfig object
* @param[in] lpconfig The #LinphoneConfig object
* @param[in] section
* @param[in] key
**/
@ -222,7 +222,7 @@ LINPHONE_PUBLIC int linphone_config_has_entry(const LinphoneConfig *lpconfig, co
/**
* Removes entries for key,value in a section.
* @param[in] lpconfig The LinphoneConfig object
* @param[in] lpconfig The #LinphoneConfig object
* @param[in] section
* @param[in] key
**/
@ -230,7 +230,7 @@ LINPHONE_PUBLIC void linphone_config_clean_entry(LinphoneConfig *lpconfig, const
/**
* Returns the list of sections' names in the LinphoneConfig.
* @param[in] lpconfig The LinphoneConfig object
* @param[in] lpconfig The #LinphoneConfig object
* @return a null terminated static array of strings
* @deprecated use linphone_config_get_sections_names_list instead
* @donotwrap
@ -239,7 +239,7 @@ LINPHONE_PUBLIC const char** linphone_config_get_sections_names(LinphoneConfig *
/**
* Returns the list of sections' names in the LinphoneConfig.
* @param[in] lpconfig The LinphoneConfig object
* @param[in] lpconfig The #LinphoneConfig object
* @return \bctbx_list{char *} a null terminated static array of strings
**/
LINPHONE_PUBLIC const bctbx_list_t * linphone_config_get_sections_names_list(LpConfig *lpconfig);
@ -303,7 +303,7 @@ LINPHONE_PUBLIC void linphone_config_unref(LinphoneConfig *lpconfig);
/**
* Write a string in a file placed relatively with the Linphone configuration file.
* @param lpconfig LinphoneConfig instance used as a reference
* @param lpconfig #LinphoneConfig instance used as a reference
* @param filename Name of the file where to write data. The name is relative to the place of the config file
* @param data String to write
*/
@ -311,7 +311,7 @@ LINPHONE_PUBLIC void linphone_config_write_relative_file(const LinphoneConfig *l
/**
* Read a string from a file placed beside the Linphone configuration file
* @param lpconfig LinphoneConfig instance used as a reference
* @param lpconfig #LinphoneConfig instance used as a reference
* @param filename Name of the file where data will be read from. The name is relative to the place of the config file
* @param data Buffer where read string will be stored
* @param max_length Length of the buffer
@ -326,15 +326,15 @@ LINPHONE_PUBLIC LinphoneStatus linphone_config_read_relative_file(const Linphone
LINPHONE_PUBLIC bool_t linphone_config_relative_file_exists(const LinphoneConfig *lpconfig, const char *filename);
/**
* Dumps the LinphoneConfig as XML into a buffer
* @param[in] lpconfig The LinphoneConfig object
* Dumps the #LinphoneConfig as XML into a buffer
* @param[in] lpconfig The #LinphoneConfig object
* @return The buffer that contains the XML dump
**/
LINPHONE_PUBLIC char* linphone_config_dump_as_xml(const LinphoneConfig *lpconfig);
/**
* Dumps the LinphoneConfig as INI into a buffer
* @param[in] lpconfig The LinphoneConfig object
* Dumps the #LinphoneConfig as INI into a buffer
* @param[in] lpconfig The #LinphoneConfig object
* @return The buffer that contains the config dump
**/
LINPHONE_PUBLIC char* linphone_config_dump(const LinphoneConfig *lpconfig);

44
include/linphone/misc.h
View file

@ -102,9 +102,9 @@ LINPHONE_PUBLIC const char *linphone_configuring_state_to_string(LinphoneConfigu
LINPHONE_PUBLIC const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
/**
* Converts a LinphoneReason enum to a string.
* Converts a #LinphoneReason enum to a string.
* @param[in] err A #LinphoneReason
* @return The string representation of the specified LinphoneReason
* @return The string representation of the specified #LinphoneReason
* @ingroup misc
**/
LINPHONE_PUBLIC const char *linphone_reason_to_string(LinphoneReason err);
@ -118,10 +118,10 @@ LINPHONE_PUBLIC const char *linphone_reason_to_string(LinphoneReason err);
LINPHONE_PUBLIC LINPHONE_DEPRECATED const char *linphone_online_status_to_string(LinphoneOnlineStatus ss);
/**
* Convert a string into LinphoneTunnelMode enum
* Convert a string into #LinphoneTunnelMode enum
* @param string String to convert
* @return An LinphoneTunnelMode enum. If the passed string is NULL or
* does not match with any mode, the LinphoneTunnelModeDisable is returned.
* @return An #LinphoneTunnelMode enum. If the passed string is NULL or
* does not match with any mode, the #LinphoneTunnelModeDisable is returned.
*/
LINPHONE_PUBLIC LinphoneTunnelMode linphone_tunnel_mode_from_string(const char *string);
@ -139,59 +139,59 @@ LINPHONE_PUBLIC const char *linphone_tunnel_mode_to_string(LinphoneTunnelMode mo
LINPHONE_PUBLIC bool_t linphone_local_player_matroska_supported(void);
/**
* Converts a LinphoneTransportType enum to a lowercase string.
* Converts a #LinphoneTransportType enum to a lowercase string.
* @ingroup misc
**/
LINPHONE_PUBLIC const char* linphone_transport_to_string(LinphoneTransportType transport);
/**
* Converts a lowercase string to a LinphoneTransportType enum.
* Converts a lowercase string to a #LinphoneTransportType enum.
* @ingroup misc
* @return Transport matching input, or LinphoneTransportUdp if nothing is found
* @return Transport matching input, or #LinphoneTransportUdp if nothing is found
**/
LINPHONE_PUBLIC LinphoneTransportType linphone_transport_parse(const char* transport);
/**
* Converts an error code to a LinphoneReason.
* @param[in] err An error code
* @return The LinphoneReason corresponding to the specified error code
* @return The #LinphoneReason corresponding to the specified error code
* @ingroup misc
**/
LINPHONE_PUBLIC LinphoneReason linphone_error_code_to_reason(int err);
/**
* Converts a LinphoneReason to an error code.
* @param[in] reason A LinphoneReason
* @return The error code corresponding to the specified LinphoneReason
* Converts a #LinphoneReason to an error code.
* @param[in] reason A #LinphoneReason
* @return The error code corresponding to the specified #LinphoneReason
* @ingroup misc
*/
LINPHONE_PUBLIC int linphone_reason_to_error_code(LinphoneReason reason);
/**
* Increment refcount.
* @param[in] range LinphoneRange object
* @param[in] range #LinphoneRange object
* @ingroup misc
**/
LINPHONE_PUBLIC LinphoneRange *linphone_range_ref(LinphoneRange *range);
/**
* Decrement refcount and possibly free the object.
* @param[in] range LinphoneRange object
* @param[in] range #LinphoneRange object
* @ingroup misc
**/
LINPHONE_PUBLIC void linphone_range_unref(LinphoneRange *range);
/**
* Gets the user data in the LinphoneRange object
* @param[in] range the LinphoneRange
* Gets the user data in the #LinphoneRange object
* @param[in] range the #LinphoneRange
* @return the user data
* @ingroup misc
*/
LINPHONE_PUBLIC void *linphone_range_get_user_data(const LinphoneRange *range);
/**
* Sets the user data in the LinphoneRange object
* @param[in] range the LinphoneRange object
* Sets the user data in the #LinphoneRange object
* @param[in] range the #LinphoneRange object
* @param[in] data the user data
* @ingroup misc
*/
@ -199,7 +199,7 @@ LINPHONE_PUBLIC void linphone_range_set_user_data(LinphoneRange *range, void *da
/**
* Gets the lower value of the range
* @param[in] range a LinphoneRange
* @param[in] range a #LinphoneRange
* @return The lower value
* @ingroup misc
*/
@ -207,7 +207,7 @@ LINPHONE_PUBLIC int linphone_range_get_min(const LinphoneRange *range);
/**
* Gets the higher value of the range
* @param[in] range a LinphoneRange
* @param[in] range a #LinphoneRange
* @return The higher value
* @ingroup misc
*/
@ -215,7 +215,7 @@ LINPHONE_PUBLIC int linphone_range_get_max(const LinphoneRange *range);
/**
* Sets the lower value of the range
* @param[in] range a LinphoneRange
* @param[in] range a #LinphoneRange
* @param[in] min the value to set
* @ingroup misc
*/
@ -223,7 +223,7 @@ LINPHONE_PUBLIC void linphone_range_set_min(LinphoneRange *range, int min);
/**
* Sets the higher value of the range
* @param[in] range a LinphoneRange
* @param[in] range a #LinphoneRange
* @param[in] max the value to set
* @ingroup misc
*/

64
include/linphone/nat_policy.h
View file

@ -35,41 +35,41 @@ extern "C" {
*/
/**
* Acquire a reference to the LinphoneNatPolicy object.
* @param[in] policy LinphoneNatPolicy object.
* @return The same LinphoneNatPolicy object.
* Acquire a reference to the #LinphoneNatPolicy object.
* @param[in] policy #LinphoneNatPolicy object.
* @return The same #LinphoneNatPolicy object.
**/
LINPHONE_PUBLIC LinphoneNatPolicy * linphone_nat_policy_ref(LinphoneNatPolicy *policy);
/**
* Release reference to the LinphoneNatPolicy object.
* @param[in] policy LinphoneNatPolicy object.
* Release reference to the #LinphoneNatPolicy object.
* @param[in] policy #LinphoneNatPolicy object.
**/
LINPHONE_PUBLIC void linphone_nat_policy_unref(LinphoneNatPolicy *policy);
/**
* Retrieve the user pointer associated with the LinphoneNatPolicy object.
* @param[in] policy LinphoneNatPolicy object.
* @return The user pointer associated with the LinphoneNatPolicy object.
* Retrieve the user pointer associated with the #LinphoneNatPolicy object.
* @param[in] policy #LinphoneNatPolicy object.
* @return The user pointer associated with the #LinphoneNatPolicy object.
**/
LINPHONE_PUBLIC void *linphone_nat_policy_get_user_data(const LinphoneNatPolicy *policy);
/**
* Assign a user pointer to the LinphoneNatPolicy object.
* @param[in] policy LinphoneNatPolicy object.
* @param[in] ud The user pointer to associate with the LinphoneNatPolicy object.
* Assign a user pointer to the #LinphoneNatPolicy object.
* @param[in] policy #LinphoneNatPolicy object.
* @param[in] ud The user pointer to associate with the #LinphoneNatPolicy object.
**/
LINPHONE_PUBLIC void linphone_nat_policy_set_user_data(LinphoneNatPolicy *policy, void *ud);
/**
* Clear a NAT policy (deactivate all protocols and unset the STUN server).
* @param[in] policy LinphoneNatPolicy object.
* @param[in] policy #LinphoneNatPolicy object.
*/
LINPHONE_PUBLIC void linphone_nat_policy_clear(LinphoneNatPolicy *policy);
/**
* Tell whether STUN is enabled.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @return Boolean value telling whether STUN is enabled.
*/
LINPHONE_PUBLIC bool_t linphone_nat_policy_stun_enabled(const LinphoneNatPolicy *policy);
@ -77,14 +77,14 @@ LINPHONE_PUBLIC bool_t linphone_nat_policy_stun_enabled(const LinphoneNatPolicy
/**
* Enable STUN.
* If TURN is also enabled, TURN will be used instead of STUN.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @param[in] enable Boolean value telling whether to enable STUN.
*/
LINPHONE_PUBLIC void linphone_nat_policy_enable_stun(LinphoneNatPolicy *policy, bool_t enable);
/**
* Tell whether TURN is enabled.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @return Boolean value telling whether TURN is enabled.
*/
LINPHONE_PUBLIC bool_t linphone_nat_policy_turn_enabled(const LinphoneNatPolicy *policy);
@ -92,14 +92,14 @@ LINPHONE_PUBLIC bool_t linphone_nat_policy_turn_enabled(const LinphoneNatPolicy
/**
* Enable TURN.
* If STUN is also enabled, it is ignored and TURN is used.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @param[in] enable Boolean value telling whether to enable TURN.
*/
LINPHONE_PUBLIC void linphone_nat_policy_enable_turn(LinphoneNatPolicy *policy, bool_t enable);
/**
* Tell whether ICE is enabled.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @return Boolean value telling whether ICE is enabled.
*/
LINPHONE_PUBLIC bool_t linphone_nat_policy_ice_enabled(const LinphoneNatPolicy *policy);
@ -107,14 +107,14 @@ LINPHONE_PUBLIC bool_t linphone_nat_policy_ice_enabled(const LinphoneNatPolicy *
/**
* Enable ICE.
* ICE can be enabled without STUN/TURN, in which case only the local candidates will be used.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @param[in] enable Boolean value telling whether to enable ICE.
*/
LINPHONE_PUBLIC void linphone_nat_policy_enable_ice(LinphoneNatPolicy *policy, bool_t enable);
/**
* Tell whether uPnP is enabled.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @return Boolean value telling whether uPnP is enabled.
*/
LINPHONE_PUBLIC bool_t linphone_nat_policy_upnp_enabled(const LinphoneNatPolicy *policy);
@ -122,7 +122,7 @@ LINPHONE_PUBLIC bool_t linphone_nat_policy_upnp_enabled(const LinphoneNatPolicy
/**
* Enable uPnP.
* This has the effect to disable every other policies (ICE, STUN and TURN).
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @param[in] enable Boolean value telling whether to enable uPnP.
*/
LINPHONE_PUBLIC void linphone_nat_policy_enable_upnp(LinphoneNatPolicy *policy, bool_t enable);
@ -130,7 +130,7 @@ LINPHONE_PUBLIC void linphone_nat_policy_enable_upnp(LinphoneNatPolicy *policy,
/**
* Get the STUN/TURN server to use with this NAT policy.
* Used when STUN or TURN are enabled.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @return The STUN server used by this NAT policy.
*/
LINPHONE_PUBLIC const char * linphone_nat_policy_get_stun_server(const LinphoneNatPolicy *policy);
@ -138,47 +138,47 @@ LINPHONE_PUBLIC const char * linphone_nat_policy_get_stun_server(const LinphoneN
/**
* Set the STUN/TURN server to use with this NAT policy.
* Used when STUN or TURN are enabled.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @param[in] stun_server The STUN server to use with this NAT policy.
*/
LINPHONE_PUBLIC void linphone_nat_policy_set_stun_server(LinphoneNatPolicy *policy, const char *stun_server);
/**
* Get the username used to authenticate with the STUN/TURN server.
* The authentication will search for a LinphoneAuthInfo with this username.
* If it is not set the username of the currently used LinphoneProxyConfig is used to search for a LinphoneAuthInfo.
* @param[in] policy LinphoneNatPolicy object
* The authentication will search for a #LinphoneAuthInfo with this username.
* If it is not set the username of the currently used #LinphoneProxyConfig is used to search for a LinphoneAuthInfo.
* @param[in] policy #LinphoneNatPolicy object
* @return The username used to authenticate with the STUN/TURN server.
*/
LINPHONE_PUBLIC const char * linphone_nat_policy_get_stun_server_username(const LinphoneNatPolicy *policy);
/**
* Set the username used to authenticate with the STUN/TURN server.
* The authentication will search for a LinphoneAuthInfo with this username.
* If it is not set the username of the currently used LinphoneProxyConfig is used to search for a LinphoneAuthInfo.
* @param[in] policy LinphoneNatPolicy object
* The authentication will search for a #LinphoneAuthInfo with this username.
* If it is not set the username of the currently used #LinphoneProxyConfig is used to search for a LinphoneAuthInfo.
* @param[in] policy #LinphoneNatPolicy object
* @param[in] username The username used to authenticate with the STUN/TURN server.
*/
LINPHONE_PUBLIC void linphone_nat_policy_set_stun_server_username(LinphoneNatPolicy *policy, const char *username);
/**
* Start a STUN server DNS resolution.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
*/
LINPHONE_PUBLIC void linphone_nat_policy_resolve_stun_server(LinphoneNatPolicy *policy);
/**
* Get the addrinfo representation of the STUN server address.
* WARNING: This function may block for up to 1 second.
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @return addrinfo representation of the STUN server address.
* @donotwrap
*/
LINPHONE_PUBLIC const struct addrinfo * linphone_nat_policy_get_stun_server_addrinfo(LinphoneNatPolicy *policy);
/**
* Returns the LinphoneCore object managing this nat policy, if any.
* @param[in] fr LinphoneNatPolicy object
* Returns the #LinphoneCore object managing this nat policy, if any.
* @param[in] fr #LinphoneNatPolicy object
*/
LINPHONE_PUBLIC LinphoneCore *linphone_nat_policy_get_core(const LinphoneNatPolicy *policy);

2
include/linphone/payload_type.h
View file

@ -114,7 +114,7 @@ LINPHONE_PUBLIC int linphone_payload_type_get_channels(const LinphonePayloadType
LINPHONE_PUBLIC int linphone_payload_type_get_number(const LinphonePayloadType *pt);
/**
* Force a number for a payload type. The LinphoneCore does payload type number assignment automatically.
* Force a number for a payload type. The #LinphoneCore does payload type number assignment automatically.
* This function is mainly to be used for tests, in order to override the automatic assignment mechanism.
* @param[in] pt The payload type.
* @param[in] number The number to assign to the payload type.

62
include/linphone/player.h
View file

@ -37,62 +37,62 @@ extern "C" {
/**
* Acquire a reference to the player.
* @param[in] player LinphonePlayer object.
* @return The same LinphonePlayer object.
* @param[in] player #LinphonePlayer object.
* @return The same #LinphonePlayer object.
**/
LINPHONE_PUBLIC LinphonePlayer * linphone_player_ref(LinphonePlayer *player);
/**
* Release reference to the player.
* @param[in] player LinphonePlayer object.
* @param[in] player #LinphonePlayer object.
**/
LINPHONE_PUBLIC void linphone_player_unref(LinphonePlayer *player);
/**
* Retrieve the user pointer associated with the player.
* @param[in] player LinphonePlayer object.
* @param[in] player #LinphonePlayer object.
* @return The user pointer associated with the player.
**/
LINPHONE_PUBLIC void *linphone_player_get_user_data(const LinphonePlayer *player);
/**
* Assign a user pointer to the player.
* @param[in] player LinphonePlayer object.
* @param[in] player #LinphonePlayer object.
* @param[in] ud The user pointer to associate with the player.
**/
LINPHONE_PUBLIC void linphone_player_set_user_data(LinphonePlayer *player, void *ud);
/**
* Get the LinphonePlayerCbs object associated with the LinphonePlayer.
* @param[in] player LinphonePlayer object
* @return The LinphonePlayerCbs object associated with the LinphonePlayer.
* Get the #LinphonePlayerCbs object associated with the LinphonePlayer.
* @param[in] player #LinphonePlayer object
* @return The #LinphonePlayerCbs object associated with the LinphonePlayer.
*/
LINPHONE_PUBLIC LinphonePlayerCbs * linphone_player_get_callbacks(const LinphonePlayer *player);
/**
* Open a file for playing.
* @param[in] obj LinphonePlayer object
* @param[in] obj #LinphonePlayer object
* @param[in] filename The path to the file to open
*/
LINPHONE_PUBLIC LinphoneStatus linphone_player_open(LinphonePlayer *obj, const char *filename);
/**
* Start playing a file that has been opened with linphone_player_open().
* @param[in] obj LinphonePlayer object
* @param[in] obj #LinphonePlayer object
* @return 0 on success, a negative value otherwise
*/
LINPHONE_PUBLIC LinphoneStatus linphone_player_start(LinphonePlayer *obj);
/**
* Pause the playing of a file.
* @param[in] obj LinphonePlayer object
* @param[in] obj #LinphonePlayer object
* @return 0 on success, a negative value otherwise
*/
LINPHONE_PUBLIC LinphoneStatus linphone_player_pause(LinphonePlayer *obj);
/**
* Seek in an opened file.
* @param[in] obj LinphonePlayer object
* @param[in] obj #LinphonePlayer object
* @param[in] time_ms The time we want to go to in the file (in milliseconds).
* @return 0 on success, a negative value otherwise.
*/
@ -100,74 +100,74 @@ LINPHONE_PUBLIC LinphoneStatus linphone_player_seek(LinphonePlayer *obj, int tim
/**
* Get the current state of a player.
* @param[in] obj LinphonePlayer object
* @param[in] obj #LinphonePlayer object
* @return The current state of the player.
*/
LINPHONE_PUBLIC LinphonePlayerState linphone_player_get_state(LinphonePlayer *obj);
/**
* Get the duration of the opened file.
* @param[in] obj LinphonePlayer object
* @param[in] obj #LinphonePlayer object
* @return The duration of the opened file
*/
LINPHONE_PUBLIC int linphone_player_get_duration(LinphonePlayer *obj);
/**
* Get the current position in the opened file.
* @param[in] obj LinphonePlayer object
* @param[in] obj #LinphonePlayer object
* @return The current position in the opened file
*/
LINPHONE_PUBLIC int linphone_player_get_current_position(LinphonePlayer *obj);
/**
* Close the opened file.
* @param[in] obj LinphonePlayer object
* @param[in] obj #LinphonePlayer object
*/
LINPHONE_PUBLIC void linphone_player_close(LinphonePlayer *obj);
/**
* Returns the LinphoneCore object managing this player's call, if any.
* @param[in] fr LinphonePlayer object
* Returns the #LinphoneCore object managing this player's call, if any.
* @param[in] fr #LinphonePlayer object
*/
LINPHONE_PUBLIC LinphoneCore *linphone_player_get_core(const LinphonePlayer *player);
/**
* Acquire a reference to the LinphonePlayerCbs object.
* @param[in] cbs LinphonePlayerCbs object.
* @return The same LinphonePlayerCbs object.
* Acquire a reference to the #LinphonePlayerCbs object.
* @param[in] cbs #LinphonePlayerCbs object.
* @return The same #LinphonePlayerCbs object.
*/
LINPHONE_PUBLIC LinphonePlayerCbs * linphone_player_cbs_ref(LinphonePlayerCbs *cbs);
/**
* Release reference to the LinphonePlayerCbs object.
* @param[in] cbs LinphonePlayerCbs object.
* Release reference to the #LinphonePlayerCbs object.
* @param[in] cbs #LinphonePlayerCbs object.
*/
LINPHONE_PUBLIC void linphone_player_cbs_unref(LinphonePlayerCbs *cbs);
/**
* Retrieve the user pointer associated with the LinphonePlayerCbs object.
* @param[in] cbs LinphonePlayerCbs object.
* @return The user pointer associated with the LinphonePlayerCbs object.
* Retrieve the user pointer associated with the #LinphonePlayerCbs object.
* @param[in] cbs #LinphonePlayerCbs object.
* @return The user pointer associated with the #LinphonePlayerCbs object.
*/
LINPHONE_PUBLIC void *linphone_player_cbs_get_user_data(const LinphonePlayerCbs *cbs);
/**
* Assign a user pointer to the LinphonePlayerCbs object.
* @param[in] cbs LinphonePlayerCbs object.
* @param[in] ud The user pointer to associate with the LinphonePlayerCbs object.
* Assign a user pointer to the #LinphonePlayerCbs object.
* @param[in] cbs #LinphonePlayerCbs object.
* @param[in] ud The user pointer to associate with the #LinphonePlayerCbs object.
*/
LINPHONE_PUBLIC void linphone_player_cbs_set_user_data(LinphonePlayerCbs *cbs, void *ud);
/**
* Get the end-of-file reached callback.
* @param[in] cbs LinphonePlayerCbs object.
* @param[in] cbs #LinphonePlayerCbs object.
* @return The current end-of-file reached callback.
*/
LINPHONE_PUBLIC LinphonePlayerCbsEofReachedCb linphone_player_cbs_get_eof_reached(const LinphonePlayerCbs *cbs);
/**
* Set the end-of-file reached callback.
* @param[in] cbs LinphonePlayerCbs object.
* @param[in] cbs #LinphonePlayerCbs object.
* @param[in] cb The end-of-file reached callback to be used.
*/
LINPHONE_PUBLIC void linphone_player_cbs_set_eof_reached(LinphonePlayerCbs *cbs, LinphonePlayerCbsEofReachedCb cb);

8
include/linphone/presence.h
View file

@ -197,8 +197,8 @@ LINPHONE_PUBLIC LinphoneStatus linphone_presence_model_clear_notes(LinphonePrese
/**
* Get the consolidated presence from a presence model.
* @param[in] model LinphonePresenceModel object
* @return The LinphoneConsolidatedPresence corresponding to the presence model
* @param[in] model #LinphonePresenceModel object
* @return The #LinphoneConsolidatedPresence corresponding to the presence model
*/
LINPHONE_PUBLIC LinphoneConsolidatedPresence linphone_presence_model_get_consolidated_presence(const LinphonePresenceModel *model);
@ -282,7 +282,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_presence_model_clear_persons(LinphonePre
* It is any of theses cases:
* - basic status is'open' and no activities
* - explicit 'online' tag in the status
* @param[in] model LinphonePresenceModel object
* @param[in] model #LinphonePresenceModel object
* @return A boolean value telling whether the presence model is considered online or not.
*/
LINPHONE_PUBLIC bool_t linphone_presence_model_is_online(const LinphonePresenceModel *model);
@ -294,7 +294,7 @@ LINPHONE_PUBLIC bool_t linphone_presence_model_is_online(const LinphonePresenceM
/**
* Gets the string representation of a presence basic status.
* @param[in] basic_status A LinphonePresenceBasicStatus for which to get a string representation.
* @param[in] basic_status A #LinphonePresenceBasicStatus for which to get a string representation.
* @return A pointer a dynamically allocated string representing the given basic status.
*
* The returned string is to be freed by calling ms_free().

12
include/linphone/proxy_config.h
View file

@ -388,7 +388,7 @@ LINPHONE_PUBLIC const char* linphone_proxy_config_get_transport(const LinphonePr
/**
* Destroys a proxy config.
* @note: LinphoneProxyConfig that have been removed from LinphoneCore with
* @note: #LinphoneProxyConfig that have been removed from #LinphoneCore with
* linphone_core_remove_proxy_config() must not be freed.
* @deprecated
* @donotwrap
@ -449,7 +449,7 @@ LINPHONE_PUBLIC LinphoneAddress* linphone_proxy_config_normalize_sip_uri(Linphon
/**
* Set default privacy policy for all calls routed through this proxy.
* @param[in] cfg #LinphoneProxyConfig object.
* @param privacy LinphonePrivacy to configure privacy
* @param privacy #LinphonePrivacy to configure privacy
* */
LINPHONE_PUBLIC void linphone_proxy_config_set_privacy(LinphoneProxyConfig *cfg, LinphonePrivacyMask privacy);
@ -511,14 +511,14 @@ LINPHONE_PUBLIC uint8_t linphone_proxy_config_get_avpf_rr_interval(const Linphon
/**
* Get enablement status of RTCP feedback (also known as AVPF profile).
* @param[in] cfg #LinphoneProxyConfig object.
* @return the enablement mode, which can be LinphoneAVPFDefault (use LinphoneCore's mode), LinphoneAVPFEnabled (avpf is enabled), or LinphoneAVPFDisabled (disabled).
* @return the enablement mode, which can be #LinphoneAVPFDefault (use LinphoneCore's mode), #LinphoneAVPFEnabled (avpf is enabled), or #LinphoneAVPFDisabled (disabled).
**/
LINPHONE_PUBLIC LinphoneAVPFMode linphone_proxy_config_get_avpf_mode(const LinphoneProxyConfig *cfg);
/**
* Enable the use of RTCP feedback (also known as AVPF profile).
* @param[in] cfg #LinphoneProxyConfig object.
* @param[in] mode the enablement mode, which can be LinphoneAVPFDefault (use LinphoneCore's mode), LinphoneAVPFEnabled (avpf is enabled), or LinphoneAVPFDisabled (disabled).
* @param[in] mode the enablement mode, which can be #LinphoneAVPFDefault (use LinphoneCore's mode), #LinphoneAVPFEnabled (avpf is enabled), or #LinphoneAVPFDisabled (disabled).
**/
LINPHONE_PUBLIC void linphone_proxy_config_set_avpf_mode(LinphoneProxyConfig *cfg, LinphoneAVPFMode mode);
@ -571,7 +571,7 @@ LINPHONE_PUBLIC void linphone_proxy_config_set_ref_key(LinphoneProxyConfig *cfg,
* Get The policy that is used to pass through NATs/firewalls when using this proxy config.
* If it is set to NULL, the default NAT policy from the core will be used instead.
* @param[in] cfg #LinphoneProxyConfig object
* @return LinphoneNatPolicy object in use.
* @return #LinphoneNatPolicy object in use.
* @see linphone_core_get_nat_policy()
*/
LINPHONE_PUBLIC LinphoneNatPolicy * linphone_proxy_config_get_nat_policy(const LinphoneProxyConfig *cfg);
@ -580,7 +580,7 @@ LINPHONE_PUBLIC LinphoneNatPolicy * linphone_proxy_config_get_nat_policy(const L
* Set the policy to use to pass through NATs/firewalls when using this proxy config.
* If it is set to NULL, the default NAT policy from the core will be used instead.
* @param[in] cfg #LinphoneProxyConfig object
* @param[in] policy LinphoneNatPolicy object
* @param[in] policy #LinphoneNatPolicy object
* @see linphone_core_set_nat_policy()
*/
LINPHONE_PUBLIC void linphone_proxy_config_set_nat_policy(LinphoneProxyConfig *cfg, LinphoneNatPolicy *policy);

2
include/linphone/ringtoneplayer.h
View file

@ -35,7 +35,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_ringtoneplayer_start(MSFactory *factory,
/**
* Start a ringtone player
* @param factory A MSFactory object
* @param rp LinphoneRingtonePlayer object
* @param rp #LinphoneRingtonePlayer object
* @param card unused argument
* @param ringtone path to the ringtone to play
* @param loop_pause_ms pause interval in milliseconds to be observed between end of play and resuming at start. A value of -1 disables loop mode

78
include/linphone/tunnel.h
View file

@ -37,13 +37,13 @@
/**
* Linphone tunnel aims is to bypass IP traffic blocking due to aggressive firewalls which typically only authorize TCP traffic with destination port 443.
* <br> Its principle is tunneling all SIP and/or RTP traffic through a single secure https connection up to a detunnelizer server.
* <br> This set of methods enhance LinphoneCore functionalities in order to provide an easy to use API to
* <br> This set of methods enhance #LinphoneCore functionalities in order to provide an easy to use API to
* \li provision tunnel servers IP addresses and ports. This functionality is an option not implemented under GPL. Availability can be check at runtime using function #linphone_core_tunnel_available
* \li start/stop the tunneling service
* \li perform auto-detection whether tunneling is required, based on a test of sending/receiving a flow of UDP packets.
*
* It takes in charge automatically the SIP registration procedure when connecting or disconnecting to a tunnel server.
* No other action on LinphoneCore is required to enable full operation in tunnel mode.
* No other action on #LinphoneCore is required to enable full operation in tunnel mode.
*
* <br> Provision is done using object #LinphoneTunnelConfig created by function #linphone_tunnel_config_new(). Functions #linphone_tunnel_config_set_host
* and #linphone_tunnel_config_set_port allow to point to tunnel server IP/port. Once set, use function #linphone_tunnel_add_server to provision a tunnel server.
@ -108,56 +108,56 @@ LINPHONE_PUBLIC void linphone_tunnel_unref(LinphoneTunnel *tunnel);
/**
* Set the IP address or hostname of the tunnel server.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @param host The tunnel server IP address or hostname
*/
LINPHONE_PUBLIC void linphone_tunnel_config_set_host(LinphoneTunnelConfig *tunnel, const char *host);
/**
* Get the IP address or hostname of the tunnel server.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @return The tunnel server IP address or hostname
*/
LINPHONE_PUBLIC const char *linphone_tunnel_config_get_host(const LinphoneTunnelConfig *tunnel);
/**
* Set tls port of server.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @param port The tunnel server TLS port, recommended value is 443
*/
LINPHONE_PUBLIC void linphone_tunnel_config_set_port(LinphoneTunnelConfig *tunnel, int port);
/**
* Get the TLS port of the tunnel server.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @return The TLS port of the tunnel server
*/
LINPHONE_PUBLIC int linphone_tunnel_config_get_port(const LinphoneTunnelConfig *tunnel);
/**
* Set the IP address or hostname of the second tunnel server when using dual tunnel client.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @param host The tunnel server IP address or hostname
*/
LINPHONE_PUBLIC void linphone_tunnel_config_set_host2(LinphoneTunnelConfig *tunnel, const char *host);
/**
* Get the IP address or hostname of the second tunnel server when using dual tunnel client.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @return The tunnel server IP address or hostname
*/
LINPHONE_PUBLIC const char *linphone_tunnel_config_get_host2(const LinphoneTunnelConfig *tunnel);
/**
* Set tls port of the second server when using dual tunnel client.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @param port The tunnel server TLS port, recommended value is 443
*/
LINPHONE_PUBLIC void linphone_tunnel_config_set_port2(LinphoneTunnelConfig *tunnel, int port);
/**
* Get the TLS port of the second tunnel server when using dual tunnel client.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @return The TLS port of the tunnel server
*/
LINPHONE_PUBLIC int linphone_tunnel_config_get_port2(const LinphoneTunnelConfig *tunnel);
@ -165,7 +165,7 @@ LINPHONE_PUBLIC int linphone_tunnel_config_get_port2(const LinphoneTunnelConfig
/**
* Set the remote port on the tunnel server side used to test UDP reachability.
* This is used when the mode is set auto, to detect whether the tunnel has to be enabled or not.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @param remote_udp_mirror_port The remote port on the tunnel server side used to test UDP reachability, set to -1 to disable the feature
*/
LINPHONE_PUBLIC void linphone_tunnel_config_set_remote_udp_mirror_port(LinphoneTunnelConfig *tunnel, int remote_udp_mirror_port);
@ -173,40 +173,40 @@ LINPHONE_PUBLIC void linphone_tunnel_config_set_remote_udp_mirror_port(LinphoneT
/**
* Get the remote port on the tunnel server side used to test UDP reachability.
* This is used when the mode is set auto, to detect whether the tunnel has to be enabled or not.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @return The remote port on the tunnel server side used to test UDP reachability
*/
LINPHONE_PUBLIC int linphone_tunnel_config_get_remote_udp_mirror_port(const LinphoneTunnelConfig *tunnel);
/**
* Set the UDP packet round trip delay in ms for a tunnel configuration.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @param delay The UDP packet round trip delay in ms considered as acceptable (recommended value is 1000 ms).
*/
LINPHONE_PUBLIC void linphone_tunnel_config_set_delay(LinphoneTunnelConfig *tunnel, int delay);
/**
* Get the UDP packet round trip delay in ms for a tunnel configuration.
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @return The UDP packet round trip delay in ms.
*/
LINPHONE_PUBLIC int linphone_tunnel_config_get_delay(const LinphoneTunnelConfig *tunnel);
/**
* Increment the refcount of LinphoneTunnelConfig object.
* @param cfg the LinphoneTunnelConfig object.
* Increment the refcount of #LinphoneTunnelConfig object.
* @param cfg the #LinphoneTunnelConfig object.
* @return the same cfg object.
**/
LINPHONE_PUBLIC LinphoneTunnelConfig * linphone_tunnel_config_ref(LinphoneTunnelConfig *cfg);
/**
* Decrement the refcount of LinphoneTunnelConfig object.
* @param cfg the LinphoneTunnelConfig object.
* Decrement the refcount of #LinphoneTunnelConfig object.
* @param cfg the #LinphoneTunnelConfig object.
**/
LINPHONE_PUBLIC void linphone_tunnel_config_unref(LinphoneTunnelConfig *cfg);
/**
* Destroy a tunnel configuration
* @param tunnel LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnelConfig object
* @deprecated use linphone_tunnel_config_unref().
* @donotwrap
*/
@ -228,28 +228,28 @@ LINPHONE_PUBLIC void *linphone_tunnel_config_get_user_data(LinphoneTunnelConfig
/**
* Add a tunnel server configuration.
* @param tunnel LinphoneTunnel object
* @param tunnel_config LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnel object
* @param tunnel_config #LinphoneTunnelConfig object
*/
LINPHONE_PUBLIC void linphone_tunnel_add_server(LinphoneTunnel *tunnel, LinphoneTunnelConfig *tunnel_config);
/**
* Remove a tunnel server configuration.
* @param tunnel LinphoneTunnel object
* @param tunnel_config LinphoneTunnelConfig object
* @param tunnel #LinphoneTunnel object
* @param tunnel_config #LinphoneTunnelConfig object
*/
LINPHONE_PUBLIC void linphone_tunnel_remove_server(LinphoneTunnel *tunnel, LinphoneTunnelConfig *tunnel_config);
/**
* Get added servers
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
* @return \bctbx_list{LinphoneTunnelConfig}
*/
LINPHONE_PUBLIC const bctbx_list_t *linphone_tunnel_get_servers(const LinphoneTunnel *tunnel);
/**
* Remove all tunnel server addresses previously entered with linphone_tunnel_add_server()
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
**/
LINPHONE_PUBLIC void linphone_tunnel_clean_servers(LinphoneTunnel *tunnel);
@ -259,15 +259,15 @@ LINPHONE_PUBLIC void linphone_tunnel_clean_servers(LinphoneTunnel *tunnel);
* If the mode is set to 'auto', the tunnel manager will try to established an RTP session
* with the tunnel server on the UdpMirrorPort. If the connection fail, the tunnel is automatically
* activated whereas the tunnel is automatically disabled if the connection succeed.
* @param tunnel LinphoneTunnel object
* @param mode The desired LinphoneTunnelMode
* @param tunnel #LinphoneTunnel object
* @param mode The desired #LinphoneTunnelMode
**/
LINPHONE_PUBLIC void linphone_tunnel_set_mode(LinphoneTunnel *tunnel, LinphoneTunnelMode mode);
/**
* Get the tunnel mode
* @param tunnel LinphoneTunnel object
* @return The current LinphoneTunnelMode
* @param tunnel #LinphoneTunnel object
* @return The current #LinphoneTunnelMode
**/
LINPHONE_PUBLIC LinphoneTunnelMode linphone_tunnel_get_mode(const LinphoneTunnel *tunnel);
@ -275,14 +275,14 @@ LINPHONE_PUBLIC LinphoneTunnelMode linphone_tunnel_get_mode(const LinphoneTunnel
* Sets whether or not to use the dual tunnel client mode.
* By default this feature is disabled.
* After enabling it, add a server with 2 hosts and 2 ports for the feature to work.
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
* @param dual_mode_enabled TRUE to enable it, FALSE to disable it
*/
LINPHONE_PUBLIC void linphone_tunnel_enable_dual_mode(LinphoneTunnel *tunnel, bool_t dual_mode_enabled);
/**
* Get the dual tunnel client mode
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
* @return TRUE if dual tunnel client mode is enabled, FALSE otherwise
**/
LINPHONE_PUBLIC bool_t linphone_tunnel_dual_mode_enabled(const LinphoneTunnel *tunnel);
@ -298,7 +298,7 @@ LINPHONE_PUBLIC bool_t linphone_tunnel_get_activated(const LinphoneTunnel *tunne
/**
* Check whether the tunnel is connected
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
* @return A boolean value telling if the tunnel is connected
**/
LINPHONE_PUBLIC bool_t linphone_tunnel_connected(const LinphoneTunnel *tunnel);
@ -308,27 +308,27 @@ LINPHONE_PUBLIC bool_t linphone_tunnel_connected(const LinphoneTunnel *tunnel);
* This method is useful when the device switches from wifi to Edge/3G or vice versa. In most cases the tunnel client socket
* won't be notified promptly that its connection is now zombie, so it is recommended to call this method that will cause
* the lost connection to be closed and new connection to be issued.
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
**/
LINPHONE_PUBLIC void linphone_tunnel_reconnect(LinphoneTunnel *tunnel);
/**
* Set whether SIP packets must be directly sent to a UA or pass through the tunnel
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
* @param enable If true, SIP packets shall pass through the tunnel
*/
LINPHONE_PUBLIC void linphone_tunnel_enable_sip(LinphoneTunnel *tunnel, bool_t enable);
/**
* Check whether tunnel is set to transport SIP packets
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
* @return A boolean value telling whether SIP packets shall pass through the tunnel
*/
LINPHONE_PUBLIC bool_t linphone_tunnel_sip_enabled(const LinphoneTunnel *tunnel);
/**
* Set an optional http proxy to go through when connecting to tunnel server.
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
* @param host http proxy host
* @param port http proxy port
* @param username Optional http proxy username if the proxy request authentication. Currently only basic authentication is supported. Use NULL if not needed.
@ -338,7 +338,7 @@ LINPHONE_PUBLIC void linphone_tunnel_set_http_proxy(LinphoneTunnel *tunnel, cons
/**
* Retrieve optional http proxy configuration previously set with linphone_tunnel_set_http_proxy().
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
* @param host http proxy host
* @param port http proxy port
* @param username Optional http proxy username if the proxy request authentication. Currently only basic authentication is supported. Use NULL if not needed.
@ -349,7 +349,7 @@ LINPHONE_PUBLIC void linphone_tunnel_get_http_proxy(LinphoneTunnel*tunnel,const
/**
* Set authentication info for the http proxy
* @param tunnel LinphoneTunnel object
* @param tunnel #LinphoneTunnel object
* @param username User name
* @param passwd Password
*/
@ -387,7 +387,7 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED void linphone_tunnel_auto_detect(LinphoneTun
/**
* Tell whether tunnel auto detection is enabled.
* @param[in] tunnel LinphoneTunnel object.
* @param[in] tunnel #LinphoneTunnel object.
* @return TRUE if auto detection is enabled, FALSE otherwise.
* @deprecated Replaced by linphone_tunnel_get_mode()
* @donotwrap

74
include/linphone/types.h
View file

@ -30,20 +30,20 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#include "linphone/api/c-types.h"
/**
* The LinphoneAccountCreator object used to configure an account on a server via XML-RPC.
* The #LinphoneAccountCreator object used to configure an account on a server via XML-RPC.
* @ingroup account_creator
**/
typedef struct _LinphoneAccountCreator LinphoneAccountCreator;
/**
* An object to define a LinphoneAccountCreator service.
* An object to define a #LinphoneAccountCreator service.
* @ingroup account_creator
* @donotwrap
**/
typedef struct _LinphoneAccountCreatorService LinphoneAccountCreatorService;
/**
* An object to handle the responses callbacks for handling the LinphoneAccountCreator operations.
* An object to handle the responses callbacks for handling the #LinphoneAccountCreator operations.
* @ingroup account_creator
**/
typedef struct _LinphoneAccountCreatorCbs LinphoneAccountCreatorCbs;
@ -200,13 +200,13 @@ typedef enum _LinphoneAudioRoute {
* Sometimes, a userid is required by proxy, and realm can be useful to discriminate
* different SIP domains.
*
* Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
* Once created and filled, a #LinphoneAuthInfo must be added to the #LinphoneCore in
* order to become known and used automatically when needed.
* Use linphone_core_add_auth_info() for that purpose.
*
* The LinphoneCore object can take the initiative to request authentication information
* The #LinphoneCore object can take the initiative to request authentication information
* when needed to the application through the auth_info_requested callback of the
* LinphoneCoreVTable structure.
* #LinphoneCoreVTable structure.
*
* The application can respond to this information request later using
* linphone_core_add_auth_info(). This will unblock all pending authentication
@ -236,7 +236,7 @@ typedef enum _LinphoneAVPFMode {
} LinphoneAVPFMode;
/**
* The LinphoneContent object representing a data buffer.
* The #LinphoneContent object representing a data buffer.
* @ingroup misc
**/
typedef struct _LinphoneBuffer LinphoneBuffer;
@ -257,7 +257,7 @@ typedef enum _LinphoneCallDir {
typedef struct _LinphoneCallLog LinphoneCallLog;
/**
* The LinphoneCallParams is an object containing various call related parameters.
* The #LinphoneCallParams is an object containing various call related parameters.
* It can be used to retrieve parameters from a currently running call or modify
* the call's characteristics dynamically.
* @ingroup call_control
@ -265,10 +265,10 @@ typedef struct _LinphoneCallLog LinphoneCallLog;
typedef struct _LinphoneCallParams LinphoneCallParams;
/**
* The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
* The #LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
*
* To receive these informations periodically and as soon as they are computed, the application is invited to place a #LinphoneCoreCallStatsUpdatedCb callback in the LinphoneCoreVTable structure
* it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
* To receive these informations periodically and as soon as they are computed, the application is invited to place a #LinphoneCoreCallStatsUpdatedCb callback in the #LinphoneCoreVTable structure
* it passes for instanciating the #LinphoneCore object (see linphone_core_new() ).
*
* At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
* @ingroup call_misc
@ -290,7 +290,7 @@ typedef enum _LinphoneCallStatus {
} LinphoneCallStatus;
/**
* LinphoneConference class
* #LinphoneConference class
* The _LinphoneConference struct does not exists, it's the Conference C++ class that is used behind
* @ingroup call_control
*/
@ -304,7 +304,7 @@ typedef struct _LinphoneConference LinphoneConference;
typedef struct _LinphoneConferenceParams LinphoneConferenceParams;
/**
* The LinphoneConfig object is used to manipulate a configuration file.
* The #LinphoneConfig object is used to manipulate a configuration file.
*
* The format of the configuration file is a .ini like format:
* - sections are defined in []
@ -330,7 +330,7 @@ typedef struct _LpConfig LinphoneConfig;
#define LpConfig LinphoneConfig
/**
* LinphoneGlobalState describes the global state of the LinphoneCore object.
* #LinphoneGlobalState describes the global state of the #LinphoneCore object.
* It is notified via the LinphoneCoreVTable::global_state_changed
* @ingroup initializing
**/
@ -361,14 +361,14 @@ typedef struct _LinphoneContactSearch LinphoneContactSearch;
typedef unsigned int LinphoneContactSearchID;
/**
* Old name of LinphoneContactSearchID
* Old name of #LinphoneContactSearchID
* @deprecated
* @donotwrap
*/
LINPHONE_DEPRECATED typedef LinphoneContactSearchID ContactSearchID;
/**
* The LinphoneContent object holds data that can be embedded in a signaling message.
* The #LinphoneContent object holds data that can be embedded in a signaling message.
* @ingroup misc
**/
typedef struct _LinphoneContent LinphoneContent;
@ -406,7 +406,7 @@ typedef enum _LinphoneEcCalibratorStatus {
/**
* 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
* 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.
* @ingroup misc
**/
@ -448,13 +448,13 @@ typedef enum _LinphoneFirewallPolicy {
typedef struct _LinphoneFriend LinphoneFriend;
/**
* The LinphoneFriendList object representing a list of friends.
* The #LinphoneFriendList object representing a list of friends.
* @ingroup buddy_list
**/
typedef struct _LinphoneFriendList LinphoneFriendList;
/**
* An object to handle the callbacks for LinphoneFriend synchronization.
* An object to handle the callbacks for #LinphoneFriend synchronization.
* @ingroup buddy_list
**/
typedef struct _LinphoneFriendListCbs LinphoneFriendListCbs;
@ -480,7 +480,7 @@ typedef enum _LinphoneFriendListSyncStatus {
} LinphoneFriendListSyncStatus;
/**
* LinphoneGlobalState describes the global state of the LinphoneCore object.
* #LinphoneGlobalState describes the global state of the #LinphoneCore object.
* It is notified via the LinphoneCoreVTable::global_state_changed
* @ingroup initializing
**/
@ -513,7 +513,7 @@ typedef enum _LinphoneIceState {
typedef struct _LinphoneImEncryptionEngine LinphoneImEncryptionEngine;
/**
* An object to handle the callbacks for the handling a LinphoneImEncryptionEngine object.
* An object to handle the callbacks for the handling a #LinphoneImEncryptionEngine object.
* @ingroup misc
* @donotwrap
*/
@ -527,7 +527,7 @@ typedef struct _LinphoneImEncryptionEngineCbs LinphoneImEncryptionEngineCbs;
typedef struct _LinphoneImNotifPolicy LinphoneImNotifPolicy;
/**
* The LinphoneInfoMessage is an object representing an informational message sent or received by the core.
* The #LinphoneInfoMessage is an object representing an informational message sent or received by the core.
* @ingroup misc
**/
typedef struct _LinphoneInfoMessage LinphoneInfoMessage;
@ -555,7 +555,7 @@ typedef enum _LinphoneLogCollectionState {
} LinphoneLogCollectionState;
/**
* LinphoneCoreLogCollectionUploadState is used to notify if log collection upload have been succesfully delivered or not.
* #LinphoneCoreLogCollectionUploadState is used to notify if log collection upload have been succesfully delivered or not.
* @ingroup initializing
*/
typedef enum _LinphoneCoreLogCollectionUploadState {
@ -622,7 +622,7 @@ typedef enum _LinphoneOnlineStatus{
typedef struct _LinphonePlayer LinphonePlayer;
/**
* An object to handle the callbacks for the handling a LinphonePlayer objects.
* An object to handle the callbacks for the handling a #LinphonePlayer objects.
* @ingroup call_control
*/
typedef struct _LinphonePlayerCbs LinphonePlayerCbs;
@ -832,11 +832,11 @@ typedef enum _LinphonePrivacy {
typedef unsigned int LinphonePrivacyMask;
/**
* The LinphoneProxyConfig object represents a proxy configuration to be used
* by the LinphoneCore object.
* The #LinphoneProxyConfig object represents a proxy configuration to be used
* by the #LinphoneCore object.
* Its fields must not be used directly in favour of the accessors methods.
* Once created and filled properly the LinphoneProxyConfig can be given to
* LinphoneCore with linphone_core_add_proxy_config().
* Once created and filled properly the #LinphoneProxyConfig can be given to
* #LinphoneCore with linphone_core_add_proxy_config().
* This will automatically triggers the registration, if enabled.
*
* The proxy configuration are persistent to restarts because they are saved
@ -900,7 +900,7 @@ typedef enum _LinphoneReason{
#define LinphoneReasonMedia LinphoneReasonUnsupportedContent
/**
* LinphoneRegistrationState describes proxy registration states.
* #LinphoneRegistrationState describes proxy registration states.
* @ingroup proxies
**/
typedef enum _LinphoneRegistrationState {
@ -936,7 +936,7 @@ typedef struct _LinphoneSipTransports {
typedef struct _LinphoneTransports LinphoneTransports;
/**
* Old name of LinphoneSipTransports
* Old name of #LinphoneSipTransports
* @deprecated
* @donotwrap
*/
@ -982,7 +982,7 @@ typedef enum _LinphoneSubscriptionDir{
/**
* Enum for subscription states.
* LinphoneSubscriptionTerminated and LinphoneSubscriptionError are final states.
* #LinphoneSubscriptionTerminated and #LinphoneSubscriptionError are final states.
* @ingroup event_api
**/
typedef enum _LinphoneSubscriptionState{
@ -1058,7 +1058,7 @@ typedef enum _LinphoneUpnpState {
} LinphoneUpnpState;
/**
* The LinphoneVcard object.
* The #LinphoneVcard object.
* @ingroup carddav_vcard
*/
typedef struct _LinphoneVcard LinphoneVcard;
@ -1074,7 +1074,7 @@ typedef enum _LinphoneVersionUpdateCheckResult {
} LinphoneVersionUpdateCheckResult;
/**
* The LinphoneVideoDefinition object represents a video definition, eg. its width and its height.
* The #LinphoneVideoDefinition object represents a video definition, eg. its width and its height.
* @ingroup media_parameters
*/
typedef struct _LinphoneVideoDefinition LinphoneVideoDefinition;
@ -1103,7 +1103,7 @@ typedef struct LinphoneVideoSizeDef {
} LinphoneVideoSizeDef;
/**
* Old name of LinphoneVideoSizeDef
* Old name of #LinphoneVideoSizeDef
* @deprecated
*/
typedef LinphoneVideoSizeDef MSVideoSizeDef;
@ -1125,19 +1125,19 @@ typedef enum _LinphoneXmlRpcArgType {
} LinphoneXmlRpcArgType;
/**
* The LinphoneXmlRpcRequest object representing a XML-RPC request to be sent.
* The #LinphoneXmlRpcRequest object representing a XML-RPC request to be sent.
* @ingroup misc
**/
typedef struct _LinphoneXmlRpcRequest LinphoneXmlRpcRequest;
/**
* An object to handle the callbacks for handling the LinphoneXmlRpcRequest operations.
* An object to handle the callbacks for handling the #LinphoneXmlRpcRequest operations.
* @ingroup misc
**/
typedef struct _LinphoneXmlRpcRequestCbs LinphoneXmlRpcRequestCbs;
/**
* The LinphoneXmlRpcSession object used to send XML-RPC requests and handle their responses.
* The #LinphoneXmlRpcSession object used to send XML-RPC requests and handle their responses.
* @ingroup misc
**/
typedef struct _LinphoneXmlRpcSession LinphoneXmlRpcSession;

66
include/linphone/vcard.h
View file

@ -38,16 +38,16 @@ extern "C"
#define LINPHONE_VCARD BELLE_SIP_CAST(object, LinphoneVcard)
/**
* Creates a LinphoneVcard object that has a pointer to an empty vCard
* @return a new LinphoneVcard object
* Creates a #LinphoneVcard object that has a pointer to an empty vCard
* @return a new #LinphoneVcard object
* @deprecated Use linphone_factory_create_vcard() instead.
* @donotwrap
*/
LINPHONE_DEPRECATED LINPHONE_PUBLIC LinphoneVcard* linphone_vcard_new(void);
/**
* Deletes a LinphoneVcard object properly
* @param[in] vCard the LinphoneVcard to destroy
* Deletes a #LinphoneVcard object properly
* @param[in] vCard the #LinphoneVcard to destroy
* @deprecated Use linphone_vcard_unref() or belle_sip_object_unref() instead.
* @donotwrap
*/
@ -55,145 +55,145 @@ LINPHONE_DEPRECATED LINPHONE_PUBLIC void linphone_vcard_free(LinphoneVcard *vCar
/**
* Take a ref on a #LinphoneVcard.
* @param[in] vCard LinphoneVcard object
* @param[in] vCard #LinphoneVcard object
*/
LINPHONE_PUBLIC LinphoneVcard *linphone_vcard_ref(LinphoneVcard *vCard);
/**
* Release a #LinphoneVcard.
* @param[in] vCard LinphoneVcard object
* @param[in] vCard #LinphoneVcard object
*/
LINPHONE_PUBLIC void linphone_vcard_unref(LinphoneVcard *vCard);
/**
* Clone a #LinphoneVcard.
* @param[in] vCard LinphoneVcard object
* @return a new LinphoneVcard object
* @param[in] vCard #LinphoneVcard object
* @return a new #LinphoneVcard object
*/
LINPHONE_PUBLIC LinphoneVcard *linphone_vcard_clone(const LinphoneVcard *vCard);
/**
* Returns the vCard4 representation of the LinphoneVcard.
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return a const char * that represents the vCard
*/
LINPHONE_PUBLIC const char* linphone_vcard_as_vcard4_string(LinphoneVcard *vCard);
/**
* Sets the FN attribute of the vCard (which is mandatory).
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] name the display name to set for the vCard
*/
LINPHONE_PUBLIC void linphone_vcard_set_full_name(LinphoneVcard *vCard, const char *name);
/**
* Returns the FN attribute of the vCard, or NULL if it isn't set yet.
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return the display name of the vCard, or NULL
*/
LINPHONE_PUBLIC const char* linphone_vcard_get_full_name(const LinphoneVcard *vCard);
/**
* Sets the skipFieldValidation property of the vcard
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] skip skipFieldValidation property of the vcard
*/
LINPHONE_PUBLIC void linphone_vcard_set_skip_validation(LinphoneVcard *vCard, bool_t skip);
/**
* Returns the skipFieldValidation property of the vcard.
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return the skipFieldValidation property of the vcard
*/
LINPHONE_PUBLIC bool_t linphone_vcard_get_skip_validation(const LinphoneVcard *vCard);
/**
* Sets the family name in the N attribute of the vCard.
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] name the family name to set for the vCard
*/
LINPHONE_PUBLIC void linphone_vcard_set_family_name(LinphoneVcard *vCard, const char *name);
/**
* Returns the family name in the N attribute of the vCard, or NULL if it isn't set yet.
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return the family name of the vCard, or NULL
*/
LINPHONE_PUBLIC const char* linphone_vcard_get_family_name(const LinphoneVcard *vCard);
/**
* Sets the given name in the N attribute of the vCard.
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] name the given name to set for the vCard
*/
LINPHONE_PUBLIC void linphone_vcard_set_given_name(LinphoneVcard *vCard, const char *name);
/**
* Returns the given name in the N attribute of the vCard, or NULL if it isn't set yet.
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return the given name of the vCard, or NULL
*/
LINPHONE_PUBLIC const char* linphone_vcard_get_given_name(const LinphoneVcard *vCard);
/**
* Adds a SIP address in the vCard, using the IMPP property
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] sip_address the SIP address to add
*/
LINPHONE_PUBLIC void linphone_vcard_add_sip_address(LinphoneVcard *vCard, const char *sip_address);
/**
* Removes a SIP address in the vCard (if it exists), using the IMPP property
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] sip_address the SIP address to remove
*/
LINPHONE_PUBLIC void linphone_vcard_remove_sip_address(LinphoneVcard *vCard, const char *sip_address);
/**
* Edits the preferred SIP address in the vCard (or the first one), using the IMPP property
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] sip_address the new SIP address
*/
LINPHONE_PUBLIC void linphone_vcard_edit_main_sip_address(LinphoneVcard *vCard, const char *sip_address);
/**
* Returns the list of SIP addresses (as LinphoneAddress) in the vCard (all the IMPP attributes that has an URI value starting by "sip:") or NULL
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return \bctbx_list{LinphoneAddress}
*/
LINPHONE_PUBLIC const bctbx_list_t* linphone_vcard_get_sip_addresses(LinphoneVcard *vCard);
/**
* Adds a phone number in the vCard, using the TEL property
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] phone the phone number to add
*/
LINPHONE_PUBLIC void linphone_vcard_add_phone_number(LinphoneVcard *vCard, const char *phone);
/**
* Removes a phone number in the vCard (if it exists), using the TEL property
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] phone the phone number to remove
*/
LINPHONE_PUBLIC void linphone_vcard_remove_phone_number(LinphoneVcard *vCard, const char *phone);
/**
* Returns the list of phone numbers (as string) in the vCard (all the TEL attributes) or NULL
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return \bctbx_list{const char *}
*/
LINPHONE_PUBLIC bctbx_list_t* linphone_vcard_get_phone_numbers(const LinphoneVcard *vCard);
/**
* Fills the Organization field of the vCard
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] organization the Organization
*/
LINPHONE_PUBLIC void linphone_vcard_set_organization(LinphoneVcard *vCard, const char *organization);
/**
* Gets the Organization of the vCard
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return the Organization of the vCard or NULL
*/
LINPHONE_PUBLIC const char* linphone_vcard_get_organization(const LinphoneVcard *vCard);
@ -201,49 +201,49 @@ LINPHONE_PUBLIC const char* linphone_vcard_get_organization(const LinphoneVcard
/**
* Generates a random unique id for the vCard.
* If is required to be able to synchronize the vCard with a CardDAV server
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return TRUE if operation is successful, otherwise FALSE (for example if it already has an unique ID)
*/
LINPHONE_PUBLIC bool_t linphone_vcard_generate_unique_id(LinphoneVcard *vCard);
/**
* Sets the unique ID of the vCard
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] uid the unique id
*/
LINPHONE_PUBLIC void linphone_vcard_set_uid(LinphoneVcard *vCard, const char *uid);
/**
* Gets the UID of the vCard
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return the UID of the vCard, otherwise NULL
*/
LINPHONE_PUBLIC const char* linphone_vcard_get_uid(const LinphoneVcard *vCard);
/**
* Sets the eTAG of the vCard
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] etag the eTAG
*/
LINPHONE_PUBLIC void linphone_vcard_set_etag(LinphoneVcard *vCard, const char * etag);
/**
* Gets the eTag of the vCard
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return the eTag of the vCard in the CardDAV server, otherwise NULL
*/
LINPHONE_PUBLIC const char* linphone_vcard_get_etag(const LinphoneVcard *vCard);
/**
* Sets the URL of the vCard
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @param[in] url the URL
*/
LINPHONE_PUBLIC void linphone_vcard_set_url(LinphoneVcard *vCard, const char *url);
/**
* Gets the URL of the vCard
* @param[in] vCard the LinphoneVcard
* @param[in] vCard the #LinphoneVcard
* @return the URL of the vCard in the CardDAV server, otherwise NULL
*/
LINPHONE_PUBLIC const char* linphone_vcard_get_url(const LinphoneVcard *vCard);

48
include/linphone/video_definition.h
View file

@ -36,69 +36,69 @@ extern "C" {
/**
* Acquire a reference to the video definition.
* @param[in] vdef LinphoneVideoDefinition object.
* @return The same LinphoneVideoDefinition object.
* @param[in] vdef #LinphoneVideoDefinition object.
* @return The same #LinphoneVideoDefinition object.
**/
LINPHONE_PUBLIC LinphoneVideoDefinition * linphone_video_definition_ref(LinphoneVideoDefinition *vdef);
/**
* Release reference to the video definition.
* @param[in] vdef LinphoneVideoDefinition object.
* @param[in] vdef #LinphoneVideoDefinition object.
**/
LINPHONE_PUBLIC void linphone_video_definition_unref(LinphoneVideoDefinition *vdef);
/**
* Retrieve the user pointer associated with the video definition.
* @param[in] vdef LinphoneVideoDefinition object.
* @param[in] vdef #LinphoneVideoDefinition object.
* @return The user pointer associated with the video definition.
**/
LINPHONE_PUBLIC void *linphone_video_definition_get_user_data(const LinphoneVideoDefinition *vdef);
/**
* Assign a user pointer to the video definition.
* @param[in] vdef LinphoneVideoDefinition object.
* @param[in] vdef #LinphoneVideoDefinition object.
* @param[in] ud The user pointer to associate with the video definition.
**/
LINPHONE_PUBLIC void linphone_video_definition_set_user_data(LinphoneVideoDefinition *vdef, void *ud);
/**
* Clone a video definition.
* @param[in] vdef LinphoneVideoDefinition object to be cloned
* @param[in] vdef #LinphoneVideoDefinition object to be cloned
* @return The new clone of the video definition
*/
LINPHONE_PUBLIC LinphoneVideoDefinition * linphone_video_definition_clone(const LinphoneVideoDefinition *vdef);
/**
* Get the width of the video definition.
* @param[in] vdef LinphoneVideoDefinition object
* @param[in] vdef #LinphoneVideoDefinition object
* @return The width of the video definition
*/
LINPHONE_PUBLIC unsigned int linphone_video_definition_get_width(const LinphoneVideoDefinition *vdef);
/**
* Set the width of the video definition.
* @param[in] vdef LinphoneVideoDefinition object
* @param[in] vdef #LinphoneVideoDefinition object
* @param[in] width The width of the video definition
*/
LINPHONE_PUBLIC void linphone_video_definition_set_width(LinphoneVideoDefinition *vdef, unsigned int width);
/**
* Get the height of the video definition.
* @param[in] vdef LinphoneVideoDefinition object
* @param[in] vdef #LinphoneVideoDefinition object
* @return The height of the video definition
*/
LINPHONE_PUBLIC unsigned int linphone_video_definition_get_height(const LinphoneVideoDefinition *vdef);
/**
* Set the height of the video definition.
* @param[in] vdef LinphoneVideoDefinition object
* @param[in] vdef #LinphoneVideoDefinition object
* @param[in] height The height of the video definition
*/
LINPHONE_PUBLIC void linphone_video_definition_set_height(LinphoneVideoDefinition *vdef, unsigned int height);
/**
* Set the width and the height of the video definition.
* @param[in] vdef LinphoneVideoDefinition object
* @param[in] vdef #LinphoneVideoDefinition object
* @param[in] width The width of the video definition
* @param[in] height The height of the video definition
*/
@ -106,38 +106,38 @@ LINPHONE_PUBLIC void linphone_video_definition_set_definition(LinphoneVideoDefin
/**
* Get the name of the video definition.
* @param[in] vdef LinphoneVideoDefinition object
* @param[in] vdef #LinphoneVideoDefinition object
* @return The name of the video definition
*/
LINPHONE_PUBLIC const char * linphone_video_definition_get_name(const LinphoneVideoDefinition *vdef);
/**
* Set the name of the video definition.
* @param[in] vdef LinphoneVideoDefinition object
* @param[in] vdef #LinphoneVideoDefinition object
* @param[in] name The name of the video definition
*/
LINPHONE_PUBLIC void linphone_video_definition_set_name(LinphoneVideoDefinition *vdef, const char *name);
/**
* Tells whether two LinphoneVideoDefinition objects are equal (the widths and the heights are the same but can be switched).
* @param[in] vdef1 LinphoneVideoDefinition object
* @param[in] vdef2 LinphoneVideoDefinition object
* @return A boolean value telling whether the two LinphoneVideoDefinition objects are equal.
* Tells whether two #LinphoneVideoDefinition objects are equal (the widths and the heights are the same but can be switched).
* @param[in] vdef1 #LinphoneVideoDefinition object
* @param[in] vdef2 #LinphoneVideoDefinition object
* @return A boolean value telling whether the two #LinphoneVideoDefinition objects are equal.
*/
LINPHONE_PUBLIC bool_t linphone_video_definition_equals(const LinphoneVideoDefinition *vdef1, const LinphoneVideoDefinition *vdef2);
/**
* Tells whether two LinphoneVideoDefinition objects are strictly equal (the widths are the same and the heights are the same).
* @param[in] vdef1 LinphoneVideoDefinition object
* @param[in] vdef2 LinphoneVideoDefinition object
* @return A boolean value telling whether the two LinphoneVideoDefinition objects are strictly equal.
* Tells whether two #LinphoneVideoDefinition objects are strictly equal (the widths are the same and the heights are the same).
* @param[in] vdef1 #LinphoneVideoDefinition object
* @param[in] vdef2 #LinphoneVideoDefinition object
* @return A boolean value telling whether the two #LinphoneVideoDefinition objects are strictly equal.
*/
LINPHONE_PUBLIC bool_t linphone_video_definition_strict_equals(const LinphoneVideoDefinition *vdef1, const LinphoneVideoDefinition *vdef2);
/**
* Tells whether a LinphoneVideoDefinition is undefined.
* @param[in] vdef LinphoneVideoDefinition object
* @return A boolean value telling whether the LinphoneVideoDefinition is undefined.
* Tells whether a #LinphoneVideoDefinition is undefined.
* @param[in] vdef #LinphoneVideoDefinition object
* @return A boolean value telling whether the #LinphoneVideoDefinition is undefined.
*/
LINPHONE_PUBLIC bool_t linphone_video_definition_is_undefined(const LinphoneVideoDefinition *vdef);

2
include/linphone/wrapper_utils.h
View file

@ -74,7 +74,7 @@ LINPHONE_PUBLIC void linphone_chat_room_send_chat_message_2(LinphoneChatRoom *cr
* instead of totaly takes ownership on it. Thus, the #LinphoneChatMessage object must be released by the API user after calling
* that function.
*
* @param[in] msg LinphoneChatMessage object
* @param[in] msg #LinphoneChatMessage object
*/
LINPHONE_PUBLIC void linphone_chat_message_resend_2(LinphoneChatMessage *msg);

86
include/linphone/xmlrpc.h
View file

@ -35,78 +35,78 @@ extern "C" {
*/
/**
* Create a new LinphoneXmlRpcRequest object.
* Create a new #LinphoneXmlRpcRequest object.
* @param[in] return_type The expected XML-RPC response type.
* @param[in] method The XML-RPC method to call.
* @return A new LinphoneXmlRpcRequest object.
* @return A new #LinphoneXmlRpcRequest object.
**/
LINPHONE_PUBLIC LinphoneXmlRpcRequest * linphone_xml_rpc_request_new(LinphoneXmlRpcArgType return_type, const char *method);
/**
* Acquire a reference to the XML-RPC request.
* @param[in] request LinphoneXmlRpcRequest object.
* @return The same LinphoneXmlRpcRequest object.
* @param[in] request #LinphoneXmlRpcRequest object.
* @return The same #LinphoneXmlRpcRequest object.
**/
LINPHONE_PUBLIC LinphoneXmlRpcRequest * linphone_xml_rpc_request_ref(LinphoneXmlRpcRequest *request);
/**
* Release reference to the XML-RPC request.
* @param[in] request LinphoneXmlRpcRequest object.
* @param[in] request #LinphoneXmlRpcRequest object.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_request_unref(LinphoneXmlRpcRequest *request);
/**
* Retrieve the user pointer associated with the XML-RPC request.
* @param[in] request LinphoneXmlRpcRequest object.
* @param[in] request #LinphoneXmlRpcRequest object.
* @return The user pointer associated with the XML-RPC request.
**/
LINPHONE_PUBLIC void *linphone_xml_rpc_request_get_user_data(const LinphoneXmlRpcRequest *request);
/**
* Assign a user pointer to the XML-RPC request.
* @param[in] request LinphoneXmlRpcRequest object.
* @param[in] request #LinphoneXmlRpcRequest object.
* @param[in] ud The user pointer to associate with the XML-RPC request.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_request_set_user_data(LinphoneXmlRpcRequest *request, void *ud);
/**
* Add an integer argument to an XML-RPC request.
* @param[in] request LinphoneXmlRpcRequest object.
* @param[in] request #LinphoneXmlRpcRequest object.
* @param[in] value The integer value of the added argument.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_request_add_int_arg(LinphoneXmlRpcRequest *request, int value);
/**
* Add a string argument to an XML-RPC request.
* @param[in] request LinphoneXmlRpcRequest object.
* @param[in] request #LinphoneXmlRpcRequest object.
* @param[in] value The string value of the added argument.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_request_add_string_arg(LinphoneXmlRpcRequest *request, const char *value);
/**
* Get the LinphoneXmlRpcRequestCbs object associated with a LinphoneXmlRpcRequest.
* @param[in] request LinphoneXmlRpcRequest object
* @return The LinphoneXmlRpcRequestCbs object associated with the LinphoneXmlRpcRequest.
* Get the #LinphoneXmlRpcRequestCbs object associated with a LinphoneXmlRpcRequest.
* @param[in] request #LinphoneXmlRpcRequest object
* @return The #LinphoneXmlRpcRequestCbs object associated with the LinphoneXmlRpcRequest.
**/
LINPHONE_PUBLIC LinphoneXmlRpcRequestCbs * linphone_xml_rpc_request_get_callbacks(const LinphoneXmlRpcRequest *request);
/**
* Get the content of the XML-RPC request.
* @param[in] request LinphoneXmlRpcRequest object.
* @param[in] request #LinphoneXmlRpcRequest object.
* @return The string representation of the content of the XML-RPC request.
*/
LINPHONE_PUBLIC const char * linphone_xml_rpc_request_get_content(const LinphoneXmlRpcRequest *request);
/**
* Get the status of the XML-RPC request.
* @param[in] request LinphoneXmlRpcRequest object.
* @param[in] request #LinphoneXmlRpcRequest object.
* @return The status of the XML-RPC request.
**/
LINPHONE_PUBLIC LinphoneXmlRpcStatus linphone_xml_rpc_request_get_status(const LinphoneXmlRpcRequest *request);
/**
* Get the response to an XML-RPC request sent with linphone_xml_rpc_session_send_request() and returning an integer response.
* @param[in] request LinphoneXmlRpcRequest object.
* @param[in] request #LinphoneXmlRpcRequest object.
* @return The integer response to the XML-RPC request.
**/
LINPHONE_PUBLIC int linphone_xml_rpc_request_get_int_response(const LinphoneXmlRpcRequest *request);
@ -119,101 +119,101 @@ LINPHONE_PUBLIC int linphone_xml_rpc_request_get_int_response(const LinphoneXmlR
LINPHONE_PUBLIC const char * linphone_xml_rpc_request_get_string_response(const LinphoneXmlRpcRequest *request);
/**
* Create a new LinphoneXmlRpcSession object.
* @param[in] core The LinphoneCore object used to send the XML-RPC requests.
* Create a new #LinphoneXmlRpcSession object.
* @param[in] core The #LinphoneCore object used to send the XML-RPC requests.
* @param[in] url The URL of the XML-RPC server to send the XML-RPC requests to.
* @return A new LinphoneXmlRpcSession object.
* @return A new #LinphoneXmlRpcSession object.
*/
LINPHONE_PUBLIC LinphoneXmlRpcSession * linphone_xml_rpc_session_new(LinphoneCore *core, const char *url);
/**
* Acquire a reference to the XML-RPC session.
* @param[in] session LinphoneXmlRpcSession object.
* @return The same LinphoneXmlRpcSession object.
* @param[in] session #LinphoneXmlRpcSession object.
* @return The same #LinphoneXmlRpcSession object.
**/
LINPHONE_PUBLIC LinphoneXmlRpcSession * linphone_xml_rpc_session_ref(LinphoneXmlRpcSession *session);
/**
* Release reference to the XML-RPC session.
* @param[in] session LinphoneXmlRpcSession object.
* @param[in] session #LinphoneXmlRpcSession object.
* @warning This will not stop pending xml-rpc requests. Use linphone_xml_rpc_session_release() instead if this is intended.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_session_unref(LinphoneXmlRpcSession *session);
/**
* Retrieve the user pointer associated with the XML-RPC session.
* @param[in] session LinphoneXmlRpcSession object.
* @param[in] session #LinphoneXmlRpcSession object.
* @return The user pointer associated with the XML-RPC session.
**/
LINPHONE_PUBLIC void *linphone_xml_rpc_session_get_user_data(const LinphoneXmlRpcSession *session);
/**
* Assign a user pointer to the XML-RPC session.
* @param[in] session LinphoneXmlRpcSession object.
* @param[in] session #LinphoneXmlRpcSession object.
* @param[in] ud The user pointer to associate with the XML-RPC session.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_session_set_user_data(LinphoneXmlRpcSession *session, void *ud);
/**
* Send an XML-RPC request.
* @param[in] session LinphoneXmlRpcSession object.
* @param[in] request The LinphoneXmlRpcRequest to be sent.
* @param[in] session #LinphoneXmlRpcSession object.
* @param[in] request The #LinphoneXmlRpcRequest to be sent.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_session_send_request(LinphoneXmlRpcSession *session, LinphoneXmlRpcRequest *request);
/**
* Stop and unref an XML rpc session. Pending requests will be aborted.
* @param[in] session LinphoneXmlRpcSession object.
* @param[in] session #LinphoneXmlRpcSession object.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_session_release(LinphoneXmlRpcSession *session);
/**
* Acquire a reference to a LinphoneXmlRpcRequestCbs object.
* @param[in] cbs LinphoneXmlRpcRequestCbs object.
* @return The same LinphoneXmlRpcRequestCbs object.
* Acquire a reference to a #LinphoneXmlRpcRequestCbs object.
* @param[in] cbs #LinphoneXmlRpcRequestCbs object.
* @return The same #LinphoneXmlRpcRequestCbs object.
**/
LINPHONE_PUBLIC LinphoneXmlRpcRequestCbs * linphone_xml_rpc_request_cbs_ref(LinphoneXmlRpcRequestCbs *cbs);
/**
* Release a reference to a LinphoneXmlRpcRequestCbs object.
* @param[in] cbs LinphoneXmlRpcRequestCbs object.
* Release a reference to a #LinphoneXmlRpcRequestCbs object.
* @param[in] cbs #LinphoneXmlRpcRequestCbs object.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_request_cbs_unref(LinphoneXmlRpcRequestCbs *cbs);
/**
* Retrieve the user pointer associated with a LinphoneXmlRpcRequestCbs object.
* @param[in] cbs LinphoneXmlRpcRequestCbs object.
* @return The user pointer associated with the LinphoneXmlRpcRequestCbs object.
* Retrieve the user pointer associated with a #LinphoneXmlRpcRequestCbs object.
* @param[in] cbs #LinphoneXmlRpcRequestCbs object.
* @return The user pointer associated with the #LinphoneXmlRpcRequestCbs object.
**/
LINPHONE_PUBLIC void *linphone_xml_rpc_request_cbs_get_user_data(const LinphoneXmlRpcRequestCbs *cbs);
/**
* Assign a user pointer to a LinphoneXmlRpcRequestCbs object.
* @param[in] cbs LinphoneXmlRpcRequestCbs object.
* @param[in] ud The user pointer to associate with the LinphoneXmlRpcRequestCbs object.
* Assign a user pointer to a #LinphoneXmlRpcRequestCbs object.
* @param[in] cbs #LinphoneXmlRpcRequestCbs object.
* @param[in] ud The user pointer to associate with the #LinphoneXmlRpcRequestCbs object.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_request_cbs_set_user_data(LinphoneXmlRpcRequestCbs *cbs, void *ud);
/**
* Get the response callback.
* @param[in] cbs LinphoneXmlRpcRequestCbs object.
* @param[in] cbs #LinphoneXmlRpcRequestCbs object.
* @return The current response callback.
**/
LINPHONE_PUBLIC LinphoneXmlRpcRequestCbsResponseCb linphone_xml_rpc_request_cbs_get_response(const LinphoneXmlRpcRequestCbs *cbs);
/**
* Set the response callback.
* @param[in] cbs LinphoneXmlRpcRequestCbs object.
* @param[in] cbs #LinphoneXmlRpcRequestCbs object.
* @param[in] cb The response callback to be used.
**/
LINPHONE_PUBLIC void linphone_xml_rpc_request_cbs_set_response(LinphoneXmlRpcRequestCbs *cbs, LinphoneXmlRpcRequestCbsResponseCb cb);
/**
* Creates a LinphoneXmlRpcRequest from a LinphoneXmlRpcSession
* @param[in] session the LinphoneXmlRpcSession
* @param[in] return_type the return type of the request as a LinphoneXmlRpcArgType
* Creates a #LinphoneXmlRpcRequest from a #LinphoneXmlRpcSession
* @param[in] session the #LinphoneXmlRpcSession
* @param[in] return_type the return type of the request as a #LinphoneXmlRpcArgType
* @param[in] method the function name to call
* @return a LinphoneXmlRpcRequest object
* @return a #LinphoneXmlRpcRequest object
*/
LINPHONE_PUBLIC LinphoneXmlRpcRequest * linphone_xml_rpc_session_create_request(LinphoneXmlRpcSession *session, LinphoneXmlRpcArgType return_type, const char *method);