Liblinphone  3.11.1
Macros | Typedefs | Enumerations | Functions
Miscenalleous: logs, version strings, config storage

Macros

#define LINPHONE_CONFIG(obj)   BELLE_SIP_CAST(obj, LinphoneConfig);
 
#define lp_config_new   linphone_config_new
 
#define lp_config_new_from_buffer   linphone_config_new_from_buffer
 
#define lp_config_new_with_factory   linphone_config_new_with_factory
 
#define lp_config_read_file   linphone_config_read_file
 
#define lp_config_get_string   linphone_config_get_string
 
#define lp_config_get_string_list   linphone_config_get_string_list
 
#define lp_config_get_range   linphone_config_get_range
 
#define lp_config_get_int   linphone_config_get_int
 
#define lp_config_get_int64   linphone_config_get_int64
 
#define lp_config_get_float   linphone_config_get_float
 
#define lp_config_set_string   linphone_config_set_string
 
#define lp_config_set_string_list   linphone_config_set_string_list
 
#define lp_config_set_range   linphone_config_set_range
 
#define lp_config_set_int   linphone_config_set_int
 
#define lp_config_set_int_hex   linphone_config_set_int_hex
 
#define lp_config_set_int64   linphone_config_set_int64
 
#define lp_config_set_float   linphone_config_set_float
 
#define lp_config_sync   linphone_config_sync
 
#define lp_config_has_section   linphone_config_has_section
 
#define lp_config_clean_section   linphone_config_clean_section
 
#define lp_config_has_entry   linphone_config_has_entry
 
#define lp_config_clean_entry   linphone_config_clean_entry
 
#define lp_config_get_sections_names   linphone_config_get_sections_names
 
#define lp_config_for_each_section   linphone_config_for_each_section
 
#define lp_config_for_each_entry   linphone_config_for_each_entry
 
#define lp_config_needs_commit   linphone_config_needs_commit
 
#define lp_config_destroy   linphone_config_destroy
 
#define lp_config_get_default_int   linphone_config_get_default_int
 
#define lp_config_get_default_int64   linphone_config_get_default_int64
 
#define lp_config_get_default_float   linphone_config_get_default_float
 
#define lp_config_get_default_string   linphone_config_get_default_string
 
#define lp_config_get_section_param_string   linphone_config_get_section_param_string
 
#define lp_config_ref   linphone_config_ref
 
#define lp_config_unref   linphone_config_unref
 
#define lp_config_write_relative_file   linphone_config_write_relative_file
 
#define lp_config_read_relative_file   linphone_config_read_relative_file
 
#define lp_config_relative_file_exists   linphone_config_relative_file_exists
 
#define lp_config_dump_as_xml   linphone_config_dump_as_xml
 
#define lp_config_dump   linphone_config_dump
 
#define lp_config_get_overwrite_flag_for_entry   linphone_config_get_overwrite_flag_for_entry
 
#define lp_config_set_overwrite_flag_for_entry   linphone_config_set_overwrite_flag_for_entry
 
#define lp_config_get_overwrite_flag_for_section   linphone_config_get_overwrite_flag_for_section
 
#define lp_config_set_overwrite_flag_for_section   linphone_config_set_overwrite_flag_for_section
 
#define lp_config_get_skip_flag_for_entry   linphone_config_get_skip_flag_for_entry
 
#define lp_config_set_skip_flag_for_entry   linphone_config_set_skip_flag_for_entry
 
#define lp_config_get_skip_flag_for_section   linphone_config_get_skip_flag_for_section
 
#define lp_config_set_skip_flag_for_section   linphone_config_set_skip_flag_for_section
 

Typedefs

typedef void(* LinphoneAccountCreatorCbsStatusCb) (LinphoneAccountCreator *creator, LinphoneAccountCreatorStatus status, const char *resp)
 
typedef int(* LinphoneImEncryptionEngineCbsIncomingMessageCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg)
 
typedef int(* LinphoneImEncryptionEngineCbsOutgoingMessageCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg)
 
typedef bool_t(* LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room)
 
typedef void(* LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg)
 
typedef int(* LinphoneImEncryptionEngineCbsDownloadingFileCb) (LinphoneImEncryptionEngine *engine, LinphoneChatMessage *msg, const char *buffer, size_t size, char *decrypted_buffer)
 
typedef int(* LinphoneImEncryptionEngineCbsUploadingFileCb) (LinphoneImEncryptionEngine *engine, LinphoneChatMessage *msg, size_t offset, const char *buffer, size_t *size, char *encrypted_buffer)
 
typedef struct _LinphoneAccountCreator LinphoneAccountCreator
 
typedef struct _LinphoneAccountCreatorCbs LinphoneAccountCreatorCbs
 
typedef enum _LinphoneAccountCreatorStatus LinphoneAccountCreatorStatus
 
typedef struct _LinphoneBuffer LinphoneBuffer
 
typedef struct _LpConfig LinphoneConfig
 
typedef struct _LinphoneContent LinphoneContent
 
typedef struct _LinphoneErrorInfo LinphoneErrorInfo
 
typedef struct _LinphoneImEncryptionEngine LinphoneImEncryptionEngine
 
typedef struct _LinphoneImEncryptionEngineCbs LinphoneImEncryptionEngineCbs
 
typedef struct _LinphoneInfoMessage LinphoneInfoMessage
 
typedef enum _LinphoneReason LinphoneReason
 
typedef enum _LinphoneToneID LinphoneToneID
 
typedef enum _LinphoneXmlRpcArgType LinphoneXmlRpcArgType
 
typedef struct _LinphoneXmlRpcRequest LinphoneXmlRpcRequest
 
typedef struct _LinphoneXmlRpcRequestCbs LinphoneXmlRpcRequestCbs
 
typedef struct _LinphoneXmlRpcSession LinphoneXmlRpcSession
 
typedef enum _LinphoneXmlRpcStatus LinphoneXmlRpcStatus
 
typedef void(* LinphoneXmlRpcRequestCbsResponseCb) (LinphoneXmlRpcRequest *request)
 

Enumerations

enum  _LinphoneAccountCreatorStatus {
  LinphoneAccountCreatorOK,
  LinphoneAccountCreatorReqFailed,
  LinphoneAccountCreatorAccountCreated,
  LinphoneAccountCreatorAccountNotCreated,
  LinphoneAccountCreatorAccountExist,
  LinphoneAccountCreatorAccountExistWithAlias,
  LinphoneAccountCreatorAccountNotExist,
  LinphoneAccountCreatorAccountActivated,
  LinphoneAccountCreatorAccountAlreadyActivated,
  LinphoneAccountCreatorAccountNotActivated,
  LinphoneAccountCreatorAccountLinked,
  LinphoneAccountCreatorAccountNotLinked,
  LinphoneAccountCreatorEmailInvalid,
  LinphoneAccountCreatorUsernameInvalid,
  LinphoneAccountCreatorUsernameTooShort,
  LinphoneAccountCreatorUsernameTooLong,
  LinphoneAccountCreatorUsernameInvalidSize,
  LinphoneAccountCreatorPhoneNumberInvalid,
  LinphoneAccountCreatorPhoneNumberTooShort,
  LinphoneAccountCreatorPhoneNumberTooLong,
  LinphoneAccountCreatorPhoneNumberUsedAccount,
  LinphoneAccountCreatorPhoneNumberUsedAlias,
  LinphoneAccountCreatorPhoneNumberNotUsed,
  LinphoneAccountCreatorPasswordTooShort,
  LinphoneAccountCreatorPasswordTooLong,
  LinphoneAccountCreatorDomainInvalid,
  LinphoneAccountCreatorRouteInvalid,
  LinphoneAccountCreatorDisplayNameInvalid,
  LinphoneAccountCreatorTransportNotSupported,
  LinphoneAccountCreatorCountryCodeInvalid,
  LinphoneAccountCreatorErrorServer
}
 
enum  _LinphoneReason {
  LinphoneReasonNone,
  LinphoneReasonNoResponse,
  LinphoneReasonForbidden,
  LinphoneReasonDeclined,
  LinphoneReasonNotFound,
  LinphoneReasonNotAnswered,
  LinphoneReasonBusy,
  LinphoneReasonUnsupportedContent,
  LinphoneReasonIOError,
  LinphoneReasonDoNotDisturb,
  LinphoneReasonUnauthorized,
  LinphoneReasonNotAcceptable,
  LinphoneReasonNoMatch,
  LinphoneReasonMovedPermanently,
  LinphoneReasonGone,
  LinphoneReasonTemporarilyUnavailable,
  LinphoneReasonAddressIncomplete,
  LinphoneReasonNotImplemented,
  LinphoneReasonBadGateway,
  LinphoneReasonServerTimeout,
  LinphoneReasonUnknown
}
 
enum  _LinphoneToneID {
  LinphoneToneUndefined,
  LinphoneToneBusy,
  LinphoneToneCallWaiting,
  LinphoneToneCallOnHold,
  LinphoneToneCallLost
}
 
enum  _LinphoneXmlRpcArgType {
  LinphoneXmlRpcArgNone,
  LinphoneXmlRpcArgInt,
  LinphoneXmlRpcArgString
}
 
enum  _LinphoneXmlRpcStatus {
  LinphoneXmlRpcStatusPending,
  LinphoneXmlRpcStatusOk,
  LinphoneXmlRpcStatusFailed
}
 

Functions

LinphoneAccountCreatorlinphone_account_creator_new (LinphoneCore *core, const char *xmlrpc_url)
 
LinphoneAccountCreatorlinphone_account_creator_ref (LinphoneAccountCreator *creator)
 
void linphone_account_creator_unref (LinphoneAccountCreator *creator)
 
void * linphone_account_creator_get_user_data (const LinphoneAccountCreator *creator)
 
void linphone_account_creator_set_user_data (LinphoneAccountCreator *creator, void *ud)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_username (LinphoneAccountCreator *creator, const char *username)
 
const char * linphone_account_creator_get_username (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_update_password (LinphoneAccountCreator *creator, const char *new_pwd)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_phone_number (LinphoneAccountCreator *creator, const char *phone_number, const char *country_code)
 
const char * linphone_account_creator_get_phone_number (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_password (LinphoneAccountCreator *creator, const char *password)
 
const char * linphone_account_creator_get_password (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_ha1 (LinphoneAccountCreator *creator, const char *ha1)
 
const char * linphone_account_creator_get_ha1 (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_activation_code (LinphoneAccountCreator *creator, const char *activation_code)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_language (LinphoneAccountCreator *creator, const char *lang)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_transport (LinphoneAccountCreator *creator, LinphoneTransportType transport)
 
LinphoneTransportType linphone_account_creator_get_transport (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_domain (LinphoneAccountCreator *creator, const char *domain)
 
const char * linphone_account_creator_get_domain (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_route (LinphoneAccountCreator *creator, const char *route)
 
const char * linphone_account_creator_get_route (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_display_name (LinphoneAccountCreator *creator, const char *display_name)
 
const char * linphone_account_creator_get_display_name (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_set_email (LinphoneAccountCreator *creator, const char *email)
 
const char * linphone_account_creator_get_email (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorCbslinphone_account_creator_get_callbacks (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_is_account_used (LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_create_account (LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_activate_account (LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_is_account_activated (LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_is_phone_number_used (LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_link_phone_number_with_account (LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_activate_phone_number_link (LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_recover_phone_account (LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorStatus linphone_account_creator_is_account_linked (LinphoneAccountCreator *creator)
 
LinphoneProxyConfiglinphone_account_creator_configure (const LinphoneAccountCreator *creator)
 
LinphoneAccountCreatorCbslinphone_account_creator_cbs_ref (LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_unref (LinphoneAccountCreatorCbs *cbs)
 
void * linphone_account_creator_cbs_get_user_data (const LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_set_user_data (LinphoneAccountCreatorCbs *cbs, void *ud)
 
LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_update_hash (const LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_set_update_hash (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb)
 
LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_account_linked (const LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_set_is_account_linked (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb)
 
LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_account_used (const LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_set_is_account_used (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb)
 
LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_create_account (const LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_set_create_account (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb)
 
LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_activate_account (const LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_set_activate_account (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb)
 
LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_link_phone_number_with_account (const LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_set_link_phone_number_with_account (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb)
 
LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_activate_phone_number_link (const LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_set_activate_phone_number_link (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb)
 
LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_account_activated (const LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_set_is_account_activated (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb)
 
LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_phone_number_used (const LinphoneAccountCreatorCbs *cbs)
 
void linphone_account_creator_cbs_set_is_phone_number_used (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb)
 
void linphone_account_creator_cbs_set_recover_phone_account (LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb)
 
LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_recover_phone_account (const LinphoneAccountCreatorCbs *cbs)
 
LinphoneBufferlinphone_buffer_new (void)
 
LinphoneBufferlinphone_buffer_new_from_data (const uint8_t *data, size_t size)
 
LinphoneBufferlinphone_buffer_new_from_string (const char *data)
 
LinphoneBufferlinphone_buffer_ref (LinphoneBuffer *buffer)
 
void linphone_buffer_unref (LinphoneBuffer *buffer)
 
void * linphone_buffer_get_user_data (const LinphoneBuffer *buffer)
 
void linphone_buffer_set_user_data (LinphoneBuffer *buffer, void *ud)
 
const uint8_t * linphone_buffer_get_content (const LinphoneBuffer *buffer)
 
void linphone_buffer_set_content (LinphoneBuffer *buffer, const uint8_t *content, size_t size)
 
const char * linphone_buffer_get_string_content (const LinphoneBuffer *buffer)
 
void linphone_buffer_set_string_content (LinphoneBuffer *buffer, const char *content)
 
size_t linphone_buffer_get_size (const LinphoneBuffer *buffer)
 
void linphone_buffer_set_size (LinphoneBuffer *buffer, size_t size)
 
bool_t linphone_buffer_is_empty (const LinphoneBuffer *buffer)
 
LinphoneContentlinphone_content_ref (LinphoneContent *content)
 
void linphone_content_unref (LinphoneContent *content)
 
void * linphone_content_get_user_data (const LinphoneContent *content)
 
void linphone_content_set_user_data (LinphoneContent *content, void *ud)
 
const char * linphone_content_get_type (const LinphoneContent *content)
 
void linphone_content_set_type (LinphoneContent *content, const char *type)
 
const char * linphone_content_get_subtype (const LinphoneContent *content)
 
void linphone_content_set_subtype (LinphoneContent *content, const char *subtype)
 
void * linphone_content_get_buffer (const LinphoneContent *content)
 
void linphone_content_set_buffer (LinphoneContent *content, const void *buffer, size_t size)
 
const char * linphone_content_get_string_buffer (const LinphoneContent *content)
 
void linphone_content_set_string_buffer (LinphoneContent *content, const char *buffer)
 
size_t linphone_content_get_size (const LinphoneContent *content)
 
void linphone_content_set_size (LinphoneContent *content, size_t size)
 
const char * linphone_content_get_encoding (const LinphoneContent *content)
 
void linphone_content_set_encoding (LinphoneContent *content, const char *encoding)
 
const char * linphone_content_get_name (const LinphoneContent *content)
 
void linphone_content_set_name (LinphoneContent *content, const char *name)
 
bool_t linphone_content_is_multipart (const LinphoneContent *content)
 
LinphoneContentlinphone_content_get_part (const LinphoneContent *content, int idx)
 
LinphoneContentlinphone_content_find_part_by_header (const LinphoneContent *content, const char *header_name, const char *header_value)
 
const char * linphone_content_get_custom_header (const LinphoneContent *content, const char *header_name)
 
LinphonePlayerlinphone_core_create_local_player (LinphoneCore *lc, MSSndCard *snd_card, const char *video_out, void *window_id)
 
LinphoneInfoMessagelinphone_core_create_info_message (LinphoneCore *lc)
 
void linphone_core_set_user_agent (LinphoneCore *lc, const char *ua_name, const char *version)
 
LinphoneAddresslinphone_core_interpret_url (LinphoneCore *lc, const char *url)
 
int linphone_core_play_local (LinphoneCore *lc, const char *audiofile)
 
bool_t linphone_core_vcard_supported (void)
 
int linphone_core_take_preview_snapshot (LinphoneCore *lc, const char *file)
 
LinphoneConfiglinphone_core_get_config (LinphoneCore *lc)
 
LINPHONE_DEPRECATED LinphoneConfiglinphone_core_create_lp_config (LinphoneCore *lc, const char *filename)
 
LinphoneConfiglinphone_core_create_config (LinphoneCore *lc, const char *filename)
 
void linphone_core_set_call_error_tone (LinphoneCore *lc, LinphoneReason reason, const char *audiofile)
 
void linphone_core_set_file_transfer_server (LinphoneCore *core, const char *server_url)
 
const char * linphone_core_get_file_transfer_server (LinphoneCore *core)
 
LinphoneContentlinphone_core_create_content (LinphoneCore *lc)
 
int linphone_dial_plan_lookup_ccc_from_iso (const char *iso)
 
int linphone_dial_plan_lookup_ccc_from_e164 (const char *e164)
 
LinphoneReason linphone_error_info_get_reason (const LinphoneErrorInfo *ei)
 
const char * linphone_error_info_get_phrase (const LinphoneErrorInfo *ei)
 
const char * linphone_error_info_get_details (const LinphoneErrorInfo *ei)
 
int linphone_error_info_get_protocol_code (const LinphoneErrorInfo *ei)
 
LinphoneImEncryptionEngineCbslinphone_im_encryption_engine_cbs_ref (LinphoneImEncryptionEngineCbs *cbs)
 
void linphone_im_encryption_engine_cbs_unref (LinphoneImEncryptionEngineCbs *cbs)
 
void * linphone_im_encryption_engine_cbs_get_user_data (const LinphoneImEncryptionEngineCbs *cbs)
 
void linphone_im_encryption_engine_cbs_set_user_data (LinphoneImEncryptionEngineCbs *cbs, void *data)
 
LinphoneImEncryptionEnginelinphone_im_encryption_engine_ref (LinphoneImEncryptionEngine *imee)
 
void linphone_im_encryption_engine_unref (LinphoneImEncryptionEngine *imee)
 
void * linphone_im_encryption_engine_get_user_data (const LinphoneImEncryptionEngine *imee)
 
void linphone_im_encryption_engine_set_user_data (LinphoneImEncryptionEngine *imee, void *data)
 
LinphoneCorelinphone_im_encryption_engine_get_core (LinphoneImEncryptionEngine *imee)
 
LinphoneImEncryptionEngineCbslinphone_im_encryption_engine_get_callbacks (const LinphoneImEncryptionEngine *imee)
 
LinphoneImEncryptionEngineCbsIncomingMessageCb linphone_im_encryption_engine_cbs_get_process_incoming_message (LinphoneImEncryptionEngineCbs *cbs)
 
void linphone_im_encryption_engine_cbs_set_process_incoming_message (LinphoneImEncryptionEngineCbs *cbs, LinphoneImEncryptionEngineCbsIncomingMessageCb cb)
 
LinphoneImEncryptionEngineCbsOutgoingMessageCb linphone_im_encryption_engine_cbs_get_process_outgoing_message (LinphoneImEncryptionEngineCbs *cbs)
 
void linphone_im_encryption_engine_cbs_set_process_outgoing_message (LinphoneImEncryptionEngineCbs *cbs, LinphoneImEncryptionEngineCbsOutgoingMessageCb cb)
 
LinphoneImEncryptionEngineCbsDownloadingFileCb linphone_im_encryption_engine_cbs_get_process_downloading_file (LinphoneImEncryptionEngineCbs *cbs)
 
void linphone_im_encryption_engine_cbs_set_process_downloading_file (LinphoneImEncryptionEngineCbs *cbs, LinphoneImEncryptionEngineCbsDownloadingFileCb cb)
 
LinphoneImEncryptionEngineCbsUploadingFileCb linphone_im_encryption_engine_cbs_get_process_uploading_file (LinphoneImEncryptionEngineCbs *cbs)
 
void linphone_im_encryption_engine_cbs_set_process_uploading_file (LinphoneImEncryptionEngineCbs *cbs, LinphoneImEncryptionEngineCbsUploadingFileCb cb)
 
LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb linphone_im_encryption_engine_cbs_get_is_encryption_enabled_for_file_transfer (LinphoneImEncryptionEngineCbs *cbs)
 
void linphone_im_encryption_engine_cbs_set_is_encryption_enabled_for_file_transfer (LinphoneImEncryptionEngineCbs *cbs, LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb cb)
 
LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb linphone_im_encryption_engine_cbs_get_generate_file_transfer_key (LinphoneImEncryptionEngineCbs *cbs)
 
void linphone_im_encryption_engine_cbs_set_generate_file_transfer_key (LinphoneImEncryptionEngineCbs *cbs, LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb cb)
 
void linphone_info_message_add_header (LinphoneInfoMessage *im, const char *name, const char *value)
 
const char * linphone_info_message_get_header (const LinphoneInfoMessage *im, const char *name)
 
void linphone_info_message_set_content (LinphoneInfoMessage *im, const LinphoneContent *content)
 
const LinphoneContentlinphone_info_message_get_content (const LinphoneInfoMessage *im)
 
void linphone_info_message_destroy (LinphoneInfoMessage *im)
 
LinphoneInfoMessagelinphone_info_message_copy (const LinphoneInfoMessage *orig)
 
LinphoneConfiglinphone_config_new (const char *filename)
 
LinphoneConfiglinphone_config_new_from_buffer (const char *buffer)
 
LinphoneConfiglinphone_config_new_with_factory (const char *config_filename, const char *factory_config_filename)
 
int linphone_config_read_file (LinphoneConfig *lpconfig, const char *filename)
 
const char * linphone_config_get_string (const LinphoneConfig *lpconfig, const char *section, const char *key, const char *default_string)
 
bctbx_list_t * linphone_config_get_string_list (const LinphoneConfig *lpconfig, const char *section, const char *key, bctbx_list_t *default_list)
 
bool_t linphone_config_get_range (const LinphoneConfig *lpconfig, const char *section, const char *key, int *min, int *max, int default_min, int default_max)
 
int linphone_config_get_int (const LinphoneConfig *lpconfig, const char *section, const char *key, int default_value)
 
int64_t linphone_config_get_int64 (const LinphoneConfig *lpconfig, const char *section, const char *key, int64_t default_value)
 
float linphone_config_get_float (const LinphoneConfig *lpconfig, const char *section, const char *key, float default_value)
 
void linphone_config_set_string (LinphoneConfig *lpconfig, const char *section, const char *key, const char *value)
 
void linphone_config_set_string_list (LinphoneConfig *lpconfig, const char *section, const char *key, const bctbx_list_t *value)
 
void linphone_config_set_range (LinphoneConfig *lpconfig, const char *section, const char *key, int min_value, int max_value)
 
void linphone_config_set_int (LinphoneConfig *lpconfig, const char *section, const char *key, int value)
 
void linphone_config_set_int_hex (LinphoneConfig *lpconfig, const char *section, const char *key, int value)
 
void linphone_config_set_int64 (LinphoneConfig *lpconfig, const char *section, const char *key, int64_t value)
 
void linphone_config_set_float (LinphoneConfig *lpconfig, const char *section, const char *key, float value)
 
int linphone_config_sync (LinphoneConfig *lpconfig)
 
int linphone_config_has_section (const LinphoneConfig *lpconfig, const char *section)
 
void linphone_config_clean_section (LinphoneConfig *lpconfig, const char *section)
 
int linphone_config_has_entry (const LinphoneConfig *lpconfig, const char *section, const char *key)
 
void linphone_config_clean_entry (LinphoneConfig *lpconfig, const char *section, const char *key)
 
const char ** linphone_config_get_sections_names (LinphoneConfig *lpconfig)
 
void linphone_config_for_each_section (const LinphoneConfig *lpconfig, void(*callback)(const char *section, void *ctx), void *ctx)
 
void linphone_config_for_each_entry (const LinphoneConfig *lpconfig, const char *section, void(*callback)(const char *entry, void *ctx), void *ctx)
 
int linphone_config_needs_commit (const LinphoneConfig *lpconfig)
 
void linphone_config_destroy (LinphoneConfig *cfg)
 
int linphone_config_get_default_int (const LinphoneConfig *lpconfig, const char *section, const char *key, int default_value)
 
int64_t linphone_config_get_default_int64 (const LinphoneConfig *lpconfig, const char *section, const char *key, int64_t default_value)
 
float linphone_config_get_default_float (const LinphoneConfig *lpconfig, const char *section, const char *key, float default_value)
 
const char * linphone_config_get_default_string (const LinphoneConfig *lpconfig, const char *section, const char *key, const char *default_value)
 
const char * linphone_config_get_section_param_string (const LinphoneConfig *lpconfig, const char *section, const char *key, const char *default_value)
 
LinphoneConfiglinphone_config_ref (LinphoneConfig *lpconfig)
 
void linphone_config_unref (LinphoneConfig *lpconfig)
 
void linphone_config_write_relative_file (const LinphoneConfig *lpconfig, const char *filename, const char *data)
 
int linphone_config_read_relative_file (const LinphoneConfig *lpconfig, const char *filename, char *data, size_t max_length)
 
bool_t linphone_config_relative_file_exists (const LinphoneConfig *lpconfig, const char *filename)
 
char * linphone_config_dump_as_xml (const LinphoneConfig *lpconfig)
 
char * linphone_config_dump (const LinphoneConfig *lpconfig)
 
bool_t linphone_config_get_overwrite_flag_for_entry (const LinphoneConfig *lpconfig, const char *section, const char *key)
 
void linphone_config_set_overwrite_flag_for_entry (LinphoneConfig *lpconfig, const char *section, const char *key, bool_t value)
 
bool_t linphone_config_get_overwrite_flag_for_section (const LinphoneConfig *lpconfig, const char *section)
 
void linphone_config_set_overwrite_flag_for_section (LinphoneConfig *lpconfig, const char *section, bool_t value)
 
bool_t linphone_config_get_skip_flag_for_entry (const LinphoneConfig *lpconfig, const char *section, const char *key)
 
void linphone_config_set_skip_flag_for_entry (LinphoneConfig *lpconfig, const char *section, const char *key, bool_t value)
 
bool_t linphone_config_get_skip_flag_for_section (const LinphoneConfig *lpconfig, const char *section)
 
void linphone_config_set_skip_flag_for_section (LinphoneConfig *lpconfig, const char *section, bool_t value)
 
LinphoneDictionary * lp_config_section_to_dict (const LpConfig *lpconfig, const char *section)
 
void lp_config_load_dict_to_section (LpConfig *lpconfig, const char *section, const LinphoneDictionary *dict)
 
const char * linphone_configuring_state_to_string (LinphoneConfiguringState cs)
 
const char * linphone_reason_to_string (LinphoneReason err)
 
const char * linphone_transport_to_string (LinphoneTransportType transport)
 
LinphoneTransportType linphone_transport_parse (const char *transport)
 
LinphoneReason linphone_error_code_to_reason (int err)
 
int linphone_reason_to_error_code (LinphoneReason reason)
 
LinphoneXmlRpcRequestlinphone_xml_rpc_request_new (const char *method, LinphoneXmlRpcArgType return_type)
 
LinphoneXmlRpcRequestlinphone_xml_rpc_request_new_with_args (const char *method, LinphoneXmlRpcArgType return_type,...)
 
LinphoneXmlRpcRequestlinphone_xml_rpc_request_ref (LinphoneXmlRpcRequest *request)
 
void linphone_xml_rpc_request_unref (LinphoneXmlRpcRequest *request)
 
void * linphone_xml_rpc_request_get_user_data (const LinphoneXmlRpcRequest *request)
 
void linphone_xml_rpc_request_set_user_data (LinphoneXmlRpcRequest *request, void *ud)
 
void linphone_xml_rpc_request_add_int_arg (LinphoneXmlRpcRequest *request, int value)
 
void linphone_xml_rpc_request_add_string_arg (LinphoneXmlRpcRequest *request, const char *value)
 
LinphoneXmlRpcRequestCbslinphone_xml_rpc_request_get_callbacks (const LinphoneXmlRpcRequest *request)
 
const char * linphone_xml_rpc_request_get_content (const LinphoneXmlRpcRequest *request)
 
LinphoneXmlRpcStatus linphone_xml_rpc_request_get_status (const LinphoneXmlRpcRequest *request)
 
int linphone_xml_rpc_request_get_int_response (const LinphoneXmlRpcRequest *request)
 
const char * linphone_xml_rpc_request_get_string_response (const LinphoneXmlRpcRequest *request)
 
LinphoneXmlRpcSessionlinphone_xml_rpc_session_new (LinphoneCore *core, const char *url)
 
LinphoneXmlRpcSessionlinphone_xml_rpc_session_ref (LinphoneXmlRpcSession *session)
 
void linphone_xml_rpc_session_unref (LinphoneXmlRpcSession *session)
 
void * linphone_xml_rpc_session_get_user_data (const LinphoneXmlRpcSession *session)
 
void linphone_xml_rpc_session_set_user_data (LinphoneXmlRpcSession *session, void *ud)
 
void linphone_xml_rpc_session_send_request (LinphoneXmlRpcSession *session, LinphoneXmlRpcRequest *request)
 
void linphone_xml_rpc_session_release (LinphoneXmlRpcSession *session)
 
LinphoneXmlRpcRequestCbslinphone_xml_rpc_request_cbs_ref (LinphoneXmlRpcRequestCbs *cbs)
 
void linphone_xml_rpc_request_cbs_unref (LinphoneXmlRpcRequestCbs *cbs)
 
void * linphone_xml_rpc_request_cbs_get_user_data (const LinphoneXmlRpcRequestCbs *cbs)
 
void linphone_xml_rpc_request_cbs_set_user_data (LinphoneXmlRpcRequestCbs *cbs, void *ud)
 
LinphoneXmlRpcRequestCbsResponseCb linphone_xml_rpc_request_cbs_get_response (const LinphoneXmlRpcRequestCbs *cbs)
 
void linphone_xml_rpc_request_cbs_set_response (LinphoneXmlRpcRequestCbs *cbs, LinphoneXmlRpcRequestCbsResponseCb cb)
 

Detailed Description

Macro Definition Documentation

§ LINPHONE_CONFIG

#define LINPHONE_CONFIG (   obj)    BELLE_SIP_CAST(obj, LinphoneConfig);

Safely downcast a belle_sip_object into LinphoneConfig

Typedef Documentation

§ LinphoneAccountCreator

typedef struct _LinphoneAccountCreator LinphoneAccountCreator

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

§ LinphoneAccountCreatorCbs

typedef struct _LinphoneAccountCreatorCbs LinphoneAccountCreatorCbs

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

§ LinphoneAccountCreatorCbsStatusCb

typedef void(* LinphoneAccountCreatorCbsStatusCb) (LinphoneAccountCreator *creator, LinphoneAccountCreatorStatus status, const char *resp)

Callback to notify a status change of the account creator.

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

§ LinphoneAccountCreatorStatus

Enum describing the status of a LinphoneAccountCreator operation.

§ LinphoneBuffer

typedef struct _LinphoneBuffer LinphoneBuffer

The LinphoneContent object representing a data buffer.

§ LinphoneConfig

typedef struct _LpConfig LinphoneConfig

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 []
  • each section contains a sequence of key=value pairs.

Example:

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

§ LinphoneContent

typedef struct _LinphoneContent LinphoneContent

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

§ LinphoneErrorInfo

typedef struct _LinphoneErrorInfo LinphoneErrorInfo

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

§ LinphoneImEncryptionEngine

typedef struct _LinphoneImEncryptionEngine LinphoneImEncryptionEngine

IM encryption engine.

§ LinphoneImEncryptionEngineCbs

typedef struct _LinphoneImEncryptionEngineCbs LinphoneImEncryptionEngineCbs

An object to handle the callbacks for the handling a LinphoneImEncryptionEngine object.

§ LinphoneImEncryptionEngineCbsDownloadingFileCb

typedef int(* LinphoneImEncryptionEngineCbsDownloadingFileCb) (LinphoneImEncryptionEngine *engine, LinphoneChatMessage *msg, const char *buffer, size_t size, char *decrypted_buffer)

Callback to decrypt downloading file

Parameters
engineLinphoneImEncryptionEngine object
msgLinphoneChatMessage object
bufferEncrypted data buffer
sizeSize of the encrypted data buffer
decrypted_bufferBuffer in which to write the decrypted data
Returns
-1 if nothing to be done, 0 on success or an integer > 0 for error

§ LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb

typedef void(* LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg)

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

Parameters
engineLinphoneImEncryptionEngine object
roomLinphoneChatRoom object
msgLinphoneChatMessage object

§ LinphoneImEncryptionEngineCbsIncomingMessageCb

typedef int(* LinphoneImEncryptionEngineCbsIncomingMessageCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg)

Callback to decrypt incoming LinphoneChatMessage

Parameters
engineImEncryptionEngine object
roomLinphoneChatRoom object
msgLinphoneChatMessage object
Returns
-1 if nothing to be done, 0 on success or an integer > 0 for error

§ LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb

typedef bool_t(* LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room)

Callback to know whether or not the engine will encrypt files before uploading them

Parameters
engineLinphoneImEncryptionEngine object
roomLinphoneChatRoom object
Returns
TRUE if files will be encrypted, FALSE otherwise

§ LinphoneImEncryptionEngineCbsOutgoingMessageCb

typedef int(* LinphoneImEncryptionEngineCbsOutgoingMessageCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg)

Callback to encrypt outgoing LinphoneChatMessage

Parameters
engineLinphoneImEncryptionEngine object
roomLinphoneChatRoom object
msgLinphoneChatMessage object
Returns
-1 if nothing to be done, 0 on success or an integer > 0 for error

§ LinphoneImEncryptionEngineCbsUploadingFileCb

typedef int(* LinphoneImEncryptionEngineCbsUploadingFileCb) (LinphoneImEncryptionEngine *engine, LinphoneChatMessage *msg, size_t offset, const char *buffer, size_t *size, char *encrypted_buffer)

Callback to encrypt uploading file

Parameters
engineLinphoneImEncryptionEngine object
msgLinphoneChatMessage object
offsetThe current offset of the upload
bufferEncrypted data buffer
sizeSize of the plain data buffer and the size of the encrypted data buffer once encryption is done
encrypted_bufferBuffer in which to write the encrypted data
Returns
-1 if nothing to be done, 0 on success or an integer > 0 for error

§ LinphoneInfoMessage

typedef struct _LinphoneInfoMessage LinphoneInfoMessage

The LinphoneInfoMessage is an object representing an informational message sent or received by the core.

§ LinphoneReason

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

See also
linphone_call_get_reason()
linphone_proxy_config_get_error()
linphone_error_info_get_reason()

§ LinphoneToneID

Enum listing frequent telephony tones.

§ LinphoneXmlRpcArgType

Enum describing the types of argument for LinphoneXmlRpcRequest.

§ LinphoneXmlRpcRequest

typedef struct _LinphoneXmlRpcRequest LinphoneXmlRpcRequest

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

§ LinphoneXmlRpcRequestCbs

typedef struct _LinphoneXmlRpcRequestCbs LinphoneXmlRpcRequestCbs

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

§ LinphoneXmlRpcRequestCbsResponseCb

typedef void(* LinphoneXmlRpcRequestCbsResponseCb) (LinphoneXmlRpcRequest *request)

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

Parameters
[in]requestLinphoneXmlRpcRequest object

§ LinphoneXmlRpcSession

typedef struct _LinphoneXmlRpcSession LinphoneXmlRpcSession

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

§ LinphoneXmlRpcStatus

Enum describing the status of a LinphoneXmlRpcRequest.

Enumeration Type Documentation

§ _LinphoneAccountCreatorStatus

Enum describing the status of a LinphoneAccountCreator operation.

§ _LinphoneReason

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

See also
linphone_call_get_reason()
linphone_proxy_config_get_error()
linphone_error_info_get_reason()
Enumerator
LinphoneReasonNone 

No reason has been set by the core

LinphoneReasonNoResponse 

No response received from remote

LinphoneReasonForbidden 

Authentication failed due to bad credentials or resource forbidden

LinphoneReasonDeclined 

The call has been declined

LinphoneReasonNotFound 

Destination of the call was not found

LinphoneReasonNotAnswered 

The call was not answered in time (request timeout)

LinphoneReasonBusy 

Phone line was busy

LinphoneReasonUnsupportedContent 

Unsupported content

LinphoneReasonIOError 

Transport error: connection failures, disconnections etc...

LinphoneReasonDoNotDisturb 

Do not disturb reason

LinphoneReasonUnauthorized 

Operation is unauthorized because missing credential

LinphoneReasonNotAcceptable 

Operation is rejected due to incompatible or unsupported media parameters

LinphoneReasonNoMatch 

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

LinphoneReasonMovedPermanently 

Resource moved permanently

LinphoneReasonGone 

Resource no longer exists

LinphoneReasonTemporarilyUnavailable 

Temporarily unavailable

LinphoneReasonAddressIncomplete 

Address incomplete

LinphoneReasonNotImplemented 

Not implemented

LinphoneReasonBadGateway 

Bad gateway

LinphoneReasonServerTimeout 

Server timeout

LinphoneReasonUnknown 

Unknown reason

§ _LinphoneToneID

Enum listing frequent telephony tones.

Enumerator
LinphoneToneUndefined 

Not a tone

LinphoneToneBusy 

Busy tone

LinphoneToneCallOnHold 

Call waiting tone

LinphoneToneCallLost 

Call on hold tone Tone played when call is abruptly disconnected (media lost)

§ _LinphoneXmlRpcArgType

Enum describing the types of argument for LinphoneXmlRpcRequest.

§ _LinphoneXmlRpcStatus

Enum describing the status of a LinphoneXmlRpcRequest.

Function Documentation

§ linphone_account_creator_activate_account()

LinphoneAccountCreatorStatus linphone_account_creator_activate_account ( LinphoneAccountCreator creator)

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

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

§ linphone_account_creator_activate_phone_number_link()

LinphoneAccountCreatorStatus linphone_account_creator_activate_phone_number_link ( LinphoneAccountCreator creator)

Send an XML-RPC request to activate the link of a phone number with a Linphone account.

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

§ linphone_account_creator_cbs_get_activate_account()

LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_activate_account ( const LinphoneAccountCreatorCbs cbs)

Get the activate account callback.

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

§ linphone_account_creator_cbs_get_activate_phone_number_link()

LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_activate_phone_number_link ( const LinphoneAccountCreatorCbs cbs)

Get the activate phone number link callback.

Parameters
[in]cbsLinphoneAccountCreatorCbs object.
Returns
The current activate phone number link callback.

§ linphone_account_creator_cbs_get_create_account()

LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_create_account ( const LinphoneAccountCreatorCbs cbs)

Get the create account callback.

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

§ linphone_account_creator_cbs_get_is_account_activated()

LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_account_activated ( const LinphoneAccountCreatorCbs cbs)

Get the validation tested callback.

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

§ linphone_account_creator_cbs_get_is_account_linked()

LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_account_linked ( const LinphoneAccountCreatorCbs cbs)

Get the current linked tested callback.

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

§ linphone_account_creator_cbs_get_is_account_used()

LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_account_used ( const LinphoneAccountCreatorCbs cbs)

Get the existence tested callback.

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

§ linphone_account_creator_cbs_get_is_phone_number_used()

LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_is_phone_number_used ( const LinphoneAccountCreatorCbs cbs)

Get the is phone number used callback.

Parameters
[in]cbsLinphoneAccountCreatorCbs object.
Returns
The current is phone number used callback

§ linphone_account_creator_cbs_get_link_phone_number_with_account()

LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_link_phone_number_with_account ( const LinphoneAccountCreatorCbs cbs)

Get the link phone number with account callback.

Parameters
[in]cbsLinphoneAccountCreatorCbs object.
Returns
The current link phone number with account callback.

§ linphone_account_creator_cbs_get_update_hash()

LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_get_update_hash ( const LinphoneAccountCreatorCbs cbs)

Retrieve the user pointer associated with a LinphoneAccountCreatorCbs object.

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

§ linphone_account_creator_cbs_get_user_data()

void* linphone_account_creator_cbs_get_user_data ( const LinphoneAccountCreatorCbs cbs)

Retrieve the user pointer associated with a LinphoneAccountCreatorCbs object.

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

§ linphone_account_creator_cbs_ref()

LinphoneAccountCreatorCbs* linphone_account_creator_cbs_ref ( LinphoneAccountCreatorCbs cbs)

Acquire a reference to a LinphoneAccountCreatorCbs object.

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

§ linphone_account_creator_cbs_set_activate_account()

void linphone_account_creator_cbs_set_activate_account ( LinphoneAccountCreatorCbs cbs,
LinphoneAccountCreatorCbsStatusCb  cb 
)

Set the activate account callback.

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

§ linphone_account_creator_cbs_set_activate_phone_number_link()

void linphone_account_creator_cbs_set_activate_phone_number_link ( LinphoneAccountCreatorCbs cbs,
LinphoneAccountCreatorCbsStatusCb  cb 
)

Set the activate phone number link callback.

Parameters
[in]cbsLinphoneAccountCreatorCbs object.
[in]cbThe activate phone number link callback to be used.

§ linphone_account_creator_cbs_set_create_account()

void linphone_account_creator_cbs_set_create_account ( LinphoneAccountCreatorCbs cbs,
LinphoneAccountCreatorCbsStatusCb  cb 
)

Set the create account callback.

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

§ linphone_account_creator_cbs_set_is_account_activated()

void linphone_account_creator_cbs_set_is_account_activated ( LinphoneAccountCreatorCbs cbs,
LinphoneAccountCreatorCbsStatusCb  cb 
)

Set the validation tested callback.

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

§ linphone_account_creator_cbs_set_is_account_linked()

void linphone_account_creator_cbs_set_is_account_linked ( LinphoneAccountCreatorCbs cbs,
LinphoneAccountCreatorCbsStatusCb  cb 
)

Set the linked tested callback

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

§ linphone_account_creator_cbs_set_is_account_used()

void linphone_account_creator_cbs_set_is_account_used ( LinphoneAccountCreatorCbs cbs,
LinphoneAccountCreatorCbsStatusCb  cb 
)

Set the existence tested callback.

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

§ linphone_account_creator_cbs_set_is_phone_number_used()

void linphone_account_creator_cbs_set_is_phone_number_used ( LinphoneAccountCreatorCbs cbs,
LinphoneAccountCreatorCbsStatusCb  cb 
)

Set the is phone number used callback.

Parameters
[in]cbsLinphoneAccountCreatorCbs object.
[in]cbis phone number to be used.

§ linphone_account_creator_cbs_set_link_phone_number_with_account()

void linphone_account_creator_cbs_set_link_phone_number_with_account ( LinphoneAccountCreatorCbs cbs,
LinphoneAccountCreatorCbsStatusCb  cb 
)

Set the link phone number with account callback.

Parameters
[in]cbsLinphoneAccountCreatorCbs object.
[in]cbThe link phone number with account callback to be used.

§ linphone_account_creator_cbs_set_update_hash()

void linphone_account_creator_cbs_set_update_hash ( LinphoneAccountCreatorCbs cbs,
LinphoneAccountCreatorCbsStatusCb  cb 
)

Assign a user pointer to a LinphoneAccountCreatorCbs object.

Parameters
[in]cbsLinphoneAccountCreatorCbs object.
[in]cbThe update hash callback to be used.

§ linphone_account_creator_cbs_set_user_data()

void linphone_account_creator_cbs_set_user_data ( LinphoneAccountCreatorCbs cbs,
void *  ud 
)

Assign a user pointer to a LinphoneAccountCreatorCbs object.

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

§ linphone_account_creator_cbs_unref()

void linphone_account_creator_cbs_unref ( LinphoneAccountCreatorCbs cbs)

Release a reference to a LinphoneAccountCreatorCbs object.

Parameters
[in]cbsLinphoneAccountCreatorCbs object.

§ linphone_account_creator_configure()

LinphoneProxyConfig* linphone_account_creator_configure ( const LinphoneAccountCreator creator)

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

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

§ linphone_account_creator_create_account()

LinphoneAccountCreatorStatus linphone_account_creator_create_account ( LinphoneAccountCreator creator)

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

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

§ linphone_account_creator_get_callbacks()

LinphoneAccountCreatorCbs* linphone_account_creator_get_callbacks ( const LinphoneAccountCreator creator)

Get the LinphoneAccountCreatorCbs object associated with a LinphoneAccountCreator.

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

§ linphone_account_creator_get_display_name()

const char* linphone_account_creator_get_display_name ( const LinphoneAccountCreator creator)

Get the email.

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

§ linphone_account_creator_get_domain()

const char* linphone_account_creator_get_domain ( const LinphoneAccountCreator creator)

Get the domain.

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

§ linphone_account_creator_get_email()

const char* linphone_account_creator_get_email ( const LinphoneAccountCreator creator)

Get the email.

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

§ linphone_account_creator_get_ha1()

const char* linphone_account_creator_get_ha1 ( const LinphoneAccountCreator creator)

Get the ha1.

Parameters
[in]creatorLinphoneAccountCreator object
Returns
The ha1 of the LinphoneAccountCreator

§ linphone_account_creator_get_password()

const char* linphone_account_creator_get_password ( const LinphoneAccountCreator creator)

Get the password.

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

§ linphone_account_creator_get_phone_number()

const char* linphone_account_creator_get_phone_number ( const LinphoneAccountCreator creator)

Get the RFC 3966 normalized phone number.

Parameters
[in]creatorLinphoneAccountCreator object
Returns
The phone number of the LinphoneAccountCreator

§ linphone_account_creator_get_route()

const char* linphone_account_creator_get_route ( const LinphoneAccountCreator creator)

Get the route.

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

§ linphone_account_creator_get_transport()

LinphoneTransportType linphone_account_creator_get_transport ( const LinphoneAccountCreator creator)

Get the transport.

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

§ linphone_account_creator_get_user_data()

void* linphone_account_creator_get_user_data ( const LinphoneAccountCreator creator)

Retrieve the user pointer associated with the LinphoneAccountCreator.

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

§ linphone_account_creator_get_username()

const char* linphone_account_creator_get_username ( const LinphoneAccountCreator creator)

Get the username.

Parameters
[in]creatorLinphoneAccountCreator object
Returns
The username of the LinphoneAccountCreator

§ linphone_account_creator_is_account_activated()

LinphoneAccountCreatorStatus linphone_account_creator_is_account_activated ( LinphoneAccountCreator creator)

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

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

§ linphone_account_creator_is_account_linked()

LinphoneAccountCreatorStatus linphone_account_creator_is_account_linked ( LinphoneAccountCreator creator)

Send an XML-RPC request to ask if an account is linked with a phone number

Parameters
[in]creatorLinphoneAccountCreator object
Returns
if this account is linked with a phone number

§ linphone_account_creator_is_account_used()

LinphoneAccountCreatorStatus linphone_account_creator_is_account_used ( LinphoneAccountCreator creator)

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

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

§ linphone_account_creator_is_phone_number_used()

LinphoneAccountCreatorStatus linphone_account_creator_is_phone_number_used ( LinphoneAccountCreator creator)

Send an XML-RPC request to test the existence a phone number with a Linphone account.

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

§ linphone_account_creator_link_phone_number_with_account()

LinphoneAccountCreatorStatus linphone_account_creator_link_phone_number_with_account ( LinphoneAccountCreator creator)

Send an XML-RPC request to link a phone number with a Linphone account.

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

§ linphone_account_creator_new()

LinphoneAccountCreator* linphone_account_creator_new ( LinphoneCore core,
const char *  xmlrpc_url 
)

Create a LinphoneAccountCreator.

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

§ linphone_account_creator_ref()

LinphoneAccountCreator* linphone_account_creator_ref ( LinphoneAccountCreator creator)

Acquire a reference to the LinphoneAccountCreator.

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

§ linphone_account_creator_set_activation_code()

LinphoneAccountCreatorStatus linphone_account_creator_set_activation_code ( LinphoneAccountCreator creator,
const char *  activation_code 
)

Set the activation code.

Parameters
[in]creatorLinphoneAccountCreator object
[in]activation_codeThe activation code to set

§ linphone_account_creator_set_display_name()

LinphoneAccountCreatorStatus linphone_account_creator_set_display_name ( LinphoneAccountCreator creator,
const char *  display_name 
)

Set the email.

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

§ linphone_account_creator_set_domain()

LinphoneAccountCreatorStatus linphone_account_creator_set_domain ( LinphoneAccountCreator creator,
const char *  domain 
)

Set the domain.

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

§ linphone_account_creator_set_email()

LinphoneAccountCreatorStatus linphone_account_creator_set_email ( LinphoneAccountCreator creator,
const char *  email 
)

Set the email.

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

§ linphone_account_creator_set_ha1()

LinphoneAccountCreatorStatus linphone_account_creator_set_ha1 ( LinphoneAccountCreator creator,
const char *  ha1 
)

Set the ha1.

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

§ linphone_account_creator_set_language()

LinphoneAccountCreatorStatus linphone_account_creator_set_language ( LinphoneAccountCreator creator,
const char *  lang 
)

Set the language to use in email or SMS if supported.

Parameters
[in]creatorLinphoneAccountCreator object
[in]langThe language to use

§ linphone_account_creator_set_password()

LinphoneAccountCreatorStatus linphone_account_creator_set_password ( LinphoneAccountCreator creator,
const char *  password 
)

Set the password.

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

§ linphone_account_creator_set_phone_number()

LinphoneAccountCreatorStatus linphone_account_creator_set_phone_number ( LinphoneAccountCreator creator,
const char *  phone_number,
const char *  country_code 
)

Set the phone number normalized.

Parameters
[in]creatorLinphoneAccountCreator object
[in]phone_numberThe phone number to set
[in]country_codeCountry code to associate phone number with
Returns
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.

§ linphone_account_creator_set_route()

LinphoneAccountCreatorStatus linphone_account_creator_set_route ( LinphoneAccountCreator creator,
const char *  route 
)

Set the route.

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

§ linphone_account_creator_set_transport()

LinphoneAccountCreatorStatus linphone_account_creator_set_transport ( LinphoneAccountCreator creator,
LinphoneTransportType  transport 
)

Set the transport.

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

§ linphone_account_creator_set_user_data()

void linphone_account_creator_set_user_data ( LinphoneAccountCreator creator,
void *  ud 
)

Assign a user pointer to the LinphoneAccountCreator.

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

§ linphone_account_creator_set_username()

LinphoneAccountCreatorStatus linphone_account_creator_set_username ( LinphoneAccountCreator creator,
const char *  username 
)

Set the username.

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

§ linphone_account_creator_unref()

void linphone_account_creator_unref ( LinphoneAccountCreator creator)

Release reference to the LinphoneAccountCreator.

Parameters
[in]creatorLinphoneAccountCreator object.

§ linphone_account_creator_update_password()

LinphoneAccountCreatorStatus linphone_account_creator_update_password ( LinphoneAccountCreator creator,
const char *  new_pwd 
)

Update the password.

Parameters
[in]creatorLinphoneAccountCreator object
[in]new_pwdconst char * : new password for the account creator
Returns
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.

§ linphone_buffer_get_content()

const uint8_t* linphone_buffer_get_content ( const LinphoneBuffer buffer)

Get the content of the data buffer.

Parameters
[in]bufferLinphoneBuffer object.
Returns
The content of the data buffer.

§ linphone_buffer_get_size()

size_t linphone_buffer_get_size ( const LinphoneBuffer buffer)

Get the size of the content of the data buffer.

Parameters
[in]bufferLinphoneBuffer object.
Returns
The size of the content of the data buffer.

§ linphone_buffer_get_string_content()

const char* linphone_buffer_get_string_content ( const LinphoneBuffer buffer)

Get the string content of the data buffer.

Parameters
[in]bufferLinphoneBuffer object
Returns
The string content of the data buffer.

§ linphone_buffer_get_user_data()

void* linphone_buffer_get_user_data ( const LinphoneBuffer buffer)

Retrieve the user pointer associated with the buffer.

Parameters
[in]bufferLinphoneBuffer object.
Returns
The user pointer associated with the buffer.

§ linphone_buffer_is_empty()

bool_t linphone_buffer_is_empty ( const LinphoneBuffer buffer)

Tell whether the LinphoneBuffer is empty.

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

§ linphone_buffer_new()

LinphoneBuffer* linphone_buffer_new ( void  )

Create a new empty LinphoneBuffer object.

Returns
A new LinphoneBuffer object.

§ linphone_buffer_new_from_data()

LinphoneBuffer* linphone_buffer_new_from_data ( const uint8_t *  data,
size_t  size 
)

Create a new LinphoneBuffer object from existing data.

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

§ linphone_buffer_new_from_string()

LinphoneBuffer* linphone_buffer_new_from_string ( const char *  data)

Create a new LinphoneBuffer object from a string.

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

§ linphone_buffer_ref()

LinphoneBuffer* linphone_buffer_ref ( LinphoneBuffer buffer)

Acquire a reference to the buffer.

Parameters
[in]bufferLinphoneBuffer object.
Returns
The same LinphoneBuffer object.

§ linphone_buffer_set_content()

void linphone_buffer_set_content ( LinphoneBuffer buffer,
const uint8_t *  content,
size_t  size 
)

Set the content of the data buffer.

Parameters
[in]bufferLinphoneBuffer object.
[in]contentThe content of the data buffer.
[in]sizeThe size of the content of the data buffer.

§ linphone_buffer_set_size()

void linphone_buffer_set_size ( LinphoneBuffer buffer,
size_t  size 
)

Set the size of the content of the data buffer.

Parameters
[in]bufferLinphoneBuffer object
[in]sizeThe size of the content of the data buffer.

§ linphone_buffer_set_string_content()

void linphone_buffer_set_string_content ( LinphoneBuffer buffer,
const char *  content 
)

Set the string content of the data buffer.

Parameters
[in]bufferLinphoneBuffer object.
[in]contentThe string content of the data buffer.

§ linphone_buffer_set_user_data()

void linphone_buffer_set_user_data ( LinphoneBuffer buffer,
void *  ud 
)

Assign a user pointer to the buffer.

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

§ linphone_buffer_unref()

void linphone_buffer_unref ( LinphoneBuffer buffer)

Release reference to the buffer.

Parameters
[in]bufferLinphoneBuffer object.

§ linphone_config_clean_entry()

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

Removes entries for key,value in a section.

Parameters
[in]lpconfigThe LinphoneConfig object
[in]section
[in]key

§ linphone_config_clean_section()

void linphone_config_clean_section ( LinphoneConfig lpconfig,
const char *  section 
)

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

§ linphone_config_dump()

char* linphone_config_dump ( const LinphoneConfig lpconfig)

Dumps the LinphoneConfig as INI into a buffer

Parameters
[in]lpconfigThe LinphoneConfig object
Returns
The buffer that contains the config dump

§ linphone_config_dump_as_xml()

char* linphone_config_dump_as_xml ( const LinphoneConfig lpconfig)

Dumps the LinphoneConfig as XML into a buffer

Parameters
[in]lpconfigThe LinphoneConfig object
Returns
The buffer that contains the XML dump

§ linphone_config_for_each_entry()

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

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

§ linphone_config_for_each_section()

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

Call a function for each section present in the configuration.

§ linphone_config_get_default_float()

float linphone_config_get_default_float ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
float  default_value 
)

Retrieves a default configuration item as a float, given its section, key, and default value. The default float value is returned if the config item isn't found.

§ linphone_config_get_default_int()

int linphone_config_get_default_int ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
int  default_value 
)

Retrieves a default configuration item as an integer, given its section, key, and default value. The default integer value is returned if the config item isn't found.

§ linphone_config_get_default_int64()

int64_t linphone_config_get_default_int64 ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
int64_t  default_value 
)

Retrieves a default configuration item as a 64 bit integer, given its section, key, and default value. The default integer value is returned if the config item isn't found.

§ linphone_config_get_default_string()

const char* linphone_config_get_default_string ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
const char *  default_value 
)

Retrieves a default configuration item as a string, given its section, key, and default value. The default value string is returned if the config item isn't found.

§ linphone_config_get_float()

float linphone_config_get_float ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
float  default_value 
)

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

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

§ linphone_config_get_int()

int linphone_config_get_int ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
int  default_value 
)

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

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

§ linphone_config_get_int64()

int64_t linphone_config_get_int64 ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
int64_t  default_value 
)

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

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

§ linphone_config_get_overwrite_flag_for_entry()

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

Retrieves the overwrite flag for a config item

§ linphone_config_get_overwrite_flag_for_section()

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

Retrieves the overwrite flag for a config section

§ linphone_config_get_range()

bool_t linphone_config_get_range ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
int *  min,
int *  max,
int  default_min,
int  default_max 
)

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

Returns
TRUE if the value is successfully parsed as a range, FALSE otherwise. If FALSE is returned, min and max are filled respectively with default_min and default_max values.

§ linphone_config_get_section_param_string()

const char* linphone_config_get_section_param_string ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
const char *  default_value 
)

Retrieves a section parameter item as a string, given its section and key. The default value string is returned if the config item isn't found.

§ linphone_config_get_sections_names()

const char** linphone_config_get_sections_names ( LinphoneConfig lpconfig)

Returns the list of sections' names in the LinphoneConfig.

Parameters
[in]lpconfigThe LinphoneConfig object
Returns
a null terminated static array of strings

§ linphone_config_get_skip_flag_for_entry()

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

Retrieves the skip flag for a config item

§ linphone_config_get_skip_flag_for_section()

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

Retrieves the skip flag for a config section

§ linphone_config_get_string()

const char* linphone_config_get_string ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
const char *  default_string 
)

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

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

§ linphone_config_get_string_list()

bctbx_list_t* linphone_config_get_string_list ( const LinphoneConfig lpconfig,
const char *  section,
const char *  key,
bctbx_list_t *  default_list 
)

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

Parameters
[in]lpconfigA LinphoneConfig object
[in]sectionThe section from which to retrieve a configuration item
[in]keyThe name of the configuration item to retrieve
[in]default_listA list of const char * objects.
Returns
A list of const char * objects.

§ linphone_config_has_entry()

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

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

Parameters
[in]lpconfigThe LinphoneConfig object
[in]section
[in]key

§ linphone_config_has_section()

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

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

§ linphone_config_new()

LinphoneConfig* linphone_config_new ( const char *  filename)

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

Parameters
filenamethe filename of the config file to read to fill the instantiated LinphoneConfig
See also
linphone_config_new_with_factory

§ linphone_config_new_from_buffer()

LinphoneConfig* linphone_config_new_from_buffer ( const char *  buffer)

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

Parameters
bufferthe buffer from which the LinphoneConfig will be retrieved. We expect the buffer to be null-terminated.
See also
linphone_config_new_with_factory
linphone_config_new

§ linphone_config_new_with_factory()

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

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

Parameters
config_filenamethe filename of the user config file to read to fill the instantiated LinphoneConfig
factory_config_filenamethe filename of the factory config file to read to fill the instantiated LinphoneConfig
See also
linphone_config_new

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

§ linphone_config_read_file()

int linphone_config_read_file ( LinphoneConfig lpconfig,
const char *  filename 
)

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

Parameters
lpconfigThe LinphoneConfig object to fill with the content of the file
filenameThe filename of the config file to read to fill the LinphoneConfig

§ linphone_config_read_relative_file()

int linphone_config_read_relative_file ( const LinphoneConfig lpconfig,
const char *  filename,
char *  data,
size_t  max_length 
)

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

Parameters
lpconfigLinphoneConfig instance used as a reference
filenameName of the file where data will be read from. The name is relative to the place of the config file
dataBuffer where read string will be stored
max_lengthLength of the buffer
Returns
0 on success, -1 on failure

§ linphone_config_ref()

LinphoneConfig* linphone_config_ref ( LinphoneConfig lpconfig)

increment reference count

§ linphone_config_relative_file_exists()

bool_t linphone_config_relative_file_exists ( const LinphoneConfig lpconfig,
const char *  filename 
)
Returns
TRUE if file exists relative to the to the current location

§ linphone_config_set_float()

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

Sets a float config item

§ linphone_config_set_int()

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

Sets an integer config item

§ linphone_config_set_int64()

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

Sets a 64 bits integer config item

§ linphone_config_set_int_hex()

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

Sets an integer config item, but store it as hexadecimal

§ linphone_config_set_overwrite_flag_for_entry()

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

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

§ linphone_config_set_overwrite_flag_for_section()

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

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

§ linphone_config_set_range()

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

Sets a range config item

§ linphone_config_set_skip_flag_for_entry()

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

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

§ linphone_config_set_skip_flag_for_section()

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

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

§ linphone_config_set_string()

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

Sets a string config item

§ linphone_config_set_string_list()

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

Sets a string list config item

Parameters
[in]lpconfigA LinphoneConfig object
[in]sectionThe name of the section to put the configuration item into
[in]keyThe name of the configuration item to set
[in]valueA list of const char * objects. The value to set

§ linphone_config_sync()

int linphone_config_sync ( LinphoneConfig lpconfig)

Writes the config file to disk.

§ linphone_config_unref()

void linphone_config_unref ( LinphoneConfig lpconfig)

Decrement reference count, which will eventually free the object.

§ linphone_config_write_relative_file()

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

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

Parameters
lpconfigLinphoneConfig instance used as a reference
filenameName of the file where to write data. The name is relative to the place of the config file
dataString to write

§ linphone_configuring_state_to_string()

const char* linphone_configuring_state_to_string ( LinphoneConfiguringState  cs)

Converts a _LinphoneConfiguringState enum to a string.

§ linphone_content_find_part_by_header()

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

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

Parameters
[in]contentLinphoneContent object.
[in]header_nameThe name of the header to look for.
[in]header_valueThe value of the header to look for.
Returns
A LinphoneContent object object the part if found, NULL otherwise.

§ linphone_content_get_buffer()

void* linphone_content_get_buffer ( const LinphoneContent content)

Get the content data buffer, usually a string.

Parameters
[in]contentLinphoneContent object.
Returns
The content data buffer.

§ linphone_content_get_custom_header()

const char* linphone_content_get_custom_header ( const LinphoneContent content,
const char *  header_name 
)

Get a custom header value of a content.

Parameters
[in]contentLinphoneContent object.
[in]header_nameThe name of the header to get the value from.
Returns
The value of the header if found, NULL otherwise.

§ linphone_content_get_encoding()

const char* linphone_content_get_encoding ( const LinphoneContent content)

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

Parameters
[in]contentLinphoneContent object.
Returns
The encoding of the data buffer.

§ linphone_content_get_name()

const char* linphone_content_get_name ( const LinphoneContent content)

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

Parameters
[in]contentLinphoneContent object.
Returns
The name of the content.

§ linphone_content_get_part()

LinphoneContent* linphone_content_get_part ( const LinphoneContent content,
int  idx 
)

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

Parameters
[in]contentLinphoneContent object.
[in]idxThe index of the part to get.
Returns
A LinphoneContent object holding the part if found, NULL otherwise.

§ linphone_content_get_size()

size_t linphone_content_get_size ( const LinphoneContent content)

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

Parameters
[in]contentLinphoneContent object.
Returns
The content data buffer size.

§ linphone_content_get_string_buffer()

const char* linphone_content_get_string_buffer ( const LinphoneContent content)

Get the string content data buffer.

Parameters
[in]contentLinphoneContent object
Returns
The string content data buffer.

§ linphone_content_get_subtype()

const char* linphone_content_get_subtype ( const LinphoneContent content)

Get the mime subtype of the content data.

Parameters
[in]contentLinphoneContent object.
Returns
The mime subtype of the content data, for example "html".

§ linphone_content_get_type()

const char* linphone_content_get_type ( const LinphoneContent content)

Get the mime type of the content data.

Parameters
[in]contentLinphoneContent object.
Returns
The mime type of the content data, for example "application".

§ linphone_content_get_user_data()

void* linphone_content_get_user_data ( const LinphoneContent content)

Retrieve the user pointer associated with the content.

Parameters
[in]contentLinphoneContent object.
Returns
The user pointer associated with the content.

§ linphone_content_is_multipart()

bool_t linphone_content_is_multipart ( const LinphoneContent content)

Tell whether a content is a multipart content.

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

§ linphone_content_ref()

LinphoneContent* linphone_content_ref ( LinphoneContent content)

Acquire a reference to the content.

Parameters
[in]contentLinphoneContent object.
Returns
The same LinphoneContent object.

§ linphone_content_set_buffer()

void linphone_content_set_buffer ( LinphoneContent content,
const void *  buffer,
size_t  size 
)

Set the content data buffer, usually a string.

Parameters
[in]contentLinphoneContent object.
[in]bufferThe content data buffer.
[in]sizeThe size of the content data buffer.

§ linphone_content_set_encoding()

void linphone_content_set_encoding ( LinphoneContent content,
const char *  encoding 
)

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

Parameters
[in]contentLinphoneContent object.
[in]encodingThe encoding of the data buffer.

§ linphone_content_set_name()

void linphone_content_set_name ( LinphoneContent content,
const char *  name 
)

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

Parameters
[in]contentLinphoneContent object.
[in]nameThe name of the content.

§ linphone_content_set_size()

void linphone_content_set_size ( LinphoneContent content,
size_t  size 
)

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

Parameters
[in]contentLinphoneContent object
[in]sizeThe content data buffer size.

§ linphone_content_set_string_buffer()

void linphone_content_set_string_buffer ( LinphoneContent content,
const char *  buffer 
)

Set the string content data buffer.

Parameters
[in]contentLinphoneContent object.
[in]bufferThe string content data buffer.

§ linphone_content_set_subtype()

void linphone_content_set_subtype ( LinphoneContent content,
const char *  subtype 
)

Set the mime subtype of the content data.

Parameters
[in]contentLinphoneContent object.
[in]subtypeThe mime subtype of the content data, for example "html".

§ linphone_content_set_type()

void linphone_content_set_type ( LinphoneContent content,
const char *  type 
)

Set the mime type of the content data.

Parameters
[in]contentLinphoneContent object.
[in]typeThe mime type of the content data, for example "application".

§ linphone_content_set_user_data()

void linphone_content_set_user_data ( LinphoneContent content,
void *  ud 
)

Assign a user pointer to the content.

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

§ linphone_content_unref()

void linphone_content_unref ( LinphoneContent content)

Release reference to the content.

Parameters
[in]contentLinphoneContent object.

§ linphone_core_create_config()

LinphoneConfig* linphone_core_create_config ( LinphoneCore lc,
const char *  filename 
)

Create a LinphoneConfig object from a user config file.

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

§ linphone_core_create_content()

LinphoneContent* linphone_core_create_content ( LinphoneCore lc)

Create a content with default values from Linphone core.

Parameters
[in]lcLinphoneCore object
Returns
LinphoneContent object with default values set

§ linphone_core_create_info_message()

LinphoneInfoMessage* linphone_core_create_info_message ( LinphoneCore lc)

Creates an empty info message.

Parameters
lcthe LinphoneCore
Returns
a new LinphoneInfoMessage.

The info message can later be filled with information using linphone_info_message_add_header() or linphone_info_message_set_content(), and finally sent with linphone_core_send_info_message().

§ linphone_core_create_local_player()

LinphonePlayer* linphone_core_create_local_player ( LinphoneCore lc,
MSSndCard *  snd_card,
const char *  video_out,
void *  window_id 
)

Create an independent media file player. This player support WAVE and MATROSKA formats.

Parameters
lcA LinphoneCore object
snd_cardPlayback sound card. If NULL, the sound card set in LinphoneCore will be used
video_outVideo display. If NULL, the video display set in LinphoneCore will be used
window_idId of the drawing window. Depend of video out
Returns
A pointer on the new instance. NULL if faild.

§ linphone_core_create_lp_config()

LINPHONE_DEPRECATED LinphoneConfig* linphone_core_create_lp_config ( LinphoneCore lc,
const char *  filename 
)

Create a LpConfig object from a user config file.

Parameters
[in]lcLinphoneCore object
[in]filenameThe filename of the config file to read to fill the instantiated LpConfig
Deprecated:
Use linphone_core_create_config() instead.

§ linphone_core_get_config()

LinphoneConfig* linphone_core_get_config ( LinphoneCore lc)

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

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

§ linphone_core_get_file_transfer_server()

const char* linphone_core_get_file_transfer_server ( LinphoneCore core)

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

Parameters
[in]coreLinphoneCore from which to get the server_url
Returns
URL of the file server like https://file.linphone.org/upload.php

§ linphone_core_interpret_url()

LinphoneAddress* linphone_core_interpret_url ( LinphoneCore lc,
const char *  url 
)

See linphone_proxy_config_normalize_sip_uri for documentation. Default proxy config is used to parse the address.

§ linphone_core_play_local()

int linphone_core_play_local ( LinphoneCore lc,
const char *  audiofile 
)

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

Parameters
[in]lcLinphoneCore object
[in]audiofileThe path to an audio file in wav PCM 16 bit format
Returns
0 on success, -1 on error

§ linphone_core_set_call_error_tone()

void linphone_core_set_call_error_tone ( LinphoneCore lc,
LinphoneReason  reason,
const char *  audiofile 
)

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

Parameters
lcthe core
reasonthe LinphoneReason representing the failure error code.
audiofilea wav file to be played when such call failure happens.

§ linphone_core_set_file_transfer_server()

void linphone_core_set_file_transfer_server ( LinphoneCore core,
const char *  server_url 
)

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

Parameters
[in]coreLinphoneCore to be modified
[in]server_urlURL of the file server like https://file.linphone.org/upload.php

§ linphone_core_set_user_agent()

void linphone_core_set_user_agent ( LinphoneCore lc,
const char *  ua_name,
const char *  version 
)

Sets the user agent string used in SIP messages, ideally called just after linphone_core_new() or linphone_core_init().

Parameters
[in]lcLinphoneCore object
[in]ua_nameThe user agent name
[in]versionThe user agent version

§ linphone_core_take_preview_snapshot()

int linphone_core_take_preview_snapshot ( LinphoneCore lc,
const char *  file 
)

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

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

§ linphone_core_vcard_supported()

bool_t linphone_core_vcard_supported ( void  )

Tells whether VCARD support is builtin.

Returns
TRUE if VCARD is supported, FALSE otherwise.

§ linphone_dial_plan_lookup_ccc_from_e164()

int linphone_dial_plan_lookup_ccc_from_e164 ( const char *  e164)

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

Parameters
e164phone number
Returns
call country code or -1 if not found

§ linphone_dial_plan_lookup_ccc_from_iso()

int linphone_dial_plan_lookup_ccc_from_iso ( const char *  iso)

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

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

§ linphone_error_code_to_reason()

LinphoneReason linphone_error_code_to_reason ( int  err)

Converts an error code to a LinphoneReason.

Parameters
[in]errAn error code
Returns
The LinphoneReason corresponding to the specified error code

§ linphone_error_info_get_details()

const char* linphone_error_info_get_details ( const LinphoneErrorInfo ei)

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

Parameters
[in]eiErrorInfo object
Returns
More details about the failure

§ linphone_error_info_get_phrase()

const char* linphone_error_info_get_phrase ( const LinphoneErrorInfo ei)

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

Parameters
[in]eiErrorInfo object
Returns
The error phrase

§ linphone_error_info_get_protocol_code()

int linphone_error_info_get_protocol_code ( const LinphoneErrorInfo ei)

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

Parameters
[in]eiErrorInfo object
Returns
The status code

§ linphone_error_info_get_reason()

LinphoneReason linphone_error_info_get_reason ( const LinphoneErrorInfo ei)

Get reason code from the error info.

Parameters
[in]eiErrorInfo object
Returns
A LinphoneReason

§ linphone_im_encryption_engine_cbs_get_generate_file_transfer_key()

LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb linphone_im_encryption_engine_cbs_get_generate_file_transfer_key ( LinphoneImEncryptionEngineCbs cbs)

Gets the callback that will generate the key to encrypt the file before uploading it

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
Returns
the callback

§ linphone_im_encryption_engine_cbs_get_is_encryption_enabled_for_file_transfer()

LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb linphone_im_encryption_engine_cbs_get_is_encryption_enabled_for_file_transfer ( LinphoneImEncryptionEngineCbs cbs)

Gets the callback telling wheter or not to encrypt the files

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
Returns
the callback

§ linphone_im_encryption_engine_cbs_get_process_downloading_file()

LinphoneImEncryptionEngineCbsDownloadingFileCb linphone_im_encryption_engine_cbs_get_process_downloading_file ( LinphoneImEncryptionEngineCbs cbs)

Gets the callback that will decrypt the files while downloading them

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
Returns
the callback

§ linphone_im_encryption_engine_cbs_get_process_incoming_message()

LinphoneImEncryptionEngineCbsIncomingMessageCb linphone_im_encryption_engine_cbs_get_process_incoming_message ( LinphoneImEncryptionEngineCbs cbs)

Gets the callback that will decrypt the chat messages upon reception

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
Returns
the callback

§ linphone_im_encryption_engine_cbs_get_process_outgoing_message()

LinphoneImEncryptionEngineCbsOutgoingMessageCb linphone_im_encryption_engine_cbs_get_process_outgoing_message ( LinphoneImEncryptionEngineCbs cbs)

Gets the callback that will encrypt the chat messages before sending them

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
Returns
the callback

§ linphone_im_encryption_engine_cbs_get_process_uploading_file()

LinphoneImEncryptionEngineCbsUploadingFileCb linphone_im_encryption_engine_cbs_get_process_uploading_file ( LinphoneImEncryptionEngineCbs cbs)

Gets the callback that will will encrypt the files while uploading them

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
Returns
the callback

§ linphone_im_encryption_engine_cbs_get_user_data()

void* linphone_im_encryption_engine_cbs_get_user_data ( const LinphoneImEncryptionEngineCbs cbs)

Gets the user data in the LinphoneImEncryptionEngineCbs object

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs
Returns
the user data

§ linphone_im_encryption_engine_cbs_ref()

LinphoneImEncryptionEngineCbs* linphone_im_encryption_engine_cbs_ref ( LinphoneImEncryptionEngineCbs cbs)

Acquire a reference to the LinphoneImEncryptionEngineCbs.

Parameters
[in]cbsLinphoneImEncryptionEngineCbs object.
Returns
The same LinphoneImEncryptionEngineCbs object.

§ linphone_im_encryption_engine_cbs_set_generate_file_transfer_key()

void linphone_im_encryption_engine_cbs_set_generate_file_transfer_key ( LinphoneImEncryptionEngineCbs cbs,
LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb  cb 
)

Sets the callback that will generate the key to encrypt the file before uploading it

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
[in]cbthe callback to call

§ linphone_im_encryption_engine_cbs_set_is_encryption_enabled_for_file_transfer()

void linphone_im_encryption_engine_cbs_set_is_encryption_enabled_for_file_transfer ( LinphoneImEncryptionEngineCbs cbs,
LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb  cb 
)

Sets the callback telling wheter or not to encrypt the files

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
[in]cbthe callback to call

§ linphone_im_encryption_engine_cbs_set_process_downloading_file()

void linphone_im_encryption_engine_cbs_set_process_downloading_file ( LinphoneImEncryptionEngineCbs cbs,
LinphoneImEncryptionEngineCbsDownloadingFileCb  cb 
)

Sets the callback that will decrypt the files while downloading them

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
[in]cbthe callback to call

§ linphone_im_encryption_engine_cbs_set_process_incoming_message()

void linphone_im_encryption_engine_cbs_set_process_incoming_message ( LinphoneImEncryptionEngineCbs cbs,
LinphoneImEncryptionEngineCbsIncomingMessageCb  cb 
)

Sets the callback that will decrypt the chat messages upon reception

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
[in]cbthe callback to call

§ linphone_im_encryption_engine_cbs_set_process_outgoing_message()

void linphone_im_encryption_engine_cbs_set_process_outgoing_message ( LinphoneImEncryptionEngineCbs cbs,
LinphoneImEncryptionEngineCbsOutgoingMessageCb  cb 
)

Sets the callback that will encrypt the chat messages before sending them

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
[in]cbthe callback to call

§ linphone_im_encryption_engine_cbs_set_process_uploading_file()

void linphone_im_encryption_engine_cbs_set_process_uploading_file ( LinphoneImEncryptionEngineCbs cbs,
LinphoneImEncryptionEngineCbsUploadingFileCb  cb 
)

Sets the callback that will encrypt the files while uploading them

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
[in]cbthe callback to call

§ linphone_im_encryption_engine_cbs_set_user_data()

void linphone_im_encryption_engine_cbs_set_user_data ( LinphoneImEncryptionEngineCbs cbs,
void *  data 
)

Sets the user data in the LinphoneImEncryptionEngineCbs object

Parameters
[in]cbsthe LinphoneImEncryptionEngineCbs object
[in]datathe user data

§ linphone_im_encryption_engine_cbs_unref()

void linphone_im_encryption_engine_cbs_unref ( LinphoneImEncryptionEngineCbs cbs)

Release reference to the LinphoneImEncryptionEngineCbs.

Parameters
[in]cbsLinphoneImEncryptionEngineCbs object.

§ linphone_im_encryption_engine_get_callbacks()

LinphoneImEncryptionEngineCbs* linphone_im_encryption_engine_get_callbacks ( const LinphoneImEncryptionEngine imee)

Gets the LinphoneImEncryptionEngineCbs object that holds the callbacks

Parameters
[in]imeethe LinphoneImEncryptionEngine object
Returns
the LinphoneImEncryptionEngineCbs object

§ linphone_im_encryption_engine_get_core()

LinphoneCore* linphone_im_encryption_engine_get_core ( LinphoneImEncryptionEngine imee)

Gets the LinphoneCore object that created the IM encryption engine

Parameters
[in]imeeLinphoneImEncryptionEngine object
Returns
The LinphoneCore object that created the IM encryption engine

§ linphone_im_encryption_engine_get_user_data()

void* linphone_im_encryption_engine_get_user_data ( const LinphoneImEncryptionEngine imee)

Gets the user data in the LinphoneImEncryptionEngine object

Parameters
[in]imeethe LinphoneImEncryptionEngine
Returns
the user data

§ linphone_im_encryption_engine_ref()

LinphoneImEncryptionEngine* linphone_im_encryption_engine_ref ( LinphoneImEncryptionEngine imee)

Acquire a reference to the LinphoneImEncryptionEngine.

Parameters
[in]imeeLinphoneImEncryptionEngine object.
Returns
The same LinphoneImEncryptionEngine object.

§ linphone_im_encryption_engine_set_user_data()

void linphone_im_encryption_engine_set_user_data ( LinphoneImEncryptionEngine imee,
void *  data 
)

Sets the user data in the LinphoneImEncryptionEngine object

Parameters
[in]imeethe LinphoneImEncryptionEngine object
[in]datathe user data

§ linphone_im_encryption_engine_unref()

void linphone_im_encryption_engine_unref ( LinphoneImEncryptionEngine imee)

Release reference to the LinphoneImEncryptionEngine.

Parameters
[in]imeeLinphoneImEncryptionEngine object.

§ linphone_info_message_add_header()

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

Add a header to an info message to be sent.

Parameters
imthe info message
namethe header'name
valuethe header's value

§ linphone_info_message_destroy()

void linphone_info_message_destroy ( LinphoneInfoMessage im)

Destroy a LinphoneInfoMessage

§ linphone_info_message_get_content()

const LinphoneContent* linphone_info_message_get_content ( const LinphoneInfoMessage im)

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

§ linphone_info_message_get_header()

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

Obtain a header value from a received info message.

Parameters
imthe info message
namethe header'name
Returns
the corresponding header's value, or NULL if not exists.

§ linphone_info_message_set_content()

void linphone_info_message_set_content ( LinphoneInfoMessage im,
const LinphoneContent content 
)

Assign a content to the info message.

Parameters
imthe linphone info message
contentthe 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.

§ linphone_reason_to_error_code()

int linphone_reason_to_error_code ( LinphoneReason  reason)

Converts a LinphoneReason to an error code.

Parameters
[in]reasonA LinphoneReason
Returns
The error code corresponding to the specified LinphoneReason

§ linphone_reason_to_string()

const char* linphone_reason_to_string ( LinphoneReason  err)

Converts a LinphoneReason enum to a string.

Parameters
[in]errA LinphoneReason
Returns
The string representation of the specified LinphoneReason

§ linphone_transport_parse()

LinphoneTransportType linphone_transport_parse ( const char *  transport)

Converts a lowercase string to a LinphoneTransportType enum.

Returns
Transport matching input, or LinphoneTransportUdp if nothing is found

§ linphone_transport_to_string()

const char* linphone_transport_to_string ( LinphoneTransportType  transport)

Converts a LinphoneTransportType enum to a lowercase string.

§ linphone_xml_rpc_request_add_int_arg()

void linphone_xml_rpc_request_add_int_arg ( LinphoneXmlRpcRequest request,
int  value 
)

Add an integer argument to an XML-RPC request.

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

§ linphone_xml_rpc_request_add_string_arg()

void linphone_xml_rpc_request_add_string_arg ( LinphoneXmlRpcRequest request,
const char *  value 
)

Add a string argument to an XML-RPC request.

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

§ linphone_xml_rpc_request_cbs_get_response()

LinphoneXmlRpcRequestCbsResponseCb linphone_xml_rpc_request_cbs_get_response ( const LinphoneXmlRpcRequestCbs cbs)

Get the response callback.

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

§ linphone_xml_rpc_request_cbs_get_user_data()

void* linphone_xml_rpc_request_cbs_get_user_data ( const LinphoneXmlRpcRequestCbs cbs)

Retrieve the user pointer associated with a LinphoneXmlRpcRequestCbs object.

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

§ linphone_xml_rpc_request_cbs_ref()

LinphoneXmlRpcRequestCbs* linphone_xml_rpc_request_cbs_ref ( LinphoneXmlRpcRequestCbs cbs)

Acquire a reference to a LinphoneXmlRpcRequestCbs object.

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

§ linphone_xml_rpc_request_cbs_set_response()

void linphone_xml_rpc_request_cbs_set_response ( LinphoneXmlRpcRequestCbs cbs,
LinphoneXmlRpcRequestCbsResponseCb  cb 
)

Set the response callback.

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

§ linphone_xml_rpc_request_cbs_set_user_data()

void linphone_xml_rpc_request_cbs_set_user_data ( LinphoneXmlRpcRequestCbs cbs,
void *  ud 
)

Assign a user pointer to a LinphoneXmlRpcRequestCbs object.

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

§ linphone_xml_rpc_request_cbs_unref()

void linphone_xml_rpc_request_cbs_unref ( LinphoneXmlRpcRequestCbs cbs)

Release a reference to a LinphoneXmlRpcRequestCbs object.

Parameters
[in]cbsLinphoneXmlRpcRequestCbs object.

§ linphone_xml_rpc_request_get_callbacks()

LinphoneXmlRpcRequestCbs* linphone_xml_rpc_request_get_callbacks ( const LinphoneXmlRpcRequest request)

Get the LinphoneXmlRpcRequestCbs object associated with a LinphoneXmlRpcRequest.

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

§ linphone_xml_rpc_request_get_content()

const char* linphone_xml_rpc_request_get_content ( const LinphoneXmlRpcRequest request)

Get the content of the XML-RPC request.

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

§ linphone_xml_rpc_request_get_int_response()

int linphone_xml_rpc_request_get_int_response ( const LinphoneXmlRpcRequest request)

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

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

§ linphone_xml_rpc_request_get_status()

LinphoneXmlRpcStatus linphone_xml_rpc_request_get_status ( const LinphoneXmlRpcRequest request)

Get the status of the XML-RPC request.

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

§ linphone_xml_rpc_request_get_string_response()

const char* linphone_xml_rpc_request_get_string_response ( const LinphoneXmlRpcRequest request)

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

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

§ linphone_xml_rpc_request_get_user_data()

void* linphone_xml_rpc_request_get_user_data ( const LinphoneXmlRpcRequest request)

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

Parameters
[in]requestLinphoneXmlRpcRequest object.
Returns
The user pointer associated with the XML-RPC request.

§ linphone_xml_rpc_request_new()

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

Create a new LinphoneXmlRpcRequest object.

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

§ linphone_xml_rpc_request_new_with_args()

LinphoneXmlRpcRequest* linphone_xml_rpc_request_new_with_args ( const char *  method,
LinphoneXmlRpcArgType  return_type,
  ... 
)

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

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

§ linphone_xml_rpc_request_ref()

LinphoneXmlRpcRequest* linphone_xml_rpc_request_ref ( LinphoneXmlRpcRequest request)

Acquire a reference to the XML-RPC request.

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

§ linphone_xml_rpc_request_set_user_data()

void linphone_xml_rpc_request_set_user_data ( LinphoneXmlRpcRequest request,
void *  ud 
)

Assign a user pointer to the XML-RPC request.

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

§ linphone_xml_rpc_request_unref()

void linphone_xml_rpc_request_unref ( LinphoneXmlRpcRequest request)

Release reference to the XML-RPC request.

Parameters
[in]requestLinphoneXmlRpcRequest object.

§ linphone_xml_rpc_session_get_user_data()

void* linphone_xml_rpc_session_get_user_data ( const LinphoneXmlRpcSession session)

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

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

§ linphone_xml_rpc_session_new()

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

Create a new LinphoneXmlRpcSession object.

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

§ linphone_xml_rpc_session_ref()

LinphoneXmlRpcSession* linphone_xml_rpc_session_ref ( LinphoneXmlRpcSession session)

Acquire a reference to the XML-RPC session.

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

§ linphone_xml_rpc_session_release()

void linphone_xml_rpc_session_release ( LinphoneXmlRpcSession session)

Stop and unref an XML rpc session. Pending requests will be aborted.

Parameters
[in]sessionLinphoneXmlRpcSession object.

§ linphone_xml_rpc_session_send_request()

void linphone_xml_rpc_session_send_request ( LinphoneXmlRpcSession session,
LinphoneXmlRpcRequest request 
)

Send an XML-RPC request.

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

§ linphone_xml_rpc_session_set_user_data()

void linphone_xml_rpc_session_set_user_data ( LinphoneXmlRpcSession session,
void *  ud 
)

Assign a user pointer to the XML-RPC session.

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

§ linphone_xml_rpc_session_unref()

void linphone_xml_rpc_session_unref ( LinphoneXmlRpcSession session)

Release reference to the XML-RPC session.

Parameters
[in]sessionLinphoneXmlRpcSession object.
Warning
This will not stop pending xml-rpc requests. Use linphone_xml_rpc_session_release() instead if this is intended.

§ lp_config_load_dict_to_section()

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

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

§ lp_config_section_to_dict()

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

Converts a config section into a dictionary.

Returns
a dictionary with all the keys from a section, or NULL if the section doesn't exist