Liblinphone  3.12.0
Macros | Typedefs | Enumerations | Functions
Misc

Miscenalleous: logs, version strings, config storage. More...

Macros

#define LINPHONE_CONFIG(obj)   BELLE_SIP_CAST(obj, LinphoneConfig);
 Safely downcast a belle_sip_object into 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 int(* LinphoneImEncryptionEngineCbsIncomingMessageCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg)
 Callback to decrypt incoming LinphoneChatMessage. More...
 
typedef int(* LinphoneImEncryptionEngineCbsOutgoingMessageCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room, LinphoneChatMessage *msg)
 Callback to encrypt outgoing LinphoneChatMessage. More...
 
typedef bool_t(* LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *room)
 Callback to know whether or not the engine will encrypt files before uploading them. More...
 
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. More...
 
typedef int(* LinphoneImEncryptionEngineCbsDownloadingFileCb) (LinphoneImEncryptionEngine *engine, LinphoneChatMessage *msg, size_t offset, const uint8_t *buffer, size_t size, uint8_t *decrypted_buffer)
 Callback to decrypt downloading file. More...
 
typedef int(* LinphoneImEncryptionEngineCbsUploadingFileCb) (LinphoneImEncryptionEngine *engine, LinphoneChatMessage *msg, size_t offset, const uint8_t *buffer, size_t *size, uint8_t *encrypted_buffer)
 Callback to encrypt uploading file. More...
 
typedef void(* LinphoneXmlRpcRequestCbsResponseCb) (LinphoneXmlRpcRequest *request)
 Callback used to notify the response to an XML-RPC request. More...
 
typedef struct _LinphoneBuffer LinphoneBuffer
 The LinphoneContent object representing a data buffer.
 
typedef struct _LpConfig LinphoneConfig
 The LinphoneConfig object is used to manipulate a configuration file. More...
 
typedef struct _LinphoneContent LinphoneContent
 The LinphoneContent object holds data that can be embedded in a signaling message.
 
typedef struct _LinphoneErrorInfo LinphoneErrorInfo
 Object representing full details about a signaling error or status. More...
 
typedef struct _LinphoneImEncryptionEngine LinphoneImEncryptionEngine
 IM encryption engine.
 
typedef struct _LinphoneImEncryptionEngineCbs LinphoneImEncryptionEngineCbs
 An object to handle the callbacks for the handling a LinphoneImEncryptionEngine object.
 
typedef struct _LinphoneInfoMessage LinphoneInfoMessage
 The LinphoneInfoMessage is an object representing an informational message sent or received by the core.
 
typedef enum _LinphoneReason LinphoneReason
 Enum describing various failure reasons or contextual information for some events. More...
 
typedef enum _LinphoneToneID LinphoneToneID
 Enum listing frequent telephony tones.
 
typedef enum _LinphoneVersionUpdateCheckResult LinphoneVersionUpdateCheckResult
 Enum describing the result of a version update check.
 
typedef enum _LinphoneXmlRpcArgType LinphoneXmlRpcArgType
 Enum describing the types of argument for LinphoneXmlRpcRequest.
 
typedef struct _LinphoneXmlRpcRequest LinphoneXmlRpcRequest
 The LinphoneXmlRpcRequest object representing a XML-RPC request to be sent.
 
typedef struct _LinphoneXmlRpcRequestCbs LinphoneXmlRpcRequestCbs
 An object to handle the callbacks for handling the LinphoneXmlRpcRequest operations.
 
typedef struct _LinphoneXmlRpcSession LinphoneXmlRpcSession
 The LinphoneXmlRpcSession object used to send XML-RPC requests and handle their responses.
 
typedef enum _LinphoneXmlRpcStatus LinphoneXmlRpcStatus
 Enum describing the status of a LinphoneXmlRpcRequest.
 
typedef struct _LinphoneRange LinphoneRange
 Structure describing a range of integers.
 
typedef int LinphoneStatus
 Status code returned by some functions to notify whether the execution has been succesfully done or not.
 
typedef struct _LinphoneHeaders LinphoneHeaders
 Object representing a chain of protocol headers. More...
 

Enumerations

enum  _LinphoneReason {
  LinphoneReasonNone,
  LinphoneReasonNoResponse,
  LinphoneReasonForbidden,
  LinphoneReasonDeclined,
  LinphoneReasonNotFound,
  LinphoneReasonNotAnswered,
  LinphoneReasonBusy,
  LinphoneReasonUnsupportedContent,
  LinphoneReasonIOError,
  LinphoneReasonDoNotDisturb,
  LinphoneReasonUnauthorized,
  LinphoneReasonNotAcceptable,
  LinphoneReasonNoMatch,
  LinphoneReasonMovedPermanently,
  LinphoneReasonGone,
  LinphoneReasonTemporarilyUnavailable,
  LinphoneReasonAddressIncomplete,
  LinphoneReasonNotImplemented,
  LinphoneReasonBadGateway,
  LinphoneReasonServerTimeout,
  LinphoneReasonUnknown
}
 Enum describing various failure reasons or contextual information for some events. More...
 
enum  _LinphoneToneID {
  LinphoneToneUndefined,
  LinphoneToneBusy,
  LinphoneToneCallWaiting,
  LinphoneToneCallOnHold,
  LinphoneToneCallLost
}
 Enum listing frequent telephony tones. More...
 
enum  _LinphoneVersionUpdateCheckResult {
  LinphoneVersionUpdateCheckUpToDate,
  LinphoneVersionUpdateCheckNewVersionAvailable,
  LinphoneVersionUpdateCheckError
}
 Enum describing the result of a version update check.
 
enum  _LinphoneXmlRpcArgType {
  LinphoneXmlRpcArgNone,
  LinphoneXmlRpcArgInt,
  LinphoneXmlRpcArgString
}
 Enum describing the types of argument for LinphoneXmlRpcRequest.
 
enum  _LinphoneXmlRpcStatus {
  LinphoneXmlRpcStatusPending,
  LinphoneXmlRpcStatusOk,
  LinphoneXmlRpcStatusFailed
}
 Enum describing the status of a LinphoneXmlRpcRequest.
 

Functions

LinphoneBufferlinphone_buffer_new (void)
 Create a new empty LinphoneBuffer object. More...
 
LinphoneBufferlinphone_buffer_new_from_data (const uint8_t *data, size_t size)
 Create a new LinphoneBuffer object from existing data. More...
 
LinphoneBufferlinphone_buffer_new_from_string (const char *data)
 Create a new LinphoneBuffer object from a string. More...
 
LinphoneBufferlinphone_buffer_ref (LinphoneBuffer *buffer)
 Acquire a reference to the buffer. More...
 
void linphone_buffer_unref (LinphoneBuffer *buffer)
 Release reference to the buffer. More...
 
void * linphone_buffer_get_user_data (const LinphoneBuffer *buffer)
 Retrieve the user pointer associated with the buffer. More...
 
void linphone_buffer_set_user_data (LinphoneBuffer *buffer, void *ud)
 Assign a user pointer to the buffer. More...
 
const uint8_t * linphone_buffer_get_content (const LinphoneBuffer *buffer)
 Get the content of the data buffer. More...
 
void linphone_buffer_set_content (LinphoneBuffer *buffer, const uint8_t *content, size_t size)
 Set the content of the data buffer. More...
 
const char * linphone_buffer_get_string_content (const LinphoneBuffer *buffer)
 Get the string content of the data buffer. More...
 
void linphone_buffer_set_string_content (LinphoneBuffer *buffer, const char *content)
 Set the string content of the data buffer. More...
 
size_t linphone_buffer_get_size (const LinphoneBuffer *buffer)
 Get the size of the content of the data buffer. More...
 
void linphone_buffer_set_size (LinphoneBuffer *buffer, size_t size)
 Set the size of the content of the data buffer. More...
 
bool_t linphone_buffer_is_empty (const LinphoneBuffer *buffer)
 Tell whether the LinphoneBuffer is empty. More...
 
LinphoneCallStatslinphone_call_stats_ref (LinphoneCallStats *stats)
 Increment refcount. More...
 
void linphone_call_stats_unref (LinphoneCallStats *stats)
 Decrement refcount and possibly free the object. More...
 
void * linphone_call_stats_get_user_data (const LinphoneCallStats *stats)
 Gets the user data in the LinphoneCallStats object. More...
 
void linphone_call_stats_set_user_data (LinphoneCallStats *stats, void *data)
 Sets the user data in the LinphoneCallStats object. More...
 
LinphoneContentlinphone_content_ref (LinphoneContent *content)
 Acquire a reference to the content. More...
 
void linphone_content_unref (LinphoneContent *content)
 Release reference to the content. More...
 
void * linphone_content_get_user_data (const LinphoneContent *content)
 Retrieve the user pointer associated with the content. More...
 
void linphone_content_set_user_data (LinphoneContent *content, void *ud)
 Assign a user pointer to the content. More...
 
const char * linphone_content_get_type (const LinphoneContent *content)
 Get the mime type of the content data. More...
 
void linphone_content_set_type (LinphoneContent *content, const char *type)
 Set the mime type of the content data. More...
 
const char * linphone_content_get_subtype (const LinphoneContent *content)
 Get the mime subtype of the content data. More...
 
void linphone_content_set_subtype (LinphoneContent *content, const char *subtype)
 Set the mime subtype of the content data. More...
 
void * linphone_content_get_buffer (const LinphoneContent *content)
 Get the content data buffer, usually a string. More...
 
void linphone_content_set_buffer (LinphoneContent *content, const void *buffer, size_t size)
 Set the content data buffer, usually a string. More...
 
const char * linphone_content_get_string_buffer (const LinphoneContent *content)
 Get the string content data buffer. More...
 
void linphone_content_set_string_buffer (LinphoneContent *content, const char *buffer)
 Set the string content data buffer. More...
 
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. More...
 
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. More...
 
const char * linphone_content_get_encoding (const LinphoneContent *content)
 Get the encoding of the data buffer, for example "gzip". More...
 
void linphone_content_set_encoding (LinphoneContent *content, const char *encoding)
 Set the encoding of the data buffer, for example "gzip". More...
 
const char * linphone_content_get_name (const LinphoneContent *content)
 Get the name associated with a RCS file transfer message. More...
 
void linphone_content_set_name (LinphoneContent *content, const char *name)
 Set the name associated with a RCS file transfer message. More...
 
bool_t linphone_content_is_multipart (const LinphoneContent *content)
 Tell whether a content is a multipart content. More...
 
LinphoneContentlinphone_content_get_part (const LinphoneContent *content, int idx)
 Get a part from a multipart content according to its index. More...
 
LinphoneContentlinphone_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. More...
 
const char * linphone_content_get_custom_header (const LinphoneContent *content, const char *header_name)
 Get a custom header value of a content. More...
 
LinphonePlayerlinphone_core_create_local_player (LinphoneCore *lc, const char *sound_card_name, const char *video_display_name, void *window_id)
 Create an independent media file player. More...
 
LinphoneInfoMessagelinphone_core_create_info_message (LinphoneCore *lc)
 Creates an empty info message. More...
 
void linphone_core_check_for_update (LinphoneCore *lc, const char *current_version)
 Checks if a new version of the application is available. More...
 
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(). More...
 
LinphoneAddresslinphone_core_interpret_url (LinphoneCore *lc, const char *url)
 See linphone_proxy_config_normalize_sip_uri for documentation. More...
 
LinphoneStatus linphone_core_play_local (LinphoneCore *lc, const char *audiofile)
 Plays an audio file to the local user. More...
 
bool_t linphone_core_vcard_supported (void)
 Tells whether VCARD support is builtin. More...
 
bool_t linphone_core_video_supported (LinphoneCore *lc)
 Test if video is supported.
 
LinphoneStatus 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. More...
 
LinphoneConfiglinphone_core_get_config (LinphoneCore *lc)
 Returns the LpConfig object used to manage the storage (config) file. More...
 
LINPHONE_DEPRECATED LinphoneConfiglinphone_core_create_lp_config (LinphoneCore *lc, const char *filename)
 Create a LpConfig object from a user config file. More...
 
LinphoneConfiglinphone_core_create_config (LinphoneCore *lc, const char *filename)
 Create a LinphoneConfig object from a user config file. More...
 
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. More...
 
void linphone_core_set_file_transfer_server (LinphoneCore *core, const char *server_url)
 Globaly set an http file transfer server to be use