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

Typedefs
typedef void(*	LinphoneCoreCbsEcCalibrationResultCb) (LinphoneCore *core, LinphoneEcCalibratorStatus status, int delay_ms)
	Function prototype used by linphone_core_cbs_set_ec_calibration_result(). More...

typedef void(*	LinphoneCoreCbsEcCalibrationAudioInitCb) (LinphoneCore *core)
	Function prototype used by linphone_core_cbs_set_ec_calibration_audio_init(). More...

typedef void(*	LinphoneCoreCbsEcCalibrationAudioUninitCb) (LinphoneCore *core)
	Function prototype used by linphone_core_cbs_set_ec_calibration_audio_uninit(). More...

typedef int(*	LinphoneImEncryptionEngineCbsIncomingMessageCb) (LinphoneImEncryptionEngine engine, LinphoneChatRoom chat_room, LinphoneChatMessage *message)
	Callback to decrypt incoming LinphoneChatMessage. More...

typedef int(*	LinphoneImEncryptionEngineCbsOutgoingMessageCb) (LinphoneImEncryptionEngine engine, LinphoneChatRoom chat_room, LinphoneChatMessage *message)
	Callback to encrypt outgoing LinphoneChatMessage. More...

typedef bool_t(*	LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb) (LinphoneImEncryptionEngine engine, LinphoneChatRoom chat_room)
	Callback to know whether or not the engine will encrypt files before uploading them. More...

typedef void(*	LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb) (LinphoneImEncryptionEngine engine, LinphoneChatRoom chat_room, LinphoneChatMessage *message)
	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 message, 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 message, 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 void(*	LinphoneCoreCbsChatRoomExhumedCb) (LinphoneCore core, LinphoneChatRoom chat_room)
	Callback used to notify a chat room has been exhumed. More...

typedef struct _LinphoneErrorInfo	LinphoneErrorInfo
	Object representing full details about a signaling error or status. More...

typedef struct _LinphoneImEncryptionEngine	LinphoneImEncryptionEngine
	IM encryption engine. More...

typedef struct _LinphoneImEncryptionEngineCbs	LinphoneImEncryptionEngineCbs
	An object to handle the callbacks for the handling a LinphoneImEncryptionEngine object. More...

typedef struct _LinphoneInfoMessage	LinphoneInfoMessage
	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 successfully done or not.

typedef struct _LinphoneHeaders	LinphoneHeaders
	Object representing a chain of protocol headers. More...

typedef void(*	LinphoneMagicSearchCbsSearchResultsReceivedCb) (LinphoneMagicSearch *magic_search)
	Callback used to notify when results are received. More...

typedef void(*	LinphoneMagicSearchCbsLdapHaveMoreResultsCb) (LinphoneMagicSearch magic_search, LinphoneLdap ldap)
	Callback used to notify when LDAP have more results available. More...

typedef void(*	LinphoneMagicSearchCbsMoreResultsAvailableCb) (LinphoneMagicSearch *magic_search, LinphoneMagicSearchSource source)
	Callback used to notify when more results are available for a given LinphoneMagicSearchSource flag. More...

typedef struct _LinphoneBuffer	LinphoneBuffer
	The object representing a data buffer.

typedef struct _LinphoneContent	LinphoneContent
	This object holds data that can be embedded in a signaling message or IM message. More...

typedef struct _LinphoneDialPlan	LinphoneDialPlan
	Represents a dial plan.

typedef struct _LinphoneDigestAuthenticationPolicy	LinphoneDigestAuthenticationPolicy
	The LinphoneDigestAuthenticationPolicy holds parameters relative to digest authentication procedures.

typedef enum _LinphoneSecurityLevel	LinphoneSecurityLevel
	Security level determined by type of encryption (point-to-point, end-to-end, etc...) and whether or not a SAS validation was made with the remote(s) end(s). More...

Enumerations
enum	_LinphoneReason { LinphoneReasonNone = 0, LinphoneReasonNoResponse = 1, LinphoneReasonForbidden = 2, LinphoneReasonDeclined = 3, LinphoneReasonNotFound = 4, LinphoneReasonNotAnswered = 5, LinphoneReasonBusy = 6, LinphoneReasonUnsupportedContent = 7, LinphoneReasonBadEvent = 8, LinphoneReasonIOError = 9, LinphoneReasonDoNotDisturb = 10, LinphoneReasonUnauthorized = 11, LinphoneReasonNotAcceptable = 12, LinphoneReasonNoMatch = 13, LinphoneReasonMovedPermanently = 14, LinphoneReasonGone = 15, LinphoneReasonTemporarilyUnavailable = 16, LinphoneReasonAddressIncomplete = 17, LinphoneReasonNotImplemented = 18, LinphoneReasonBadGateway = 19, LinphoneReasonSessionIntervalTooSmall = 20, LinphoneReasonServerTimeout = 21, LinphoneReasonUnknown = 22, LinphoneReasonTransferred = 23, LinphoneReasonConditionalRequestFailed = 24, LinphoneReasonSasCheckRequired = 25 }
	Enum describing various failure reasons or contextual information for some events. More...

enum	_LinphoneToneID { LinphoneToneUndefined = 0, LinphoneToneBusy = 1, LinphoneToneCallWaiting = 2, LinphoneToneCallOnHold = 3, LinphoneToneCallLost = 4, LinphoneToneCallEnd = 5, LinphoneToneCallNotAnswered = 6, LinphoneToneSasCheckRequired = 7 }
	Enum listing frequent telephony tones. More...

enum	_LinphoneVersionUpdateCheckResult { LinphoneVersionUpdateCheckUpToDate = 0, LinphoneVersionUpdateCheckNewVersionAvailable = 1, LinphoneVersionUpdateCheckError = 2 }
	Enum describing the result of a version update check.

enum	_LinphoneXmlRpcArgType { LinphoneXmlRpcArgNone = 0, LinphoneXmlRpcArgInt = 1, LinphoneXmlRpcArgString = 2, LinphoneXmlRpcArgStringStruct = 3 }
	Enum describing the types of argument for LinphoneXmlRpcRequest.

enum	_LinphoneXmlRpcStatus { LinphoneXmlRpcStatusPending = 0, LinphoneXmlRpcStatusOk = 1, LinphoneXmlRpcStatusFailed = 2 }
	Enum describing the status of a LinphoneXmlRpcRequest.

enum	_LinphoneSecurityLevel { LinphoneSecurityLevelUnsafe = 0, LinphoneSecurityLevelNone = 1, LinphoneSecurityLevelEndToEndEncrypted = 2, LinphoneSecurityLevelEndToEndEncryptedAndVerified = 3, LinphoneSecurityLevelPointToPointEncrypted = 4 }
	Security level determined by type of encryption (point-to-point, end-to-end, etc...) and whether or not a SAS validation was made with the remote(s) end(s). More...

Functions
LinphonePlayer *	linphone_core_create_local_player (LinphoneCore core, const char sound_card_name, const char video_display_name, void window_id)
	Creates a media file player, that can be used to play audio and video to the user, outside of any call or conference. More...

LinphoneRecorderParams *	linphone_core_create_recorder_params (const LinphoneCore *core)
	Creates an object that holds recording parameters. More...

LinphoneRecorder *	linphone_core_create_recorder (LinphoneCore core, const LinphoneRecorderParams params)
	Creates an independant media file recorder, that can be used to record user's voice or video outside of any call or conference. More...

LinphoneInfoMessage *	linphone_core_create_info_message (LinphoneCore *core)
	Creates an empty info message. More...

LinphoneMagicSearch *	linphone_core_create_magic_search (LinphoneCore *core)
	Creates a LinphoneMagicSearch object. More...

void	linphone_core_check_for_update (LinphoneCore core, const char current_version)
	Asynchronously checks if a new version of the application is available from a well-known http server URI given by LinphoneCore 's configuration. More...

void	linphone_core_set_user_agent (LinphoneCore core, const char name, const char *version)
	Set the user agent string used in SIP messages. More...

LinphoneAddress *	linphone_core_interpret_url (LinphoneCore core, const char url)
	Constructs a LinphoneAddress from the given string if possible. More...

LinphoneAddress *	linphone_core_interpret_url_2 (LinphoneCore core, const char url, bool_t apply_international_prefix)
	Constructs a LinphoneAddress from the given string if possible. More...

MS2_DEPRECATED void	linphone_core_set_lime_x3dh_server_url (LinphoneCore core, const char url)
	Set the x3dh server url. More...

MS2_DEPRECATED const char *	linphone_core_get_lime_x3dh_server_url (LinphoneCore *core)
	Get the x3dh server url. More...

LinphoneStatus	linphone_core_play_local (LinphoneCore core, 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 *core)
	Test if video is supported. More...

LinphoneStatus	linphone_core_take_preview_snapshot (LinphoneCore core, const char file)
	Takes a photo of currently from capture device and write it into a jpeg file. More...

void	linphone_core_enter_background (LinphoneCore *core)
	This method is called by the application to notify the linphone core library when it enters background mode. More...

void	linphone_core_enter_foreground (LinphoneCore *core)
	This method is called by the application to notify the linphone core library when it enters foreground mode. More...

LinphoneConfig *	linphone_core_get_config (const LinphoneCore *core)
	Returns the config object used to manage the storage (config) file. More...

LinphoneConfig *	linphone_core_create_config (LinphoneCore core, const char filename)
	Create a LinphoneConfig object from a user config file. More...

LinphoneGlobalState	linphone_core_get_global_state (const LinphoneCore *core)
	Returns the global state of core. More...

void	linphone_core_set_file_transfer_server (LinphoneCore core, const char server_url)
	Globaly sets an http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml. More...

const char *	linphone_core_get_file_transfer_server (LinphoneCore *core)
	Gets the globaly set http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml. More...

LinphoneContent *	linphone_core_create_content (LinphoneCore *core)
	Creates a content with default values from Linphone core. More...

LinphoneXmlRpcSession *	linphone_core_create_xml_rpc_session (LinphoneCore core, const char url)
	Create a LinphoneXmlRpcSession for a given url. More...

void	linphone_core_load_config_from_xml (LinphoneCore core, const char xml_uri)
	Update current config with the content of a xml config file. More...

void	linphone_core_ensure_registered (LinphoneCore *core)
	Call this method when you receive a push notification (if you handle push notifications manually). More...

void	linphone_core_process_push_notification (LinphoneCore core, const char call_id)
	Call this method when you receive a push notification (if you handle push notifications manually). More...

void	linphone_core_push_notification_received (LinphoneCore core, const char payload, const char *call_id)
	This method is called by Android & iOS platform helpers to notify the Core of a received push notification. More...

void	linphone_core_push_notification_received_2 (LinphoneCore core, const char payload, const char *call_id, bool_t is_core_starting)
	This method is called by Android & iOS platform helpers to notify the Core of a received push notification. More...

int	linphone_core_get_auto_iterate_foreground_schedule (const LinphoneCore *core)
	Gets the timer used to schedule the call to core.iterate() method when in foreground (Android only). More...

void	linphone_core_set_auto_iterate_foreground_schedule (LinphoneCore *core, int schedule)
	Sets the timer used to schedule the call to core.iterate() method when in foreground (Android only). More...

int	linphone_core_get_auto_iterate_background_schedule (const LinphoneCore *core)
	Gets the timer used to schedule the call to core.iterate() method when in background (Android only). More...

void	linphone_core_set_auto_iterate_background_schedule (LinphoneCore *core, int schedule)
	Sets the timer used to schedule the call to core.iterate() method when in background (Android only). More...

void	linphone_core_set_vibration_on_incoming_call_enabled (LinphoneCore *core, bool_t enable)
	Enable vibration will incoming call is ringing (Android only). More...

void	linphone_core_enable_vibration_on_incoming_call (LinphoneCore *core, bool_t enable)
	Enable vibration will incoming call is ringing (Android only). More...

bool_t	linphone_core_is_vibration_on_incoming_call_enabled (LinphoneCore *core)
	Gets whether the device will vibrate while an incoming call is ringing (Android only). More...

bool_t	linphone_core_vibration_on_incoming_call_enabled (LinphoneCore *core)
	Gets whether the device will vibrate while an incoming call is ringing (Android only). More...

bool_t	linphone_core_ldap_available (LinphoneCore *core)
	End of group group_contacts. More...

LinphoneStatus	linphone_core_config_sync (LinphoneCore *core)
	Forces a flush of the config to disk. More...

const bctbx_list_t *	linphone_core_get_loaded_plugins (LinphoneCore *core)
	Return the list of loaded plugins. More...

bool_t	linphone_core_is_plugin_loaded (const LinphoneCore core, const char name)
	Tells whether a plugin is loaded or not. More...

MS2_DEPRECATED LinphoneConfig *	linphone_core_create_lp_config (LinphoneCore core, const char filename)
	Create a LpConfig object from a user config file. More...

LinphoneImEncryptionEngineCbs *	linphone_im_encryption_engine_cbs_ref (LinphoneImEncryptionEngineCbs *cbs)
	Acquire a reference to the LinphoneImEncryptionEngineCbs. More...

void	linphone_im_encryption_engine_cbs_unref (LinphoneImEncryptionEngineCbs *cbs)
	Release reference to the LinphoneImEncryptionEngineCbs. More...

void *	linphone_im_encryption_engine_cbs_get_user_data (const LinphoneImEncryptionEngineCbs *cbs)
	Gets the user data in the LinphoneImEncryptionEngineCbs object. More...

void	linphone_im_encryption_engine_cbs_set_user_data (LinphoneImEncryptionEngineCbs cbs, void data)
	Sets the user data in the LinphoneImEncryptionEngineCbs object. More...

LinphoneImEncryptionEngine *	linphone_im_encryption_engine_ref (LinphoneImEncryptionEngine *imee)
	Acquire a reference to the LinphoneImEncryptionEngine. More...

void	linphone_im_encryption_engine_unref (LinphoneImEncryptionEngine *imee)
	Release reference to the LinphoneImEncryptionEngine. More...

void *	linphone_im_encryption_engine_get_user_data (const LinphoneImEncryptionEngine *imee)
	Gets the user data in the LinphoneImEncryptionEngine object. More...

void	linphone_im_encryption_engine_set_user_data (LinphoneImEncryptionEngine imee, void data)
	Sets the user data in the LinphoneImEncryptionEngine object. More...

LinphoneCore *	linphone_im_encryption_engine_get_core (LinphoneImEncryptionEngine *imee)
	Gets the LinphoneCore object that created the IM encryption engine. More...

LinphoneImEncryptionEngineCbs *	linphone_im_encryption_engine_get_callbacks (const LinphoneImEncryptionEngine *imee)
	Gets the LinphoneImEncryptionEngineCbs object that holds the callbacks. More...

LinphoneImEncryptionEngineCbsIncomingMessageCb	linphone_im_encryption_engine_cbs_get_process_incoming_message (LinphoneImEncryptionEngineCbs *cbs)
	Gets the callback that will decrypt the chat messages upon reception. More...

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. More...

LinphoneImEncryptionEngineCbsOutgoingMessageCb	linphone_im_encryption_engine_cbs_get_process_outgoing_message (LinphoneImEncryptionEngineCbs *cbs)
	Gets the callback that will encrypt the chat messages before sending them. More...

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. More...

LinphoneImEncryptionEngineCbsDownloadingFileCb	linphone_im_encryption_engine_cbs_get_process_downloading_file (LinphoneImEncryptionEngineCbs *cbs)
	Gets the callback that will decrypt the files while downloading them. More...

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. More...

LinphoneImEncryptionEngineCbsUploadingFileCb	linphone_im_encryption_engine_cbs_get_process_uploading_file (LinphoneImEncryptionEngineCbs *cbs)
	Gets the callback that will will encrypt the files while uploading them. More...

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. More...

LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb	linphone_im_encryption_engine_cbs_get_is_encryption_enabled_for_file_transfer (LinphoneImEncryptionEngineCbs *cbs)
	Gets the callback telling whether or not to encrypt the files. More...

void	linphone_im_encryption_engine_cbs_set_is_encryption_enabled_for_file_transfer (LinphoneImEncryptionEngineCbs *cbs, LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb cb)
	Sets the callback telling whether or not to encrypt the files. More...

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. More...

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. More...

LinphoneImEncryptionEngine *	linphone_im_encryption_engine_new (void)
	Create the IM encryption engine. More...

const char *	linphone_configuring_state_to_string (LinphoneConfiguringState state)
	Converts a LinphoneConfiguringState enum to a string. More...

const char *	linphone_reason_to_string (LinphoneReason error)
	Converts a LinphoneReason enum to a string. More...

const char *	linphone_transport_to_string (LinphoneTransportType transport)
	Converts a LinphoneTransportType enum to a lowercase string. More...

LinphoneTransportType	linphone_transport_parse (const char *transport)
	Converts a lowercase string to a LinphoneTransportType enum. More...

bool_t	linphone_error_code_is_retry_after (int error)
	Check whether an error code is in Retry-After field. More...

LinphoneReason	linphone_error_code_to_reason (int error)
	Converts an error code to a LinphoneReason. More...

int	linphone_reason_to_error_code (LinphoneReason reason)
	Converts a LinphoneReason to an error code. More...

LinphoneRange *	linphone_range_ref (LinphoneRange *range)
	Increment refcount. More...

void	linphone_range_unref (LinphoneRange *range)
	Decrement refcount and possibly free the object. More...

void *	linphone_range_get_user_data (const LinphoneRange *range)
	Gets the user data in the LinphoneRange object. More...

void	linphone_range_set_user_data (LinphoneRange range, void user_data)
	Sets the user data in the LinphoneRange object. More...

int	linphone_range_get_min (const LinphoneRange *range)
	Gets the lower value of the range. More...

int	linphone_range_get_max (const LinphoneRange *range)
	Gets the higher value of the range. More...

void	linphone_range_set_min (LinphoneRange *range, int min)
	Sets the lower value of the range. More...

void	linphone_range_set_max (LinphoneRange *range, int max)
	Sets the higher value of the range. More...

LinphoneBuffer *	linphone_buffer_new (void)
	Create a new empty LinphoneBuffer object. More...

LinphoneBuffer *	linphone_buffer_new_from_data (const uint8_t *data, size_t size)
	Create a new LinphoneBuffer object from existing data. More...

LinphoneBuffer *	linphone_buffer_new_from_string (const char *data)
	Create a new LinphoneBuffer object from a string. More...

LinphoneBuffer *	linphone_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 user_data)
	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...

LinphoneCallStats *	linphone_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...

LinphoneContent *	linphone_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 user_data)
	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_add_content_type_parameter (LinphoneContent content, const char name, const char *value)
	Adds a parameter to the ContentType header. More...

const uint8_t *	linphone_content_get_buffer (const LinphoneContent *content)
	Get the content data buffer, usually a string. More...

void	linphone_content_set_buffer (LinphoneContent content, const uint8_t buffer, size_t size)
	Set the content data buffer, usually a string. More...

const char *	linphone_content_get_utf8_text (const LinphoneContent *content)
	Get the string content data buffer. More...

void	linphone_content_set_utf8_text (LinphoneContent content, const char buffer)
	Get 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...

size_t	linphone_content_get_file_size (const LinphoneContent *content)
	Get the file size if content is either a FileContent or a FileTransferContent. 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_disposition (const LinphoneContent *content)
	Get the disposition of the Content, for example "recipient-list". More...

void	linphone_content_set_disposition (LinphoneContent content, const char disposition)
	Set the disposition of the Content, for example "recipient-list". 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...

bctbx_list_t *	linphone_content_get_parts (const LinphoneContent *content)
	Get all the parts from a multipart content. More...

LinphoneContent *	linphone_content_get_part (const LinphoneContent *content, int index)
	Get a part from a multipart content according to its index. More...

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. More...

const char *	linphone_content_get_custom_header (const LinphoneContent content, const char header_name)
	Get a custom header value of a content. More...

void	linphone_content_add_custom_header (LinphoneContent content, const char header_name, const char *header_value)
	Adds a custom header in a content. More...

const char *	linphone_content_get_key (const LinphoneContent *content)
	Get the key associated with a RCS file transfer message if encrypted. More...

size_t	linphone_content_get_key_size (const LinphoneContent *content)
	Get the size of key associated with a RCS file transfer message if encrypted. More...

void	linphone_content_set_key (LinphoneContent content, const char key, const size_t key_length)
	Set the key associated with a RCS file transfer message if encrypted. More...

const char *	linphone_content_get_file_path (const LinphoneContent *content)
	Get the file transfer filepath set for this content (replace linphone_chat_message_get_file_transfer_filepath). More...

char *	linphone_content_export_plain_file (const LinphoneContent *content)
	Generates a temporary plain copy of the file and returns its paths The caller is responsible to then delete this temporary copy and the returned string. More...

void	linphone_content_set_file_path (LinphoneContent content, const char file_path)
	Set the file transfer filepath for this content (replace linphone_chat_message_set_file_transfer_filepath). More...

int	linphone_content_get_file_duration (LinphoneContent *content)
	Gets the file duration in seconds, if information is available. More...

bool_t	linphone_content_is_text (const LinphoneContent *content)
	Tells whether or not this content contains text. More...

bool_t	linphone_content_is_voice_recording (const LinphoneContent *content)
	Tells whether or not this content contains a voice recording by checking it's content type. More...

bool_t	linphone_content_is_icalendar (const LinphoneContent *content)
	Tells whether or not this content contains an icalendar by checking it's content type. More...

bool_t	linphone_content_is_file (const LinphoneContent *content)
	Tells whether or not this content contains a file. More...

bool_t	linphone_content_is_file_transfer (const LinphoneContent *content)
	Tells whether or not this content is a file transfer. More...

bool_t	linphone_content_is_file_encrypted (const LinphoneContent *content)
	Tells whether or not this content contains an encrypted file. More...

time_t	linphone_content_get_creation_timestamp (const LinphoneContent *content)
	Returns the creation timestamp if this content is a FileContent (received or sent by chat). More...

const char *	linphone_content_get_related_chat_message_id (const LinphoneContent *content)
	Returns the chat message id for which this content is related to, if any. More...

MS2_DEPRECATED const char *	linphone_content_get_string_buffer (const LinphoneContent *content)
	Get the string content data buffer. More...

MS2_DEPRECATED void	linphone_content_set_string_buffer (LinphoneContent content, const char buffer)
	Set the string content data buffer. More...

MS2_DEPRECATED char *	linphone_content_get_plain_file_path (const LinphoneContent *content)
	Generates a temporary plain copy of the file and returns its paths The caller is responsible to then delete this temporary copy and the returned string. More...

LinphoneDialPlan *	linphone_dial_plan_ref (LinphoneDialPlan *dial_plan)
	Increases the reference counter of LinphoneDialPlan objects. More...

void	linphone_dial_plan_unref (LinphoneDialPlan *dial_plan)
	Decreases the reference counter of LinphoneDialPlan objects. More...

const char *	linphone_dial_plan_get_country (const LinphoneDialPlan *dial_plan)
	Returns the country name of the dialplan. More...

const char *	linphone_dial_plan_get_iso_country_code (const LinphoneDialPlan *dial_plan)
	Returns the iso country code of the dialplan. More...

const char *	linphone_dial_plan_get_country_calling_code (const LinphoneDialPlan *dial_plan)
	Returns the country calling code of the dialplan. More...

int	linphone_dial_plan_get_national_number_length (const LinphoneDialPlan *dial_plan)
	Returns the national number length of the dialplan. More...

const char *	linphone_dial_plan_get_international_call_prefix (const LinphoneDialPlan *dial_plan)
	Returns the international call prefix of the dialplan. More...

const char *	linphone_dial_plan_get_flag (const LinphoneDialPlan *dial_plan)
	Returns the flag of the teritory as unicode characters. More...

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. More...

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. More...

bctbx_list_t *	linphone_dial_plan_get_all_list (void)
	Returns a list of all known dial plans. More...

const LinphoneDialPlan *	linphone_dial_plan_by_ccc (const char *ccc)
	Find best match for given CCC. More...

const LinphoneDialPlan *	linphone_dial_plan_by_ccc_as_int (int ccc)
	Find best match for given CCC. More...

bool_t	linphone_dial_plan_is_generic (const LinphoneDialPlan *ccc)
	Return if given plan is generic. More...

char *	linphone_dial_plan_format_phone_number (const LinphoneDialPlan dp, const char phone_number, bool_t escape_plus)
	Formats a phone number using dial plan informations. More...

MS2_DEPRECATED const LinphoneDialPlan *	linphone_dial_plan_get_all (void)
	Return NULL-terminated array of all known dial plans. More...

const char *	linphone_factory_get_config_dir (LinphoneFactory factory, void context)
	Get the config path. More...

bool_t	linphone_factory_is_config_dir_set (const LinphoneFactory *factory)
	Test if config dir has been set. More...

const char *	linphone_factory_get_data_dir (LinphoneFactory factory, void context)
	Get the data path. More...

bool_t	linphone_factory_is_data_dir_set (const LinphoneFactory *factory)
	Test if data dir has been set. More...

const char *	linphone_factory_get_download_dir (LinphoneFactory factory, void context)
	Get the download path. More...

bool_t	linphone_factory_is_download_dir_set (const LinphoneFactory *factory)
	Test if download dir has been set. More...

const char *	linphone_factory_get_cache_dir (LinphoneFactory factory, void context)
	Get the cache path. More...

bool_t	linphone_factory_is_cache_dir_set (const LinphoneFactory *factory)
	Test if cache dir has been set. More...

LinphoneMagicSearch *	linphone_magic_search_new (LinphoneCore *core)
	Constructs a LinphoneMagicSearch object. More...

LinphoneMagicSearch *	linphone_magic_search_ref (LinphoneMagicSearch *magic_search)
	Increment reference count of LinphoneMagicSearch object. More...

void	linphone_magic_search_unref (LinphoneMagicSearch *magic_search)
	Decrement reference count of LinphoneMagicSearch object. More...

void	linphone_magic_search_add_callbacks (LinphoneMagicSearch magic_search, LinphoneMagicSearchCbs cbs)
	Add a listener in order to be notified of LinphoneMagicSearch events. More...

void	linphone_magic_search_remove_callbacks (LinphoneMagicSearch magic_search, LinphoneMagicSearchCbs cbs)
	Remove a listener from a LinphoneMagicSearch. More...

LinphoneMagicSearchCbs *	linphone_magic_search_get_current_callbacks (const LinphoneMagicSearch *magic_search)
	Gets the current LinphoneMagicSearchCbs. More...

void	linphone_magic_search_set_min_weight (LinphoneMagicSearch *magic_search, unsigned int weight)
	Set the minimum value used to calculate the weight in search. More...

unsigned int	linphone_magic_search_get_min_weight (const LinphoneMagicSearch *magic_search)
	Get the minimum value used to calculate the weight in search. More...

void	linphone_magic_search_set_max_weight (LinphoneMagicSearch *magic_search, unsigned int weight)
	Set the maximum value used to calculate the weight in search. More...

unsigned int	linphone_magic_search_get_max_weight (const LinphoneMagicSearch *magic_search)
	Get the maximum value used to calculate the weight in search. More...

const char *	linphone_magic_search_get_delimiter (const LinphoneMagicSearch *magic_search)
	Get the delimiter used for the search. More...

void	linphone_magic_search_set_delimiter (LinphoneMagicSearch magic_search, const char delimiter)
	Set the delimiter used to find matched filter word. More...

bool_t	linphone_magic_search_get_use_delimiter (LinphoneMagicSearch *magic_search)
	Returns whether the delimiter is being used for the search. More...

void	linphone_magic_search_set_use_delimiter (LinphoneMagicSearch *magic_search, bool_t enable)
	Enable or disable the delimiter in search. More...

unsigned int	linphone_magic_search_get_search_limit (const LinphoneMagicSearch *magic_search)
	Gets the number of maximum search result the search will return. More...

void	linphone_magic_search_set_search_limit (LinphoneMagicSearch *magic_search, unsigned int limit)
	Sets the number of the maximum SearchResult which will be returned, if the magic search isn't configured as unlimited with linphone_magic_search_set_limited_search(). More...

bool_t	linphone_magic_search_get_limited_search (const LinphoneMagicSearch *magic_search)
	Returns whether or not the search is limited or not. More...

void	linphone_magic_search_set_limited_search (LinphoneMagicSearch *magic_search, bool_t limited)
	Enables or disables the limited search. More...

void	linphone_magic_search_reset_search_cache (LinphoneMagicSearch *magic_search)
	Reset the cache to begin a new search. More...

bctbx_list_t *	linphone_magic_search_get_contacts_list (LinphoneMagicSearch magic_search, const char filter, const char *domain, int sourceFlags, LinphoneMagicSearchAggregation aggregation)
	Create a sorted list of SearchResult which match with a filter word, from SipUri in this order : Contact's display name, address username, address domain and phone number. More...

void	linphone_magic_search_get_contacts_list_async (LinphoneMagicSearch magic_search, const char filter, const char *domain, int sourceFlags, LinphoneMagicSearchAggregation aggregation)
	This is the asynchronous version of linphone_magic_search_get_contacts(). More...

bctbx_list_t *	linphone_magic_search_get_last_search (const LinphoneMagicSearch *magic_search)

LinphoneMagicSearchCbs *	linphone_magic_search_cbs_new (void)

LinphoneMagicSearchCbs *	linphone_magic_search_cbs_ref (LinphoneMagicSearchCbs *cbs)
	Acquire a reference to the chat message callbacks object. More...

void	linphone_magic_search_cbs_unref (LinphoneMagicSearchCbs *cbs)
	Release reference to the chat message callbacks object. More...

void *	linphone_magic_search_cbs_get_user_data (const LinphoneMagicSearchCbs *cbs)
	Retrieve the user pointer associated with the chat message callbacks object. More...

void	linphone_magic_search_cbs_set_user_data (LinphoneMagicSearchCbs cbs, void user_data)
	Assign a user pointer to the chat message callbacks object. More...

LinphoneMagicSearchCbsSearchResultsReceivedCb	linphone_magic_search_cbs_get_search_results_received (const LinphoneMagicSearchCbs *cbs)
	Get the received results callback. More...

void	linphone_magic_search_cbs_set_search_results_received (LinphoneMagicSearchCbs *cbs, LinphoneMagicSearchCbsSearchResultsReceivedCb cb)
	Set the received results callback. More...

LinphoneMagicSearchCbsLdapHaveMoreResultsCb	linphone_magic_search_cbs_get_ldap_have_more_results (const LinphoneMagicSearchCbs *cbs)
	Get the ldap callback on having more results. More...

void	linphone_magic_search_cbs_set_ldap_have_more_results (LinphoneMagicSearchCbs *cbs, LinphoneMagicSearchCbsLdapHaveMoreResultsCb cb)
	Set the ldap callback on having more results. More...

LinphoneMagicSearchCbsMoreResultsAvailableCb	linphone_magic_search_cbs_get_more_results_available (const LinphoneMagicSearchCbs *cbs)
	Gets the callback notifying more results for a source flag are available. More...

void	linphone_magic_search_cbs_set_more_results_available (LinphoneMagicSearchCbs *cbs, LinphoneMagicSearchCbsMoreResultsAvailableCb cb)
	Sets the callback notifying that more results for a source flag are available. More...

LinphoneParticipant *	linphone_participant_ref (LinphoneParticipant *participant)
	Increment reference count of LinphoneParticipant object. More...

void	linphone_participant_unref (LinphoneParticipant *participant)
	Decrement reference count of LinphoneParticipant object. More...

void *	linphone_participant_get_user_data (const LinphoneParticipant *participant)
	Retrieve the user pointer associated with the conference participant. More...

void	linphone_participant_set_user_data (LinphoneParticipant participant, void user_data)
	Assign a user pointer to the conference participant. More...

const LinphoneAddress *	linphone_participant_get_address (const LinphoneParticipant *participant)
	Get the address of a conference participant. More...

bool_t	linphone_participant_is_admin (const LinphoneParticipant *participant)
	Tells whether a conference participant is an administrator of the conference. More...

bool_t	linphone_participant_is_focus (const LinphoneParticipant *participant)
	Tells whether a conference participant is the focus of the conference. More...

LinphoneChatRoomSecurityLevel	linphone_participant_get_security_level (const LinphoneParticipant *participant)
	Get the security level of a participant. More...

bctbx_list_t *	linphone_participant_get_devices (const LinphoneParticipant *participant)
	Gets the list of devices from a chat room's participant. More...

LinphoneParticipantDevice *	linphone_participant_find_device_2 (const LinphoneParticipant participant, const LinphoneCall call)
	Find a device in the list of devices from a chat room's participant. More...

LinphoneParticipantDevice *	linphone_participant_find_device (const LinphoneParticipant participant, const LinphoneAddress address)
	Find a device in the list of devices from a chat room's participant. More...

time_t	linphone_participant_get_creation_time (const LinphoneParticipant *participant)
	Get the timestamp of the creation of the participant. More...

LinphoneParticipantRole	linphone_participant_get_role (const LinphoneParticipant *participant)
	Get the role of the participant within the conference. More...

LinphoneParticipantDevice *	linphone_participant_device_ref (LinphoneParticipantDevice *participant_device)
	Increments reference count of LinphoneParticipantDevice object. More...

void	linphone_participant_device_unref (LinphoneParticipantDevice *participant_device)
	Decrements reference count of LinphoneParticipantDevice object. More...

void *	linphone_participant_device_get_user_data (const LinphoneParticipantDevice *participant_device)
	Retrieves the user pointer associated with the participant's device. More...

void	linphone_participant_device_set_user_data (LinphoneParticipantDevice participant_device, void user_data)
	Assigns a user pointer to the participant's device. More...

const LinphoneAddress *	linphone_participant_device_get_address (const LinphoneParticipantDevice *participant_device)
	Gets the address of a participant's device. More...

LinphoneParticipantDeviceState	linphone_participant_device_get_state (const LinphoneParticipantDevice *participant_device)
	Gets the state of a participant device. More...

LinphoneChatRoomSecurityLevel	linphone_participant_device_get_security_level (const LinphoneParticipantDevice *participant_device)
	Gets the security level of a participant's device. More...

const char *	linphone_participant_device_get_name (const LinphoneParticipantDevice *participant_device)
	Returns the name of the device. More...

bool_t	linphone_participant_device_is_in_conference (const LinphoneParticipantDevice *participant_device)
	Returns whether the participant device is in a conference or not. More...

time_t	linphone_participant_device_get_time_of_joining (const LinphoneParticipantDevice *participant_device)
	Gets the timestamp the device joined a conference. More...

time_t	linphone_participant_device_get_time_of_disconnection (const LinphoneParticipantDevice *participant_device)
	Gets the timestamp the device left a conference. More...

LinphoneParticipantDeviceJoiningMethod	linphone_participant_device_get_joining_method (const LinphoneParticipantDevice *participant_device)
	Gets the joining method or it the device is the focus owner. More...

LinphoneParticipantDeviceDisconnectionMethod	linphone_participant_device_get_disconnection_method (const LinphoneParticipantDevice *participant_device)
	Gets the disconnection method. More...

const char *	linphone_participant_device_get_disconnection_reason (const LinphoneParticipantDevice *participant_device)
	Gets the disconnection reason. More...

const char *	linphone_participant_device_get_stream_label (const LinphoneParticipantDevice *participant_device, const LinphoneStreamType stream_type)
	Gets the stream label of the device. More...

const char *	linphone_participant_device_get_thumbnail_stream_label (const LinphoneParticipantDevice *participant_device)
	Gets the thumbnail stream label of the device. More...

LinphoneMediaDirection	linphone_participant_device_get_stream_capability (const LinphoneParticipantDevice *participant_device, const LinphoneStreamType stream_type)
	Gets the stream capability of the device. More...

LinphoneMediaDirection	linphone_participant_device_get_thumbnail_stream_capability (const LinphoneParticipantDevice *participant_device)
	Gets the thumbnail stream capability of the device. More...

bool_t	linphone_participant_device_get_stream_availability (const LinphoneParticipantDevice *participant_device, const LinphoneStreamType stream_type)
	Gets the stream availability of the device. More...

bool_t	linphone_participant_device_get_thumbnail_stream_availability (const LinphoneParticipantDevice *participant_device)
	Gets the thumbnail stream availability of the device. More...

uint32_t	linphone_participant_device_get_ssrc (const LinphoneParticipantDevice *participant_device, const LinphoneStreamType stream_type)
	Get the audio stream SSRC of the device. More...

uint32_t	linphone_participant_device_get_thumbnail_ssrc (const LinphoneParticipantDevice *participant_device)
	Get the thumbnail stream SSRC of the device. More...

void	linphone_participant_device_add_callbacks (LinphoneParticipantDevice participant_device, LinphoneParticipantDeviceCbs cbs)
	Add a listener in order to be notified of LinphoneParticipantDevice events. More...

void	linphone_participant_device_remove_callbacks (LinphoneParticipantDevice participant_device, LinphoneParticipantDeviceCbs cbs)
	Remove a listener from a LinphoneParticipantDevice. More...

LinphoneParticipantDeviceCbs *	linphone_participant_device_get_current_callbacks (const LinphoneParticipantDevice *participant_device)
	Gets the current LinphoneParticipantDeviceCbs. More...

void	linphone_participant_device_set_native_video_window_id (LinphoneParticipantDevice participant_device, void window_id)
	Sets the the native window ID where video for this participant device is to be rendered. More...

void *	linphone_participant_device_get_native_video_window_id (const LinphoneParticipantDevice *participant_device)
	Gets the native window ID where video for this participant device is to be rendered. More...

void *	linphone_participant_device_create_native_video_window_id_2 (LinphoneParticipantDevice participant_device, void context)
	Creates a window ID and return it. More...

void *	linphone_participant_device_create_native_video_window_id (LinphoneParticipantDevice *participant_device)
	Creates a window ID and return it. More...

bool_t	linphone_participant_device_get_is_speaking (const LinphoneParticipantDevice *participant_device)
	Returns whether the participant device is speaking or not. More...

bool_t	linphone_participant_device_get_is_muted (const LinphoneParticipantDevice *participant_device)
	Returns whether the participant device is muted or not. More...

bool_t	linphone_participant_device_screen_sharing_enabled (const LinphoneParticipantDevice *participant_device)
	Returns whether the participant device is screen sharing or not. More...

LinphoneParticipant *	linphone_participant_device_get_participant (const LinphoneParticipantDevice *participant_device)
	Returns the LinphoneParticipant this LinphoneParticipantDevice belongs to. More...

LinphoneParticipantDeviceIdentity *	linphone_participant_device_identity_new (const LinphoneAddress address, const char name)
	Constructs a LinphoneParticipantDeviceIdentity object. More...

LinphoneParticipantDeviceIdentity *	linphone_participant_device_identity_ref (LinphoneParticipantDeviceIdentity *device_identity)
	Increment reference count of LinphoneParticipantDeviceIdentity object. More...

void	linphone_participant_device_identity_unref (LinphoneParticipantDeviceIdentity *device_identity)
	Decrement reference count of LinphoneParticipantDeviceIdentity object. More...

MS2_DEPRECATED void	linphone_participant_device_identity_set_capability_descriptor (LinphoneParticipantDeviceIdentity device_identity, const char capability_descriptor)
	Set the capability descriptor (currently +org.linphone.specs value) for this participant device identity. More...

void	linphone_participant_device_identity_set_capability_descriptor_2 (LinphoneParticipantDeviceIdentity device_identity, const bctbx_list_t capability_descriptor_list)
	Set the capability descriptor (currently +org.linphone.specs value) for this participant device identity. More...

MS2_DEPRECATED const char *	linphone_participant_device_identity_get_capability_descriptor (const LinphoneParticipantDeviceIdentity *device_identity)
	Get the capability descriptor (currently +org.linphone.specs value) for this participant device identity. More...

const bctbx_list_t *	linphone_participant_device_identity_get_capability_descriptor_list (const LinphoneParticipantDeviceIdentity *device_identity)
	Get the capability descriptor (currently +org.linphone.specs value) for this participant device identity. More...

const LinphoneAddress *	linphone_participant_device_identity_get_address (const LinphoneParticipantDeviceIdentity *device_identity)
	Get the address of the participant device. More...

LinphoneParticipantImdnState *	linphone_participant_imdn_state_ref (LinphoneParticipantImdnState *state)
	Increment reference count of LinphoneParticipantImdnState object. More...

void	linphone_participant_imdn_state_unref (LinphoneParticipantImdnState *state)
	Decrement reference count of LinphoneParticipantImdnState object. More...

void *	linphone_participant_imdn_state_get_user_data (const LinphoneParticipantImdnState *state)
	Retrieve the user pointer associated with a LinphoneParticipantImdnState. More...

void	linphone_participant_imdn_state_set_user_data (LinphoneParticipantImdnState state, void user_data)
	Assign a user pointer to a LinphoneParticipantImdnState. More...

const LinphoneParticipant *	linphone_participant_imdn_state_get_participant (const LinphoneParticipantImdnState *state)
	Get the participant concerned by a LinphoneParticipantImdnState. More...

LinphoneChatMessageState	linphone_participant_imdn_state_get_state (const LinphoneParticipantImdnState *state)
	Get the chat message state the participant is in. More...

time_t	linphone_participant_imdn_state_get_state_change_time (const LinphoneParticipantImdnState *state)
	Get the timestamp at which a participant has reached the state described by a LinphoneParticipantImdnState. More...

LinphonePushNotificationMessage *	linphone_push_notification_message_new (const char call_id, bool_t is_text, const char text_content, const char subject, const char from_addr, const char local_addr, const char peer_addr, bool_t is_icalendar)
	Safely cast a belle_sip_object_t into LinphonePushNotificationMessage.

LinphonePushNotificationMessage *	linphone_push_notification_message_ref (LinphonePushNotificationMessage *message)
	Take a reference on a LinphonePushNotificationMessage. More...

void	linphone_push_notification_message_unref (LinphonePushNotificationMessage *message)
	Release a LinphonePushNotificationMessage. More...

const char *	linphone_push_notification_message_get_call_id (const LinphonePushNotificationMessage *message)
	Gets the call id. More...

bool_t	linphone_push_notification_message_is_text (const LinphonePushNotificationMessage *message)
	Returns wether it is a text message or not. More...

const char *	linphone_push_notification_message_get_text_content (const LinphonePushNotificationMessage *message)
	Gets the text content. More...

const char *	linphone_push_notification_message_get_subject (const LinphonePushNotificationMessage *message)
	Gets the subject. More...

const LinphoneAddress *	linphone_push_notification_message_get_from_addr (const LinphonePushNotificationMessage *message)
	Gets the from address. More...

const LinphoneAddress *	linphone_push_notification_message_get_local_addr (const LinphonePushNotificationMessage *message)
	Gets the local address. More...

const LinphoneAddress *	linphone_push_notification_message_get_peer_addr (const LinphonePushNotificationMessage *message)
	Gets the peer address. More...

const char *	linphone_push_notification_message_get_reaction_content (const LinphonePushNotificationMessage *message)
	Gets the reaction content. More...

bool_t	linphone_push_notification_message_is_icalendar (const LinphonePushNotificationMessage *message)
	Tells whether or not this message contains an icalendar by checking it's content type. More...

bool_t	linphone_push_notification_message_is_conference_invitation_new (const LinphonePushNotificationMessage *message)
	Tells whether or not this message contains a new conference invitation. More...

bool_t	linphone_push_notification_message_is_conference_invitation_update (const LinphonePushNotificationMessage *message)
	Tells whether or not this message contains a conference invitation update. More...

bool_t	linphone_push_notification_message_is_conference_invitation_cancellation (const LinphonePushNotificationMessage *message)
	Tells whether or not this message contains a conference invitation cancellation. More...

LinphonePushNotificationConfig *	linphone_push_notification_config_new (void)
	Safely cast a belle_sip_object_t into LinphonePushNotificationMessage.

LinphonePushNotificationConfig *	linphone_push_notification_config_clone (const LinphonePushNotificationConfig *push_cfg)
	Instantiate a new push notification parameters with values from source. More...

bool_t	linphone_push_notification_config_is_equal (const LinphonePushNotificationConfig push_cfg, const LinphonePushNotificationConfig other_config)
	Checks if two Push Notification Configurations are identical. More...

LinphonePushNotificationConfig *	linphone_push_notification_config_ref (LinphonePushNotificationConfig *push_cfg)
	Take a reference on a LinphonePushNotificationConfig. More...

void	linphone_push_notification_config_unref (LinphonePushNotificationConfig *push_cfg)
	Release a LinphonePushNotificationConfig. More...

const char *	linphone_push_notification_config_get_provider (const LinphonePushNotificationConfig *push_cfg)
	Gets the provider for "contact uri parameter". More...

void	linphone_push_notification_config_set_provider (LinphonePushNotificationConfig push_cfg, const char provider)
	Sets the provider for "contact uri parameter". More...

void	linphone_push_notification_config_set_remote_push_interval (LinphonePushNotificationConfig push_cfg, const char remote_push_interval)
	Specifies the interval in seconds between to subsequent remote push notifications when remote push notifications are used to notify a call invite to clients that haven't published any token for VoIP and background push notifications. More...

const char *	linphone_push_notification_config_get_team_id (const LinphonePushNotificationConfig *push_cfg)
	Gets the team id for "contact uri parameter". More...

void	linphone_push_notification_config_set_team_id (LinphonePushNotificationConfig push_cfg, const char team_id)
	Sets the team id for "contact uri parameter". More...

const char *	linphone_push_notification_config_get_msg_str (const LinphonePushNotificationConfig *push_cfg)
	Gets the msg_str for "contact uri parameter". More...

void	linphone_push_notification_config_set_msg_str (LinphonePushNotificationConfig push_cfg, const char msg_str)
	Sets the msg_str for "contact uri parameter", specific for remote push notification. More...

const char *	linphone_push_notification_config_get_call_str (const LinphonePushNotificationConfig *push_cfg)
	Gets the call_str for "contact uri parameter". More...

void	linphone_push_notification_config_set_call_str (LinphonePushNotificationConfig push_cfg, const char call_str)
	Sets the call_str for "contact uri parameter", specific for remote push notification. More...

const char *	linphone_push_notification_config_get_group_chat_str (const LinphonePushNotificationConfig *push_cfg)
	Gets the groupchat_str for "contact uri parameter". More...

void	linphone_push_notification_config_set_group_chat_str (LinphonePushNotificationConfig push_cfg, const char group_chat_str)
	Sets the group_chat_str for "contact uri parameter", specific for remote push notification. More...

const char *	linphone_push_notification_config_get_call_snd (const LinphonePushNotificationConfig *push_cfg)
	Gets the call_snd for "contact uri parameter". More...

void	linphone_push_notification_config_set_call_snd (LinphonePushNotificationConfig push_cfg, const char call_snd)
	Sets the call_snd for "contact uri parameter", specific for remote push notification. More...

const char *	linphone_push_notification_config_get_msg_snd (const LinphonePushNotificationConfig *push_cfg)
	Gets the msg_snd for "contact uri parameter". More...

void	linphone_push_notification_config_set_msg_snd (LinphonePushNotificationConfig push_cfg, const char msg_snd)
	Sets the msg_snd for "contact uri parameter", specific for remote push notification. More...

const char *	linphone_push_notification_config_get_bundle_identifier (const LinphonePushNotificationConfig *push_cfg)
	Gets the app's bundle identifier for "contact uri parameter". More...

void	linphone_push_notification_config_set_bundle_identifier (LinphonePushNotificationConfig push_cfg, const char bundle_identifier)
	Sets the bundle_identifier for "contact uri parameter". More...

const char *	linphone_push_notification_config_get_voip_token (const LinphonePushNotificationConfig *push_cfg)
	Gets the voip token for "contact uri parameter". More...

void	linphone_push_notification_config_set_voip_token (LinphonePushNotificationConfig push_cfg, const char voip_token)
	Sets the voip_token for "contact uri parameter", specific for voip push notification. More...

const char *	linphone_push_notification_config_get_remote_token (const LinphonePushNotificationConfig *push_cfg)
	Gets the remote token for "contact uri parameter". More...

void	linphone_push_notification_config_set_remote_token (LinphonePushNotificationConfig push_cfg, const char remote_token)
	Sets the remote_token for "contact uri parameter", specific for remote push notification. More...

const char *	linphone_push_notification_config_get_param (const LinphonePushNotificationConfig *push_cfg)
	Gets the param for "contact uri parameter". More...

void	linphone_push_notification_config_set_param (LinphonePushNotificationConfig push_cfg, const char param)
	Sets the param for "contact uri parameter". More...

const char *	linphone_push_notification_config_get_prid (const LinphonePushNotificationConfig *push_cfg)
	Gets the prid for "contact uri parameter". More...

void	linphone_push_notification_config_set_prid (LinphonePushNotificationConfig push_cfg, const char prid)
	Sets the prid for "contact uri parameter". More...

LinphoneSearchResult *	linphone_search_result_ref (LinphoneSearchResult *search_result)
	Increment reference count of LinphoneSearchResult object. More...

void	linphone_search_result_unref (LinphoneSearchResult *search_result)
	Decrement reference count of LinphoneSearchResult object. More...

LinphoneFriend *	linphone_search_result_get_friend (const LinphoneSearchResult *search_result)
	Gets the friend of the search result if any. More...

const LinphoneAddress *	linphone_search_result_get_address (const LinphoneSearchResult *search_result)
	Gets the address of the search result if any. More...

const char *	linphone_search_result_get_phone_number (const LinphoneSearchResult *search_result)
	Gets the phone number of the search result if any. More...

int	linphone_search_result_get_capabilities (const LinphoneSearchResult *search_result)
	Returns the capabilities mask of the search result. More...

bool_t	linphone_search_result_has_capability (const LinphoneSearchResult *search_result, const LinphoneFriendCapability capability)
	Returns whether or not the search result has the given capability. More...

unsigned int	linphone_search_result_get_weight (const LinphoneSearchResult *search_result)
	Gets the weight of the search result. More...

int	linphone_search_result_get_source_flags (const LinphoneSearchResult *search_result)
	Gets source flags of the search result. More...

bool_t	linphone_search_result_has_source_flag (const LinphoneSearchResult *search_result, const LinphoneMagicSearchSource source)
	Returns whether or not the search result has the given source flag. More...

Detailed Description

Miscenalleous: logs, version strings, config storage.

Typedef Documentation

◆ LinphoneContent

typedef struct _LinphoneContent LinphoneContent

This object holds data that can be embedded in a signaling message or IM message.

Use linphone_core_create_content() to create it, and then you should set at least it's type and subtype and fill the buffer with your data.

A LinphoneContent can be multipart (contain other contents), have file information (name, path, size), be encrypted, have custom headers, etc...

◆ LinphoneCoreCbsChatRoomExhumedCb

typedef void(* LinphoneCoreCbsChatRoomExhumedCb) (LinphoneCore *core, LinphoneChatRoom *chat_room)

Callback used to notify a chat room has been exhumed.

Internal use only!

Parameters

core	LinphoneCore object
chat_room	LinphoneChatRoom object

◆ LinphoneCoreCbsEcCalibrationAudioInitCb

typedef void(* LinphoneCoreCbsEcCalibrationAudioInitCb) (LinphoneCore *core)

Function prototype used by linphone_core_cbs_set_ec_calibration_audio_init().

Parameters

core	The LinphoneCore.

◆ LinphoneCoreCbsEcCalibrationAudioUninitCb

typedef void(* LinphoneCoreCbsEcCalibrationAudioUninitCb) (LinphoneCore *core)

Function prototype used by linphone_core_cbs_set_ec_calibration_audio_uninit().

Parameters

core	The LinphoneCore.

◆ LinphoneCoreCbsEcCalibrationResultCb

typedef void(* LinphoneCoreCbsEcCalibrationResultCb) (LinphoneCore *core, LinphoneEcCalibratorStatus status, int delay_ms)

Function prototype used by linphone_core_cbs_set_ec_calibration_result().

Parameters

core	The LinphoneCore.
status	The LinphoneEcCalibratorStatus of the calibrator.
delay_ms	The measured delay if available.

◆ 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.

◆ LinphoneHeaders

typedef struct _LinphoneHeaders LinphoneHeaders

Object representing a chain of protocol headers.

It provides read/write access to the headers of the underlying protocol.

◆ LinphoneImEncryptionEngine

typedef struct _LinphoneImEncryptionEngine LinphoneImEncryptionEngine

IM encryption engine.

See also: https://wiki.linphone.org/xwiki/wiki/public/view/Lib/Features/Instant%20Messaging%20Encryption%20Engine/

◆ LinphoneImEncryptionEngineCbs

typedef struct _LinphoneImEncryptionEngineCbs LinphoneImEncryptionEngineCbs

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

◆ LinphoneImEncryptionEngineCbsDownloadingFileCb

typedef int(* LinphoneImEncryptionEngineCbsDownloadingFileCb) (LinphoneImEncryptionEngine *engine, LinphoneChatMessage *message, size_t offset, const uint8_t *buffer, size_t size, uint8_t *decrypted_buffer)

Callback to decrypt downloading file.

Parameters

	engine	LinphoneImEncryptionEngine object
	message	LinphoneChatMessage object
	offset	The current offset of the upload
	buffer	Encrypted data buffer
	size	Size of the encrypted data buffer and maximum size of the decrypted data buffer
[out]	decrypted_buffer	Buffer in which to write the decrypted data which maximum size is size

Returns: -1 if nothing to be done, 0 on success or an integer > 0 for error

◆ LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb

typedef void(* LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *chat_room, LinphoneChatMessage *message)

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

engine	LinphoneImEncryptionEngine object
chat_room	LinphoneChatRoom object
message	LinphoneChatMessage object

◆ LinphoneImEncryptionEngineCbsIncomingMessageCb

typedef int(* LinphoneImEncryptionEngineCbsIncomingMessageCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *chat_room, LinphoneChatMessage *message)

Callback to decrypt incoming LinphoneChatMessage.

Parameters

engine	The LinphoneImEncryptionEngine object
chat_room	LinphoneChatRoom object
message	LinphoneChatMessage 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 *chat_room)

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

Parameters

engine	LinphoneImEncryptionEngine object
chat_room	LinphoneChatRoom object

Returns: TRUE if files will be encrypted, FALSE otherwise

◆ LinphoneImEncryptionEngineCbsOutgoingMessageCb

typedef int(* LinphoneImEncryptionEngineCbsOutgoingMessageCb) (LinphoneImEncryptionEngine *engine, LinphoneChatRoom *chat_room, LinphoneChatMessage *message)

Callback to encrypt outgoing LinphoneChatMessage.

Parameters

engine	LinphoneImEncryptionEngine object
chat_room	LinphoneChatRoom object
message	LinphoneChatMessage object

Returns: -1 if nothing to be done, 0 on success or an integer > 0 for error

◆ LinphoneImEncryptionEngineCbsUploadingFileCb

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

Callback to encrypt uploading file.

Parameters

	engine	LinphoneImEncryptionEngine object
	message	LinphoneChatMessage object
	offset	The current offset of the upload
	buffer	Encrypted data buffer
[in,out]	size	Size of the plain data buffer and the size of the encrypted data buffer once encryption is done
[out]	encrypted_buffer	Buffer in which to write the encrypted data which maxmimum size is size

Returns: -1 if nothing to be done, 0 on success or an integer > 0 for error

◆ LinphoneMagicSearchCbsLdapHaveMoreResultsCb

typedef void(* LinphoneMagicSearchCbsLdapHaveMoreResultsCb) (LinphoneMagicSearch *magic_search, LinphoneLdap *ldap)

Callback used to notify when LDAP have more results available.

Parameters

magic_search	LinphoneMagicSearch object
ldap	LinphoneLdap object

Deprecated:: 18/11/2024 use LinphoneMagicSearchCbsMoreResultsAvailableCb instead.

◆ LinphoneMagicSearchCbsMoreResultsAvailableCb

typedef void(* LinphoneMagicSearchCbsMoreResultsAvailableCb) (LinphoneMagicSearch *magic_search, LinphoneMagicSearchSource source)

Callback used to notify when more results are available for a given LinphoneMagicSearchSource flag.

Parameters

magic_search	LinphoneMagicSearch object
source	The source flag indicating for which type of result there is more results available.

◆ LinphoneMagicSearchCbsSearchResultsReceivedCb

typedef void(* LinphoneMagicSearchCbsSearchResultsReceivedCb) (LinphoneMagicSearch *magic_search)

Callback used to notify when results are received.

Parameters

magic_search LinphoneMagicSearch object

◆ LinphoneReason

typedef enum _LinphoneReason 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()

◆ LinphoneSecurityLevel

typedef enum _LinphoneSecurityLevel LinphoneSecurityLevel

Security level determined by type of encryption (point-to-point, end-to-end, etc...) and whether or not a SAS validation was made with the remote(s) end(s).

A LinphoneSecurityLevelEndToEndEncryptedAndVerified level means it's end-to-end encrypted and SAS validation was made. An LinphoneSecurityLevelUnsafe level means end-to-end-encrypted but it's likely a man-in-the-middle exists between you and one device.

◆ LinphoneXmlRpcRequestCbsResponseCb

typedef void(* LinphoneXmlRpcRequestCbsResponseCb) (LinphoneXmlRpcRequest *request)

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

Parameters

request LinphoneXmlRpcRequest object

Enumeration Type Documentation

◆ _LinphoneReason

enum _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.
LinphoneReasonBadEvent	Bad event.
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.
LinphoneReasonSessionIntervalTooSmall	The received request contains a Session-Expires header field with a duration below the minimum timer.
LinphoneReasonServerTimeout	Server timeout.
LinphoneReasonUnknown	Unknown reason.
LinphoneReasonTransferred	The call has been transferred.
LinphoneReasonConditionalRequestFailed	Conditional Request Failed.

◆ _LinphoneSecurityLevel

enum _LinphoneSecurityLevel

Security level determined by type of encryption (point-to-point, end-to-end, etc...) and whether or not a SAS validation was made with the remote(s) end(s).

A LinphoneSecurityLevelEndToEndEncryptedAndVerified level means it's end-to-end encrypted and SAS validation was made. An LinphoneSecurityLevelUnsafe level means end-to-end-encrypted but it's likely a man-in-the-middle exists between you and one device.

Enumerator
LinphoneSecurityLevelUnsafe	Security failure.
LinphoneSecurityLevelNone	No encryption.
LinphoneSecurityLevelEndToEndEncrypted	End-to-end encrypted.
LinphoneSecurityLevelEndToEndEncryptedAndVerified	End-to-end encrypted and verified.
LinphoneSecurityLevelPointToPointEncrypted	Point-to-point encrypted.

◆ _LinphoneToneID

enum _LinphoneToneID

Enum listing frequent telephony tones.

Enumerator
LinphoneToneUndefined	Not a tone.
LinphoneToneBusy	Busy tone.
LinphoneToneCallWaiting	Call waiting tone.
LinphoneToneCallOnHold	Call on hold tone.
LinphoneToneCallLost	Tone played when call is abruptly disconnected (media lost)
LinphoneToneCallEnd	When the call end for any reason but lost.
LinphoneToneCallNotAnswered	When the call is not answered.
LinphoneToneSasCheckRequired	When the SAS check is required.

Function Documentation

◆ linphone_buffer_get_content()

const uint8_t* linphone_buffer_get_content ( const LinphoneBuffer * buffer )

Get the content of the data buffer.

Parameters

buffer LinphoneBuffer 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

buffer LinphoneBuffer 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

buffer LinphoneBuffer 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

buffer LinphoneBuffer 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

buffer LinphoneBuffer 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

data	The initial data to store in the LinphoneBuffer.
size	The size of the initial data to store 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

data	The 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

buffer LinphoneBuffer 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

buffer	LinphoneBuffer object.
content	The content of the data buffer.
size	The 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

buffer	LinphoneBuffer object
size	The 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

buffer	LinphoneBuffer object.
content	The string content of the data buffer.

◆ linphone_buffer_set_user_data()

void linphone_buffer_set_user_data	(	LinphoneBuffer *	buffer,
		void *	user_data
	)

Assign a user pointer to the buffer.

Parameters

buffer	LinphoneBuffer object.
user_data	The user pointer to associate with the buffer.

◆ linphone_buffer_unref()

void linphone_buffer_unref ( LinphoneBuffer * buffer )

Release reference to the buffer.

Parameters

buffer LinphoneBuffer object.

◆ linphone_call_stats_get_user_data()

void* linphone_call_stats_get_user_data ( const LinphoneCallStats * stats )

Gets the user data in the LinphoneCallStats object.

Parameters

[in] stats the LinphoneCallStats

Returns: the user data.

◆ linphone_call_stats_ref()

LinphoneCallStats* linphone_call_stats_ref ( LinphoneCallStats * stats )

Increment refcount.

Parameters

stats LinphoneCallStats object

Returns: the same LinphoneCallStats object

◆ linphone_call_stats_set_user_data()

void linphone_call_stats_set_user_data	(	LinphoneCallStats *	stats,
		void *	data
	)

Sets the user data in the LinphoneCallStats object.

Parameters

[in]	stats	the LinphoneCallStats object
[in]	data	the user data.

◆ linphone_call_stats_unref()

void linphone_call_stats_unref ( LinphoneCallStats * stats )

Decrement refcount and possibly free the object.

Parameters

stats LinphoneCallStats object

◆ linphone_configuring_state_to_string()

const char* linphone_configuring_state_to_string ( LinphoneConfiguringState state )

Converts a LinphoneConfiguringState enum to a string.

Parameters

state LinphoneConfiguringState the value for which we want a string representation

Returns: a string representation of the LinphoneConfiguringState

◆ linphone_content_add_content_type_parameter()

void linphone_content_add_content_type_parameter	(	LinphoneContent *	content,
		const char *	name,
		const char *	value
	)

Adds a parameter to the ContentType header.

Parameters

content	LinphoneContent object.
name	the name of the parameter to add.
value	the value of the parameter to add.

◆ linphone_content_add_custom_header()

void linphone_content_add_custom_header	(	LinphoneContent *	content,
		const char *	header_name,
		const char *	header_value
	)

Adds a custom header in a content.

Parameters

content	LinphoneContent object.
header_name	The name of the header to add.
header_value	The value of the header to add.

◆ linphone_content_export_plain_file()

char* linphone_content_export_plain_file ( const LinphoneContent * content )

Generates a temporary plain copy of the file and returns its paths The caller is responsible to then delete this temporary copy and the returned string.

Parameters

[in] content LinphoneContent object.

Returns: The file path set for this content if it has been set, NULL otherwise.

◆ 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

content	LinphoneContent object.
header_name	The name of the header to look for.
header_value	The value of the header to look for.

Returns: A LinphoneContent object object the part if found, NULL otherwise.

◆ linphone_content_get_buffer()

const uint8_t* linphone_content_get_buffer ( const LinphoneContent * content )

Get the content data buffer, usually a string.

Parameters

content LinphoneContent object.

Returns: The content data buffer.

◆ linphone_content_get_creation_timestamp()

time_t linphone_content_get_creation_timestamp ( const LinphoneContent * content )

Returns the creation timestamp if this content is a FileContent (received or sent by chat).

Parameters

content LinphoneContent object.

Returns: The timestamp at which this content was created if available, -1 otherwise.

◆ 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

content	LinphoneContent object.
header_name	The name of the header to get the value from.

Returns: The value of the header if found, NULL otherwise.

◆ linphone_content_get_disposition()

const char* linphone_content_get_disposition ( const LinphoneContent * content )

Get the disposition of the Content, for example "recipient-list".

Parameters

content LinphoneContent object.

Returns: The disposition of the Content.

◆ linphone_content_get_encoding()

const char* linphone_content_get_encoding ( const LinphoneContent * content )

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

Parameters

content LinphoneContent object.

Returns: The encoding of the data buffer.

◆ linphone_content_get_file_duration()

int linphone_content_get_file_duration ( LinphoneContent * content )

Gets the file duration in seconds, if information is available.

Parameters

content LinphoneContent object.

Returns: The duration of the file in milliseconds or -1 if information isn't available.

◆ linphone_content_get_file_path()

const char* linphone_content_get_file_path ( const LinphoneContent * content )

Get the file transfer filepath set for this content (replace linphone_chat_message_get_file_transfer_filepath).

Parameters

content LinphoneContent object.

Returns: The file path set for this content if it has been set, NULL otherwise.

◆ linphone_content_get_file_size()

size_t linphone_content_get_file_size ( const LinphoneContent * content )

Get the file size if content is either a FileContent or a FileTransferContent.

Parameters

content LinphoneContent object.

Returns: The represented file size.

◆ linphone_content_get_key()

const char* linphone_content_get_key ( const LinphoneContent * content )

Get the key associated with a RCS file transfer message if encrypted.

Parameters

content LinphoneContent object.

Returns: The key to encrypt/decrypt the file associated to this content.

◆ linphone_content_get_key_size()

size_t linphone_content_get_key_size ( const LinphoneContent * content )

Get the size of key associated with a RCS file transfer message if encrypted.

Parameters

content LinphoneContent object.

Returns: The key size in bytes

◆ 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

content LinphoneContent object.

Returns: The name of the content.

◆ linphone_content_get_part()

LinphoneContent* linphone_content_get_part	(	const LinphoneContent *	content,
		int	index
	)

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

Parameters

content	LinphoneContent object.
index	The index of the part to get.

Returns: A LinphoneContent object holding the part if found, NULL otherwise.

◆ linphone_content_get_parts()

bctbx_list_t* linphone_content_get_parts ( const LinphoneContent * content )

Get all the parts from a multipart content.

Parameters

content LinphoneContent object.

Returns: A object holding the part if found, NULL otherwise.

◆ linphone_content_get_plain_file_path()

MS2_DEPRECATED char* linphone_content_get_plain_file_path ( const LinphoneContent * content )

Generates a temporary plain copy of the file and returns its paths The caller is responsible to then delete this temporary copy and the returned string.

Parameters

[in] content LinphoneContent object.

Returns: The file path set for this content if it has been set, NULL otherwise.

Deprecated:: 2022-01-07. Use linphone_content_export_plain_file() instead.

◆ linphone_content_get_related_chat_message_id()

const char* linphone_content_get_related_chat_message_id ( const LinphoneContent * content )

Returns the chat message id for which this content is related to, if any.

Parameters

content LinphoneContent object.

Returns: The chat message ID if this content is related to a chat message, 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

content LinphoneContent object.

Returns: The content data buffer size.

◆ linphone_content_get_string_buffer()

MS2_DEPRECATED const char* linphone_content_get_string_buffer ( const LinphoneContent * content )

Get the string content data buffer.

Parameters

content LinphoneContent object

Returns: The string content data buffer.

Deprecated:: 2020-07-01. Use linphone_content_get_utf8_text() instead.

◆ linphone_content_get_subtype()

const char* linphone_content_get_subtype ( const LinphoneContent * content )

Get the mime subtype of the content data.

Parameters

content LinphoneContent 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

content LinphoneContent 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

content LinphoneContent object.

Returns: The user pointer associated with the content.

◆ linphone_content_get_utf8_text()

const char* linphone_content_get_utf8_text ( const LinphoneContent * content )

Get the string content data buffer.

Introduced in 01/07/2020

Parameters

content LinphoneContent object.

Returns: The string content data buffer in UTF8.

◆ linphone_content_is_file()

bool_t linphone_content_is_file ( const LinphoneContent * content )

Tells whether or not this content contains a file.

Parameters

content LinphoneContent object.

Returns: TRUE if this content contains a file, FALSE otherwise.

◆ linphone_content_is_file_encrypted()

bool_t linphone_content_is_file_encrypted ( const LinphoneContent * content )

Tells whether or not this content contains an encrypted file.

Parameters

content LinphoneContent object.

Returns: True is this content contains a file and this file is encrypted, false otherwise.

◆ linphone_content_is_file_transfer()

bool_t linphone_content_is_file_transfer ( const LinphoneContent * content )

Tells whether or not this content is a file transfer.

Parameters

content LinphoneContent object.

Returns: TRUE if this content is a file transfer, FALSE otherwise.

◆ linphone_content_is_icalendar()

bool_t linphone_content_is_icalendar ( const LinphoneContent * content )

Tells whether or not this content contains an icalendar by checking it's content type.

Parameters

content LinphoneContent object.

Returns: TRUE if this content type is 'text/calendar;conference-event=yes', FALSE otherwise.

◆ linphone_content_is_multipart()

bool_t linphone_content_is_multipart ( const LinphoneContent * content )

Tell whether a content is a multipart content.

Parameters

content LinphoneContent object.

Returns: A boolean value telling whether the content is multipart or not.

◆ linphone_content_is_text()

bool_t linphone_content_is_text ( const LinphoneContent * content )

Tells whether or not this content contains text.

Parameters

content LinphoneContent object.

Returns: TRUE if this content contains plain text, FALSE otherwise.

◆ linphone_content_is_voice_recording()

bool_t linphone_content_is_voice_recording ( const LinphoneContent * content )

Tells whether or not this content contains a voice recording by checking it's content type.

Parameters

content LinphoneContent object.

Returns: TRUE if this content type is 'audio/wav;voice-recording=yes', FALSE otherwise.

◆ linphone_content_ref()

LinphoneContent* linphone_content_ref ( LinphoneContent * content )

Acquire a reference to the content.

Parameters

content LinphoneContent object.

Returns: The same LinphoneContent object.

◆ linphone_content_set_buffer()

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

Set the content data buffer, usually a string.

Parameters

content	LinphoneContent object.
buffer	The content data buffer.
size	The size of the content data buffer.

◆ linphone_content_set_disposition()

void linphone_content_set_disposition	(	LinphoneContent *	content,
		const char *	disposition
	)

Set the disposition of the Content, for example "recipient-list".

Parameters

content	LinphoneContent object.
disposition	The disposition of the Content.

◆ 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

content	LinphoneContent object.
encoding	The encoding of the data buffer.

◆ linphone_content_set_file_path()

void linphone_content_set_file_path	(	LinphoneContent *	content,
		const char *	file_path
	)

Set the file transfer filepath for this content (replace linphone_chat_message_set_file_transfer_filepath).

Parameters

content	LinphoneContent object.
file_path	the file transfer filepath.

◆ linphone_content_set_key()

void linphone_content_set_key	(	LinphoneContent *	content,
		const char *	key,
		const size_t	key_length
	)

Set the key associated with a RCS file transfer message if encrypted.

Parameters

content	LinphoneContent object.
key	The key to be used to encrypt/decrypt file associated to this content.
key_length	The lengh of the key.

◆ 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

content	LinphoneContent object.
name	The 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

content	LinphoneContent object
size	The content data buffer size.

◆ linphone_content_set_string_buffer()

MS2_DEPRECATED void linphone_content_set_string_buffer	(	LinphoneContent *	content,
		const char *	buffer
	)

Set the string content data buffer.

Parameters

content	LinphoneContent object.
buffer	The string content data buffer in UTF8.

Deprecated:: 2020-07-01. Use linphone_content_set_utf8_text() instead.

◆ linphone_content_set_subtype()

void linphone_content_set_subtype	(	LinphoneContent *	content,
		const char *	subtype
	)

Set the mime subtype of the content data.

Parameters

content	LinphoneContent object.
subtype	The 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

content	LinphoneContent object.
type	The mime type of the content data, for example "application".

◆ linphone_content_set_user_data()

void linphone_content_set_user_data	(	LinphoneContent *	content,
		void *	user_data
	)

Assign a user pointer to the content.

Parameters

content	LinphoneContent object.
user_data	The user pointer to associate with the content.

◆ linphone_content_set_utf8_text()

void linphone_content_set_utf8_text	(	LinphoneContent *	content,
		const char *	buffer
	)

Get the string content data buffer.

Introduced in 01/07/2020

Parameters

content	LinphoneContent object.
buffer	The string content data buffer in UTF8.

◆ linphone_content_unref()

void linphone_content_unref ( LinphoneContent * content )

Release reference to the content.

Parameters

content LinphoneContent object.

◆ linphone_core_check_for_update()

void linphone_core_check_for_update	(	LinphoneCore *	core,
		const char *	current_version
	)

Asynchronously checks if a new version of the application is available from a well-known http server URI given by LinphoneCore 's configuration.

The result of the check is given through the LinphoneCoreCbs interface, see linphone_core_cbs_set_version_update_check_result_received(). The http URI has to be given in [misc] section as key 'version_check_url_root'. The subdirectory is appended to this root URI, per platform, and a "VERSION" file is fetched. For example:

https://download.linphone.org/releases/android/RELEASE
https://download.linphone.org/releases/windows/RELEASE The RELEASE file is expected to contain the most recent version number available followed by an http uri where this version can be retrieved. For example: 5.2.5 https://play.google.com/store/apps/details?id=org.linphone
Parameters

core LinphoneCore object

current_version The current version of the application

◆ linphone_core_config_sync()

LinphoneStatus linphone_core_config_sync ( LinphoneCore * core )

Forces a flush of the config to disk.

Parameters

core	The LinphoneCore object

Returns: 0 if successful, -1 otherwise

◆ linphone_core_create_config()

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

Create a LinphoneConfig object from a user config file.

Parameters

core	LinphoneCore object
filename	The filename of the config file to read to fill the instantiated LinphoneConfig

Returns: a LinphoneConfig object.

◆ linphone_core_create_content()

LinphoneContent* linphone_core_create_content ( LinphoneCore * core )

Creates a content with default values from Linphone core.

Parameters

core	LinphoneCore object

Returns: LinphoneContent object with default values set

◆ linphone_core_create_info_message()

LinphoneInfoMessage* linphone_core_create_info_message ( LinphoneCore * core )

Creates an empty info message.

Parameters

core	the 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_call_send_info_message().

◆ linphone_core_create_local_player()

LinphonePlayer* linphone_core_create_local_player	(	LinphoneCore *	core,
		const char *	sound_card_name,
		const char *	video_display_name,
		void *	window_id
	)

Creates a media file player, that can be used to play audio and video to the user, outside of any call or conference.

See linphone_core_get_supported_file_formats_list() for supported multimedia file types.

Parameters

core	A LinphoneCore object
sound_card_name	Playback sound card. If NULL, the ringer sound card set in LinphoneCore will be used
video_display_name	Video display. If NULL, the video display set in LinphoneCore will be used
window_id	Id of the drawing window. See linphone_core_set_native_video_window_id() for a discussion about supported native video window types.

Returns: A pointer on the new instance. NULL if failed.

◆ linphone_core_create_lp_config()

MS2_DEPRECATED LinphoneConfig* linphone_core_create_lp_config	(	LinphoneCore *	core,
		const char *	filename
	)

Create a LpConfig object from a user config file.

Parameters

core	LinphoneCore object
filename	The filename of the config file to read to fill the instantiated LpConfig

Deprecated:: 12/01/2017 Use linphone_core_create_config() instead.

◆ linphone_core_create_magic_search()

LinphoneMagicSearch* linphone_core_create_magic_search ( LinphoneCore * core )

Creates a LinphoneMagicSearch object.

Parameters

core	LinphoneCore object

Returns: The created LinphoneMagicSearch object

◆ linphone_core_create_recorder()

LinphoneRecorder* linphone_core_create_recorder	(	LinphoneCore *	core,
		const LinphoneRecorderParams *	params
	)

Creates an independant media file recorder, that can be used to record user's voice or video outside of any call or conference.

See linphone_core_get_supported_file_formats_list() for supported multimedia file types.

Parameters

core	A LinphoneCore object.
params	The LinphoneRecorderParams that will contains all recorder parameters.

Returns: A pointer on the new instance. NULL if failed.

◆ linphone_core_create_recorder_params()

LinphoneRecorderParams* linphone_core_create_recorder_params ( const LinphoneCore * core )

Creates an object that holds recording parameters.

See also: linphone_core_create_recorder()

Parameters

core	A LinphoneCore object

Returns: A pointer on the newly created instance of LinphoneRecorderParams

◆ linphone_core_create_xml_rpc_session()

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

Create a LinphoneXmlRpcSession for a given url.

Parameters

core	The LinphoneCore used for the XML-RPC communication
url	The URL to the XML-RPC server. Must be NON NULL.

Returns: The new LinphoneXmlRpcSession object.

◆ linphone_core_enable_vibration_on_incoming_call()

void linphone_core_enable_vibration_on_incoming_call	(	LinphoneCore *	core,
		bool_t	enable
	)

Enable vibration will incoming call is ringing (Android only).

Parameters

core	The LinphoneCore
enable	TRUE to enable the vibration on incoming call, FALSE otherwise

◆ linphone_core_ensure_registered()

void linphone_core_ensure_registered ( LinphoneCore * core )

Call this method when you receive a push notification (if you handle push notifications manually).

It will ensure the proxy configs are correctly registered to the proxy server, so the call or the message will be correctly delivered.

Parameters

core	The LinphoneCore

Deprecated:: 09/03/2022 See linphone_core_process_push_notification() instead.

◆ linphone_core_enter_background()

void linphone_core_enter_background ( LinphoneCore * core )

This method is called by the application to notify the linphone core library when it enters background mode.

Parameters

core	the LinphoneCore

◆ linphone_core_enter_foreground()

void linphone_core_enter_foreground ( LinphoneCore * core )

This method is called by the application to notify the linphone core library when it enters foreground mode.

Parameters

core	the LinphoneCore

◆ linphone_core_get_auto_iterate_background_schedule()

int linphone_core_get_auto_iterate_background_schedule ( const LinphoneCore * core )

Gets the timer used to schedule the call to core.iterate() method when in background (Android only).

This is only used when linphone_core_auto_iterate_enabled() returns TRUE.

Parameters

core	The LinphoneCore

Returns: The timing in milliseconds used to schedule the call while in background (default is 500ms).

◆ linphone_core_get_auto_iterate_foreground_schedule()

int linphone_core_get_auto_iterate_foreground_schedule ( const LinphoneCore * core )

Gets the timer used to schedule the call to core.iterate() method when in foreground (Android only).

This is only used when linphone_core_auto_iterate_enabled() returns TRUE.

Parameters

core	The LinphoneCore

Returns: The timing in milliseconds used to schedule the call while in foreground (default is 20ms).

◆ linphone_core_get_config()

LinphoneConfig* linphone_core_get_config ( const LinphoneCore * core )

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

Parameters

core	LinphoneCore object The application can use the LinphoneConfig object to insert its own private sections and pairs of key=value in the configuration file.

Returns: a LinphoneConfig object.

◆ linphone_core_get_file_transfer_server()

const char* linphone_core_get_file_transfer_server ( LinphoneCore * core )

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

Url may be like: "https://file.linphone.org/upload.php".

Parameters

core	LinphoneCore from which to get the server_url

Returns: URL of the file server.

◆ linphone_core_get_global_state()

LinphoneGlobalState linphone_core_get_global_state ( const LinphoneCore * core )

Returns the global state of core.

Parameters

core	LinphoneCore object

Returns: a LinphoneGlobalState enum.

◆ linphone_core_get_lime_x3dh_server_url()

MS2_DEPRECATED const char* linphone_core_get_lime_x3dh_server_url ( LinphoneCore * core )

Get the x3dh server url.

Parameters

core	LinphoneCore object

Returns: The x3dh server url.

Deprecated:: 26/08/2022 Use linphone_account_params_get_lime_server_url() instead.

◆ linphone_core_get_loaded_plugins()

const bctbx_list_t* linphone_core_get_loaded_plugins ( LinphoneCore * core )

Return the list of loaded plugins.

Parameters

core	A LinphoneCore object

Returns: the list of loaded plugins

◆ linphone_core_interpret_url()

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

Constructs a LinphoneAddress from the given string if possible.

In case of just a username, characters will be unescaped. If a phone number is detected, it will be flattened. sip: or sips: prefix will be added if not present. Finally, @domain will be added if not present using default proxy config.

See also: linphone_proxy_config_normalize_sip_uri() for documentation.

Parameters

core	The core
url	the url to parse

Returns: the LinphoneAddress matching the url or NULL in case of failure.

Deprecated:: on 18/07/2022, use linphone_core_interpret_url_2() instead.

◆ linphone_core_interpret_url_2()

LinphoneAddress* linphone_core_interpret_url_2	(	LinphoneCore *	core,
		const char *	url,
		bool_t	apply_international_prefix
	)

Constructs a LinphoneAddress from the given string if possible.

In case of just a username, characters will be unescaped. If a phone number is detected, it will be flattened. sip: or sips: prefix will be added if not present. Finally, @domain will be added if not present using the default #Account.

See also: linphone_account_normalize_sip_uri() for a similar function.

Parameters

core	The core
url	the url to parse
apply_international_prefix	whether or not to try to format url as phone number using default account prefix if it set (and if url is a number).

Returns: the LinphoneAddress matching the url or NULL in case of failure.

◆ linphone_core_is_plugin_loaded()

bool_t linphone_core_is_plugin_loaded	(	const LinphoneCore *	core,
		const char *	name
	)

Tells whether a plugin is loaded or not.

Parameters

core	A LinphoneCore object
name	name of the plugin

Returns: A boolean value telling whether the plugin has been loaded

◆ linphone_core_is_vibration_on_incoming_call_enabled()

bool_t linphone_core_is_vibration_on_incoming_call_enabled ( LinphoneCore * core )

Gets whether the device will vibrate while an incoming call is ringing (Android only).

Parameters

core	The LinphoneCore

Returns: TRUE if the device will vibrate (if possible), FALSE otherwise

Deprecated:: 16/12/2021 Use linphone_core_vibration_on_incoming_call_enabled() instead.

◆ linphone_core_ldap_available()

bool_t linphone_core_ldap_available ( LinphoneCore * core )

End of group group_contacts.

Tells if LDAP is available

Parameters

core	LinphoneCore object

Returns: TRUE if LDAP is available, FALSE otherwise

◆ linphone_core_load_config_from_xml()

void linphone_core_load_config_from_xml	(	LinphoneCore *	core,
		const char *	xml_uri
	)

Update current config with the content of a xml config file.

Parameters

core	The LinphoneCore to update
xml_uri	the path to the xml file

◆ linphone_core_play_local()

LinphoneStatus linphone_core_play_local	(	LinphoneCore *	core,
		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

core	LinphoneCore object
audiofile	The path to an audio file in wav PCM 16 bit format

Returns: 0 on success, -1 on error

◆ linphone_core_process_push_notification()

void linphone_core_process_push_notification	(	LinphoneCore *	core,
		const char *	call_id
	)

Call this method when you receive a push notification (if you handle push notifications manually).

It will ensure the proxy configs are correctly registered to the proxy server, so the call or the message will be correctly delivered.

Parameters

core	The LinphoneCore
call_id	the Call-ID of the MESSAGE or INVITE for which the push was received and to wait for.

◆ linphone_core_push_notification_received()

void linphone_core_push_notification_received	(	LinphoneCore *	core,
		const char *	payload,
		const char *	call_id
	)

This method is called by Android & iOS platform helpers to notify the Core of a received push notification.

It will simply call Core->pushNotificationReceived() like linphone_core_process_push_notification().

Parameters

core	The LinphoneCore
payload	the payload of the push notification if any.
call_id	the Call-ID of the MESSAGE or INVITE for which the push was received and to wait for.

◆ linphone_core_push_notification_received_2()

void linphone_core_push_notification_received_2	(	LinphoneCore *	core,
		const char *	payload,
		const char *	call_id,
		bool_t	is_core_starting
	)

This method is called by Android & iOS platform helpers to notify the Core of a received push notification.

It will simply call Core->pushNotificationReceived() like linphone_core_process_push_notification().

Parameters

core	The LinphoneCore
payload	the payload of the push notification if any.
call_id	the Call-ID of the MESSAGE or INVITE for which the push was received and to wait for.
is_core_starting	if TRUE the Core will skill network tasks we usually do when a push is received to ensure the sockets are alive.

◆ linphone_core_set_auto_iterate_background_schedule()

void linphone_core_set_auto_iterate_background_schedule	(	LinphoneCore *	core,
		int	schedule
	)

Sets the timer used to schedule the call to core.iterate() method when in background (Android only).

Parameters

core	The LinphoneCore
schedule	The timing in milliseconds used to schedule the call while in background.

◆ linphone_core_set_auto_iterate_foreground_schedule()

void linphone_core_set_auto_iterate_foreground_schedule	(	LinphoneCore *	core,
		int	schedule
	)

Sets the timer used to schedule the call to core.iterate() method when in foreground (Android only).

Parameters

core	The LinphoneCore
schedule	The timing in milliseconds used to schedule the call while in foreground.

◆ linphone_core_set_file_transfer_server()

void linphone_core_set_file_transfer_server	(	LinphoneCore *	core,
		const char *	server_url
	)

Globaly sets an http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml.

Url may be like: "https://file.linphone.org/upload.php". This value can also be set for a dedicated account using linphone_account_params_set_file_transfer_server().

Parameters

core	LinphoneCore to be modified
server_url	URL of the file server.

◆ linphone_core_set_lime_x3dh_server_url()

MS2_DEPRECATED void linphone_core_set_lime_x3dh_server_url	(	LinphoneCore *	core,
		const char *	url
	)

Set the x3dh server url.

If empty, this function will disable LIME X3DH from core. Otherwise, or if different from the existing value, this will (re-)initialize the LIME X3DH engine.

Parameters

core	LinphoneCore object
url	The x3dh server url.

Deprecated:: 26/08/2022 Use linphone_account_params_set_lime_server_url() instead.

◆ linphone_core_set_user_agent()

void linphone_core_set_user_agent	(	LinphoneCore *	core,
		const char *	name,
		const char *	version
	)

Set the user agent string used in SIP messages.

Set the user agent string used in SIP messages as "[ua_name]/[version]". No slash character will be printed if NULL is given to "version". If NULL is given to "ua_name" and "version" both, the User-agent header will be empty.

This function should be called just after linphone_factory_create_core() ideally.

Parameters

core	The core.
name	Name of the user agent.
version	Version of the user agent.

◆ linphone_core_set_vibration_on_incoming_call_enabled()

void linphone_core_set_vibration_on_incoming_call_enabled	(	LinphoneCore *	core,
		bool_t	enable
	)

Enable vibration will incoming call is ringing (Android only).

Parameters

core	The LinphoneCore
enable	TRUE to enable the vibration on incoming call, FALSE otherwise

Deprecated:: 16/12/2021 Use linphone_core_enable_vibration_on_incoming_call() instead.

◆ linphone_core_take_preview_snapshot()

LinphoneStatus linphone_core_take_preview_snapshot	(	LinphoneCore *	core,
		const char *	file
	)

Takes 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

core	the LinphoneCore.
file	a path where to write the jpeg content.

Returns: 0 if successful, -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_core_vibration_on_incoming_call_enabled()

bool_t linphone_core_vibration_on_incoming_call_enabled ( LinphoneCore * core )

Gets whether the device will vibrate while an incoming call is ringing (Android only).

Parameters

core	The LinphoneCore

Returns: TRUE if the device will vibrate (if possible), FALSE otherwise

◆ linphone_core_video_supported()

bool_t linphone_core_video_supported ( LinphoneCore * core )

Test if video is supported.

Parameters

core	the LinphoneCore

Returns: TRUE if the library was built with video support, FALSE otherwise

◆ linphone_dial_plan_by_ccc()

const LinphoneDialPlan* linphone_dial_plan_by_ccc ( const char * ccc )

Find best match for given CCC.

Parameters

ccc	The country calling code

Returns: the matching dial plan, or a generic one if none found

◆ linphone_dial_plan_by_ccc_as_int()

const LinphoneDialPlan* linphone_dial_plan_by_ccc_as_int ( int ccc )

Find best match for given CCC.

Parameters

ccc	the country calling code

Returns: the matching dial plan, or a generic one if none found

◆ linphone_dial_plan_format_phone_number()

char* linphone_dial_plan_format_phone_number	(	const LinphoneDialPlan *	dp,
		const char *	phone_number,
		bool_t	escape_plus
	)

Formats a phone number using dial plan informations.

Parameters

dp	the LinphoneDialPlan to use.
phone_number	the phone number to format.
escape_plus	whether or not to use + or international calling prefix

Returns: the formatted phone number, or the original phone number if couldn't be formatted for some reason.

◆ linphone_dial_plan_get_all()

MS2_DEPRECATED const LinphoneDialPlan* linphone_dial_plan_get_all ( void )

Return NULL-terminated array of all known dial plans.

Deprecated:: 16/10/2017 use linphone_dial_plan_get_all_list instead, this method will always return NULL

◆ linphone_dial_plan_get_all_list()

bctbx_list_t* linphone_dial_plan_get_all_list ( void )

Returns a list of all known dial plans.

Returns: The list of all known dial plans.

◆ linphone_dial_plan_get_country()

const char* linphone_dial_plan_get_country ( const LinphoneDialPlan * dial_plan )

Returns the country name of the dialplan.

Parameters

dial_plan the LinphoneDialPlan object

Returns: the country name

◆ linphone_dial_plan_get_country_calling_code()

const char* linphone_dial_plan_get_country_calling_code ( const LinphoneDialPlan * dial_plan )

Returns the country calling code of the dialplan.

Parameters

dial_plan the LinphoneDialPlan object

Returns: the country calling code

◆ linphone_dial_plan_get_flag()

const char* linphone_dial_plan_get_flag ( const LinphoneDialPlan * dial_plan )

Returns the flag of the teritory as unicode characters.

Parameters

dial_plan the LinphoneDialPlan object

Returns: the flag as unicode characters

◆ linphone_dial_plan_get_international_call_prefix()

const char* linphone_dial_plan_get_international_call_prefix ( const LinphoneDialPlan * dial_plan )

Returns the international call prefix of the dialplan.

Parameters

dial_plan the LinphoneDialPlan object

Returns: the international call prefix

◆ linphone_dial_plan_get_iso_country_code()

const char* linphone_dial_plan_get_iso_country_code ( const LinphoneDialPlan * dial_plan )

Returns the iso country code of the dialplan.

Parameters

dial_plan the LinphoneDialPlan object

Returns: the iso country code

◆ linphone_dial_plan_get_national_number_length()

int linphone_dial_plan_get_national_number_length ( const LinphoneDialPlan * dial_plan )

Returns the national number length of the dialplan.

Parameters

dial_plan the LinphoneDialPlan object

Returns: the national number length

◆ linphone_dial_plan_is_generic()

bool_t linphone_dial_plan_is_generic ( const LinphoneDialPlan * ccc )

Return if given plan is generic.

Parameters

ccc	the country calling code

Returns: TRUE if generic, 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

e164	phone 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

iso	country code alpha2

Returns: call country code or -1 if not found

◆ linphone_dial_plan_ref()

LinphoneDialPlan* linphone_dial_plan_ref ( LinphoneDialPlan * dial_plan )

Increases the reference counter of LinphoneDialPlan objects.

Parameters

dial_plan the LinphoneDialPlan object

Returns: the same LinphoneDialPlan object

◆ linphone_dial_plan_unref()

void linphone_dial_plan_unref ( LinphoneDialPlan * dial_plan )

Decreases the reference counter of LinphoneDialPlan objects.

Parameters

dial_plan the LinphoneDialPlan object

◆ linphone_error_code_is_retry_after()

bool_t linphone_error_code_is_retry_after ( int error )

Check whether an error code is in Retry-After field.

Parameters

error An error code

Returns: TRUE if it is in Retry-After field

◆ linphone_error_code_to_reason()

LinphoneReason linphone_error_code_to_reason ( int error )

Converts an error code to a LinphoneReason.

Parameters

error An error code

Returns: The LinphoneReason corresponding to the specified error code

◆ linphone_factory_get_cache_dir()

const char* linphone_factory_get_cache_dir	(	LinphoneFactory *	factory,
		void *	context
	)

Get the cache path.

Parameters

factory	the LinphoneFactory
context	used to compute path. Can be NULL. JavaPlatformHelper on Android and char *appGroupId on iOS with shared core.

Returns: The cache path

◆ linphone_factory_get_config_dir()

const char* linphone_factory_get_config_dir	(	LinphoneFactory *	factory,
		void *	context
	)

Get the config path.

Parameters

factory	the LinphoneFactory
context	used to compute path. Can be NULL. JavaPlatformHelper on Android and char *appGroupId on iOS with shared core.

Returns: The config path

◆ linphone_factory_get_data_dir()

const char* linphone_factory_get_data_dir	(	LinphoneFactory *	factory,
		void *	context
	)

Get the data path.

Parameters

factory	the LinphoneFactory
context	used to compute path. Can be NULL. JavaPlatformHelper on Android and char *appGroupId on iOS with shared core.

Returns: The data path

◆ linphone_factory_get_download_dir()

const char* linphone_factory_get_download_dir	(	LinphoneFactory *	factory,
		void *	context
	)

Get the download path.

Parameters

factory	the LinphoneFactory
context	used to compute path. Can be NULL. JavaPlatformHelper on Android and char *appGroupId on iOS with shared core.

Returns: The download path

◆ linphone_factory_is_cache_dir_set()

bool_t linphone_factory_is_cache_dir_set ( const LinphoneFactory * factory )

Test if cache dir has been set.

Parameters

factory the LinphoneFactory

Returns: TRUE if cache dir has been set.

◆ linphone_factory_is_config_dir_set()

bool_t linphone_factory_is_config_dir_set ( const LinphoneFactory * factory )

Test if config dir has been set.

Parameters

factory the LinphoneFactory

Returns: TRUE if config dir has been set.

◆ linphone_factory_is_data_dir_set()

bool_t linphone_factory_is_data_dir_set ( const LinphoneFactory * factory )

Test if data dir has been set.

Parameters

factory the LinphoneFactory

Returns: TRUE if data dir has been set.

◆ linphone_factory_is_download_dir_set()

bool_t linphone_factory_is_download_dir_set ( const LinphoneFactory * factory )

Test if download dir has been set.

Parameters

factory the LinphoneFactory

Returns: TRUE if download dir has been set.

◆ 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

cbs	the 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 whether or not to encrypt the files.

Parameters

cbs	the 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

cbs	the 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

cbs	the 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

cbs	the 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

cbs	the 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

cbs	the 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

cbs	LinphoneImEncryptionEngineCbs 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

cbs	the LinphoneImEncryptionEngineCbs object
cb	the 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 whether or not to encrypt the files.

Parameters

cbs	the LinphoneImEncryptionEngineCbs object
cb	the 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

cbs	the LinphoneImEncryptionEngineCbs object
cb	the 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

cbs	the LinphoneImEncryptionEngineCbs object
cb	the 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

cbs	the LinphoneImEncryptionEngineCbs object
cb	the 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

cbs	the LinphoneImEncryptionEngineCbs object
cb	the 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

cbs	the LinphoneImEncryptionEngineCbs object
data	the user data

◆ linphone_im_encryption_engine_cbs_unref()

void linphone_im_encryption_engine_cbs_unref ( LinphoneImEncryptionEngineCbs * cbs )

Release reference to the LinphoneImEncryptionEngineCbs.

Parameters

cbs	LinphoneImEncryptionEngineCbs 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

imee	the 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

imee	LinphoneImEncryptionEngine 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

imee	the LinphoneImEncryptionEngine

Returns: the user data

◆ linphone_im_encryption_engine_new()

LinphoneImEncryptionEngine* linphone_im_encryption_engine_new ( void )

Create the IM encryption engine.

Returns: The created the IM encryption engine

◆ linphone_im_encryption_engine_ref()

LinphoneImEncryptionEngine* linphone_im_encryption_engine_ref ( LinphoneImEncryptionEngine * imee )

Acquire a reference to the LinphoneImEncryptionEngine.

Parameters

imee	LinphoneImEncryptionEngine 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

imee	the LinphoneImEncryptionEngine object
data	the user data

◆ linphone_im_encryption_engine_unref()

void linphone_im_encryption_engine_unref ( LinphoneImEncryptionEngine * imee )

Release reference to the LinphoneImEncryptionEngine.

Parameters

imee	LinphoneImEncryptionEngine object.

◆ linphone_magic_search_add_callbacks()

void linphone_magic_search_add_callbacks	(	LinphoneMagicSearch *	magic_search,
		LinphoneMagicSearchCbs *	cbs
	)

Add a listener in order to be notified of LinphoneMagicSearch events.

Parameters

magic_search	LinphoneMagicSearch object to monitor.
cbs	A LinphoneMagicSearchCbs object holding the callbacks you need.

◆ linphone_magic_search_cbs_get_ldap_have_more_results()

LinphoneMagicSearchCbsLdapHaveMoreResultsCb linphone_magic_search_cbs_get_ldap_have_more_results ( const LinphoneMagicSearchCbs * cbs )

Get the ldap callback on having more results.

Parameters

cbs	LinphoneMagicSearchCbs object.

Returns: The ldap callback on having more results.

Deprecated:: 18/11/2024 use linphone_magic_search_cbs_get_more_results_available() instead.

◆ linphone_magic_search_cbs_get_more_results_available()

LinphoneMagicSearchCbsMoreResultsAvailableCb linphone_magic_search_cbs_get_more_results_available ( const LinphoneMagicSearchCbs * cbs )

Gets the callback notifying more results for a source flag are available.

Parameters

cbs	LinphoneMagicSearchCbs object.

Returns: The more results available callback.

◆ linphone_magic_search_cbs_get_search_results_received()

LinphoneMagicSearchCbsSearchResultsReceivedCb linphone_magic_search_cbs_get_search_results_received ( const LinphoneMagicSearchCbs * cbs )

Get the received results callback.

Parameters

cbs	LinphoneMagicSearchCbs object.

Returns: The current result received callback.

◆ linphone_magic_search_cbs_get_user_data()

void* linphone_magic_search_cbs_get_user_data ( const LinphoneMagicSearchCbs * cbs )

Retrieve the user pointer associated with the chat message callbacks object.

Parameters

cbs	The LinphoneMagicSearchCbs object

Returns: The user pointer associated with the chat message callbacks object.

◆ linphone_magic_search_cbs_ref()

LinphoneMagicSearchCbs* linphone_magic_search_cbs_ref ( LinphoneMagicSearchCbs * cbs )

Acquire a reference to the chat message callbacks object.

Parameters

cbs	The LinphoneMagicSearchCbs object

Returns: The same chat message callbacks object

◆ linphone_magic_search_cbs_set_ldap_have_more_results()

void linphone_magic_search_cbs_set_ldap_have_more_results	(	LinphoneMagicSearchCbs *	cbs,
		LinphoneMagicSearchCbsLdapHaveMoreResultsCb	cb
	)

Set the ldap callback on having more results.

Parameters

cbs	LinphoneMagicSearchCbs object.
cb	The ldap callback on having more results.

Deprecated:: 18/11/2024 use linphone_magic_search_cbs_set_more_results_available() instead.

◆ linphone_magic_search_cbs_set_more_results_available()

void linphone_magic_search_cbs_set_more_results_available	(	LinphoneMagicSearchCbs *	cbs,
		LinphoneMagicSearchCbsMoreResultsAvailableCb	cb
	)

Sets the callback notifying that more results for a source flag are available.

Parameters

cbs	LinphoneMagicSearchCbs object.

Returns: The more results available callback.

◆ linphone_magic_search_cbs_set_search_results_received()

void linphone_magic_search_cbs_set_search_results_received	(	LinphoneMagicSearchCbs *	cbs,
		LinphoneMagicSearchCbsSearchResultsReceivedCb	cb
	)

Set the received results callback.

Parameters

cbs	LinphoneMagicSearchCbs object.
cb	The received results callback to be used.

◆ linphone_magic_search_cbs_set_user_data()

void linphone_magic_search_cbs_set_user_data	(	LinphoneMagicSearchCbs *	cbs,
		void *	user_data
	)

Assign a user pointer to the chat message callbacks object.

Parameters

cbs	The LinphoneMagicSearchCbs object
user_data	The user pointer to associate with the chat message callbacks object.

◆ linphone_magic_search_cbs_unref()

void linphone_magic_search_cbs_unref ( LinphoneMagicSearchCbs * cbs )

Release reference to the chat message callbacks object.

Parameters

cbs	The LinphoneMagicSearchCbs object

◆ linphone_magic_search_get_contacts_list()

bctbx_list_t* linphone_magic_search_get_contacts_list	(	LinphoneMagicSearch *	magic_search,
		const char *	filter,
		const char *	domain,
		int	sourceFlags,
		LinphoneMagicSearchAggregation	aggregation
	)

Create a sorted list of SearchResult which match with a filter word, from SipUri in this order : Contact's display name, address username, address domain and phone number.

The last item list will be an address formed with "filter" if a proxy config exist and requested in sourceFlags During the first search, a cache is created and used for the next search Use linphone_magic_search_reset_search_cache() to begin a new search

Parameters

magic_search	a LinphoneMagicSearch object
filter	word we search
domain	domain which we want to search only NULL or "" for searching in all contact "*" for searching in contact with sip SipUri "yourdomain" for searching in contact from "yourdomain" domain
sourceFlags	Flags that specify where to search : LinphoneMagicSearchSource
aggregation	a LinphoneMagicSearchAggregation mode to indicate how to merge results

Returns: sorted list of

◆ linphone_magic_search_get_contacts_list_async()

void linphone_magic_search_get_contacts_list_async	(	LinphoneMagicSearch *	magic_search,
		const char *	filter,
		const char *	domain,
		int	sourceFlags,
		LinphoneMagicSearchAggregation	aggregation
	)

This is the asynchronous version of linphone_magic_search_get_contacts().

Create a sorted list of SearchResult which match with a filter word, from SipUri in this order : Contact's display name, address username, address domain and phone number. The last item list will be an address formed with "filter" if a proxy config exist and requested in sourceFlags During the first search, a cache is created and used for the next search Use linphone_magic_search_reset_search_cache() to begin a new search

Parameters

magic_search	a LinphoneMagicSearch object
filter	word we search
domain	domain which we want to search only NULL or "" for searching in all contact "*" for searching in contact with sip SipUri "yourdomain" for searching in contact from "yourdomain" domain
sourceFlags	Flags that specify where to search : LinphoneMagicSearchSource
aggregation	a LinphoneMagicSearchAggregation mode to indicate how to merge results

◆ linphone_magic_search_get_current_callbacks()

LinphoneMagicSearchCbs* linphone_magic_search_get_current_callbacks ( const LinphoneMagicSearch * magic_search )

Gets the current LinphoneMagicSearchCbs.

This is meant only to be called from a callback to be able to get the user_data associated with the LinphoneMagicSearchCbs that is calling the callback.

Parameters

magic_search LinphoneMagicSearch object

Returns: The LinphoneMagicSearchCbs that has called the last callback.

◆ linphone_magic_search_get_delimiter()

const char* linphone_magic_search_get_delimiter ( const LinphoneMagicSearch * magic_search )

Get the delimiter used for the search.

Parameters

magic_search a LinphoneMagicSearch object

Returns: the delimiter used to find matched filter word

◆ linphone_magic_search_get_last_search()

bctbx_list_t* linphone_magic_search_get_last_search ( const LinphoneMagicSearch * magic_search )

Parameters

magic_search a LinphoneMagicSearch object

Returns: sorted list of

◆ linphone_magic_search_get_limited_search()

bool_t linphone_magic_search_get_limited_search ( const LinphoneMagicSearch * magic_search )

Returns whether or not the search is limited or not.

If not limited, the linphone_magic_search_get_search_limit() won't be applied.

Parameters

magic_search a LinphoneMagicSearch object

Returns: TRUE if the search is limited, FALSE otherwise

◆ linphone_magic_search_get_max_weight()

unsigned int linphone_magic_search_get_max_weight ( const LinphoneMagicSearch * magic_search )

Get the maximum value used to calculate the weight in search.

Parameters

magic_search a LinphoneMagicSearch object

Returns: the maximum value used to calculate the weight in search

◆ linphone_magic_search_get_min_weight()

unsigned int linphone_magic_search_get_min_weight ( const LinphoneMagicSearch * magic_search )

Get the minimum value used to calculate the weight in search.

Parameters

magic_search a LinphoneMagicSearch object

Returns: the minimum value used to calculate the weight in search

◆ linphone_magic_search_get_search_limit()

unsigned int linphone_magic_search_get_search_limit ( const LinphoneMagicSearch * magic_search )

Gets the number of maximum search result the search will return.

The returned value doesn't take into account the "limited search" mode, so make sure to check linphone_magic_search_get_limited_search() result as well.

Parameters

magic_search a LinphoneMagicSearch object

Returns: the number of the maximum LinphoneSearchResult which will be returned if magic search is in limited mode.

◆ linphone_magic_search_get_use_delimiter()

bool_t linphone_magic_search_get_use_delimiter ( LinphoneMagicSearch * magic_search )

Returns whether the delimiter is being used for the search.

Parameters

magic_search a LinphoneMagicSearch object

Returns: if the delimiter search is used

◆ linphone_magic_search_new()

LinphoneMagicSearch* linphone_magic_search_new ( LinphoneCore * core )

Constructs a LinphoneMagicSearch object.

Parameters

core	a LinphoneCore object

Returns: a LinphoneMagicSearch object

◆ linphone_magic_search_ref()

LinphoneMagicSearch* linphone_magic_search_ref ( LinphoneMagicSearch * magic_search )

Increment reference count of LinphoneMagicSearch object.

Parameters

magic_search a LinphoneMagicSearch object

Returns: the same LinphoneMagicSearch object

◆ linphone_magic_search_remove_callbacks()

void linphone_magic_search_remove_callbacks	(	LinphoneMagicSearch *	magic_search,
		LinphoneMagicSearchCbs *	cbs
	)

Remove a listener from a LinphoneMagicSearch.

Parameters

magic_search	LinphoneMagicSearch object
cbs	LinphoneMagicSearchCbs object to remove.

◆ linphone_magic_search_reset_search_cache()

void linphone_magic_search_reset_search_cache ( LinphoneMagicSearch * magic_search )

Reset the cache to begin a new search.

Parameters

magic_search a LinphoneMagicSearch object

◆ linphone_magic_search_set_delimiter()

void linphone_magic_search_set_delimiter	(	LinphoneMagicSearch *	magic_search,
		const char *	delimiter
	)

Set the delimiter used to find matched filter word.

Parameters

magic_search	a LinphoneMagicSearch object
delimiter	delimiter (example "-_.,")

◆ linphone_magic_search_set_limited_search()

void linphone_magic_search_set_limited_search	(	LinphoneMagicSearch *	magic_search,
		bool_t	limited
	)

Enables or disables the limited search.

Even if configured as unlimited, the LDAP maxResults configuration parameter still applies.

Parameters

magic_search	a LinphoneMagicSearch object
limited	TRUE to limit the search, FALSE otherwise

◆ linphone_magic_search_set_max_weight()

void linphone_magic_search_set_max_weight	(	LinphoneMagicSearch *	magic_search,
		unsigned int	weight
	)

Set the maximum value used to calculate the weight in search.

Parameters

magic_search	a LinphoneMagicSearch object
weight	maximum weight

◆ linphone_magic_search_set_min_weight()

void linphone_magic_search_set_min_weight	(	LinphoneMagicSearch *	magic_search,
		unsigned int	weight
	)

Set the minimum value used to calculate the weight in search.

Parameters

magic_search	a LinphoneMagicSearch object
weight	minimum weight

◆ linphone_magic_search_set_search_limit()

void linphone_magic_search_set_search_limit	(	LinphoneMagicSearch *	magic_search,
		unsigned int	limit
	)

Sets the number of the maximum SearchResult which will be returned, if the magic search isn't configured as unlimited with linphone_magic_search_set_limited_search().

Parameters

magic_search	a LinphoneMagicSearch object
limit	the maximum number of LinphoneSearchResult the search will return if magic search is in limited mode.

◆ linphone_magic_search_set_use_delimiter()

void linphone_magic_search_set_use_delimiter	(	LinphoneMagicSearch *	magic_search,
		bool_t	enable
	)

Enable or disable the delimiter in search.

Parameters

magic_search	a LinphoneMagicSearch object
enable	TRUE to use the delimiter, FALSE otherwise

◆ linphone_magic_search_unref()

void linphone_magic_search_unref ( LinphoneMagicSearch * magic_search )

Decrement reference count of LinphoneMagicSearch object.

When dropped to zero, memory is freed.

Parameters

magic_search a LinphoneMagicSearch object

◆ linphone_participant_device_add_callbacks()

void linphone_participant_device_add_callbacks	(	LinphoneParticipantDevice *	participant_device,
		LinphoneParticipantDeviceCbs *	cbs
	)

Add a listener in order to be notified of LinphoneParticipantDevice events.

Once an event is received, registred LinphoneParticipantDeviceCbs are invoked sequencially.

Parameters

participant_device	LinphoneParticipantDevice object.
cbs	A LinphoneParticipantDeviceCbs object holding the callbacks you need. A reference is taken by the LinphoneParticipantDevice until you invoke linphone_participant_device_remove_callbacks().

◆ linphone_participant_device_create_native_video_window_id()

void* linphone_participant_device_create_native_video_window_id ( LinphoneParticipantDevice * participant_device )

Creates a window ID and return it.

See also: linphone_core_set_native_video_window_id() for a general discussion about window IDs.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: the native video window id (type may vary depending on platform).

◆ linphone_participant_device_create_native_video_window_id_2()

void* linphone_participant_device_create_native_video_window_id_2	(	LinphoneParticipantDevice *	participant_device,
		void *	context
	)

Creates a window ID and return it.

See also: linphone_core_set_native_video_window_id() for a general discussion about window IDs.

A context can be used to prevent Linphone from allocating the container (#MSOglContextInfo for MSOGL). NULL if not used.

Parameters

participant_device	A LinphoneParticipantDevice object
context	preallocated Window ID (Used only for MSOGL)

Returns: the native video window id (type may vary depending on platform).

◆ linphone_participant_device_get_address()

const LinphoneAddress* linphone_participant_device_get_address ( const LinphoneParticipantDevice * participant_device )

Gets the address of a participant's device.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: The LinphoneAddress of the participant's device

◆ linphone_participant_device_get_current_callbacks()

LinphoneParticipantDeviceCbs* linphone_participant_device_get_current_callbacks ( const LinphoneParticipantDevice * participant_device )

Gets the current LinphoneParticipantDeviceCbs.

Parameters

participant_device LinphoneParticipantDevice object.

Returns: The LinphoneParticipantDeviceCbs that has called the last callback.

◆ linphone_participant_device_get_disconnection_method()

LinphoneParticipantDeviceDisconnectionMethod linphone_participant_device_get_disconnection_method ( const LinphoneParticipantDevice * participant_device )

Gets the disconnection method.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: disconnection method LinphoneParticipantDeviceDisconnectionMethod

◆ linphone_participant_device_get_disconnection_reason()

const char* linphone_participant_device_get_disconnection_reason ( const LinphoneParticipantDevice * participant_device )

Gets the disconnection reason.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: disconnection reason

◆ linphone_participant_device_get_is_muted()

bool_t linphone_participant_device_get_is_muted ( const LinphoneParticipantDevice * participant_device )

Returns whether the participant device is muted or not.

Parameters

participant_device The LinphoneParticipantDevice object

Returns: TRUE if the participant device is muted, FALSE otherwise.

◆ linphone_participant_device_get_is_speaking()

bool_t linphone_participant_device_get_is_speaking ( const LinphoneParticipantDevice * participant_device )

Returns whether the participant device is speaking or not.

Parameters

participant_device The LinphoneParticipantDevice object

Returns: TRUE if the participant device is speaking, FALSE otherwise.

◆ linphone_participant_device_get_joining_method()

LinphoneParticipantDeviceJoiningMethod linphone_participant_device_get_joining_method ( const LinphoneParticipantDevice * participant_device )

Gets the joining method or it the device is the focus owner.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: joining method or focus owner LinphoneParticipantDeviceJoiningMethod

◆ linphone_participant_device_get_name()

const char* linphone_participant_device_get_name ( const LinphoneParticipantDevice * participant_device )

Returns the name of the device.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: the name of the device or NULL.

◆ linphone_participant_device_get_native_video_window_id()

void* linphone_participant_device_get_native_video_window_id ( const LinphoneParticipantDevice * participant_device )

Gets the native window ID where video for this participant device is to be rendered.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: the window ID of the device

◆ linphone_participant_device_get_participant()

LinphoneParticipant* linphone_participant_device_get_participant ( const LinphoneParticipantDevice * participant_device )

Returns the LinphoneParticipant this LinphoneParticipantDevice belongs to.

Parameters

participant_device The LinphoneParticipantDevice object

Returns: the LinphoneParticipant this device belongs to

◆ linphone_participant_device_get_security_level()

LinphoneChatRoomSecurityLevel linphone_participant_device_get_security_level ( const LinphoneParticipantDevice * participant_device )

Gets the security level of a participant's device.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: The LinphoneChatRoomSecurityLevel of the device

◆ linphone_participant_device_get_ssrc()

uint32_t linphone_participant_device_get_ssrc	(	const LinphoneParticipantDevice *	participant_device,
		const LinphoneStreamType	stream_type
	)

Get the audio stream SSRC of the device.

Parameters

participant_device	A LinphoneParticipantDevice object
stream_type	A LinphoneStreamType

Returns: the stream's SSRC of the device

◆ linphone_participant_device_get_state()

LinphoneParticipantDeviceState linphone_participant_device_get_state ( const LinphoneParticipantDevice * participant_device )

Gets the state of a participant device.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: The LinphoneParticipantDeviceState of the device

◆ linphone_participant_device_get_stream_availability()

bool_t linphone_participant_device_get_stream_availability	(	const LinphoneParticipantDevice *	participant_device,
		const LinphoneStreamType	stream_type
	)

Gets the stream availability of the device.

The availability information represents whether a given stream type is currently available to be presented in the conference for a LinphoneParticipantDevice

Parameters

participant_device	A LinphoneParticipantDevice object
stream_type	A LinphoneStreamType

Returns: TRUE if the stream of type stream_type is available for device, FALSE otherwise

◆ linphone_participant_device_get_stream_capability()

LinphoneMediaDirection linphone_participant_device_get_stream_capability	(	const LinphoneParticipantDevice *	participant_device,
		const LinphoneStreamType	stream_type
	)

Gets the stream capability of the device.

The capability information represents the capability for the #ParticipantDevice to handle a given stream type (audio, video or text).

Parameters

participant_device	A LinphoneParticipantDevice object
stream_type	A LinphoneStreamType

Returns: the capability of stream of type stream_type of the device LinphoneMediaDirection

◆ linphone_participant_device_get_stream_label()

const char* linphone_participant_device_get_stream_label	(	const LinphoneParticipantDevice *	participant_device,
		const LinphoneStreamType	stream_type
	)

Gets the stream label of the device.

The capability information represents the capability for the #ParticipantDevice to handle a given stream type (audio, video or text).

Parameters

participant_device	A LinphoneParticipantDevice object
stream_type	A LinphoneStreamType

Returns: the label of stream of type stream_type of the device

◆ linphone_participant_device_get_thumbnail_ssrc()

uint32_t linphone_participant_device_get_thumbnail_ssrc ( const LinphoneParticipantDevice * participant_device )

Get the thumbnail stream SSRC of the device.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: the thumbnail stream's SSRC of the device

◆ linphone_participant_device_get_thumbnail_stream_availability()

bool_t linphone_participant_device_get_thumbnail_stream_availability ( const LinphoneParticipantDevice * participant_device )

Gets the thumbnail stream availability of the device.

The availability information represents whether a given stream type is currently available to be presented in the conference for a LinphoneParticipantDevice

Parameters

participant_device A LinphoneParticipantDevice object

Returns: TRUE if the stream of type stream_type is available for device, FALSE otherwise

◆ linphone_participant_device_get_thumbnail_stream_capability()

LinphoneMediaDirection linphone_participant_device_get_thumbnail_stream_capability ( const LinphoneParticipantDevice * participant_device )

Gets the thumbnail stream capability of the device.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: the capability of the thumbnail stream of the device LinphoneMediaDirection

◆ linphone_participant_device_get_thumbnail_stream_label()

const char* linphone_participant_device_get_thumbnail_stream_label ( const LinphoneParticipantDevice * participant_device )

Gets the thumbnail stream label of the device.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: the label of the thumbnail stream of the device

◆ linphone_participant_device_get_time_of_disconnection()

time_t linphone_participant_device_get_time_of_disconnection ( const LinphoneParticipantDevice * participant_device )

Gets the timestamp the device left a conference.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: time of disconnection a conference as returned by time(nullptr). For UNIX based systems it is the number of seconds since 00:00:00 of the 1st of January 1970

◆ linphone_participant_device_get_time_of_joining()

time_t linphone_participant_device_get_time_of_joining ( const LinphoneParticipantDevice * participant_device )

Gets the timestamp the device joined a conference.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: time of joining a conference expressed as a number of seconds since 00:00:00 of the 1st of January 1970

◆ linphone_participant_device_get_user_data()

void* linphone_participant_device_get_user_data ( const LinphoneParticipantDevice * participant_device )

Retrieves the user pointer associated with the participant's device.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: The user pointer associated with the participant's device.

◆ linphone_participant_device_identity_get_address()

const LinphoneAddress* linphone_participant_device_identity_get_address ( const LinphoneParticipantDeviceIdentity * device_identity )

Get the address of the participant device.

Parameters

device_identity the LinphoneParticipantDeviceIdentity

Returns: the address.

◆ linphone_participant_device_identity_get_capability_descriptor()

MS2_DEPRECATED const char* linphone_participant_device_identity_get_capability_descriptor ( const LinphoneParticipantDeviceIdentity * device_identity )

Get the capability descriptor (currently +org.linphone.specs value) for this participant device identity.

Parameters

device_identity the LinphoneParticipantDeviceIdentity object

Returns: the capability descriptor string.

Deprecated:: 12/06/2023 Use linphone_participant_device_identity_get_capability_descriptor_list() instead

◆ linphone_participant_device_identity_get_capability_descriptor_list()

const bctbx_list_t* linphone_participant_device_identity_get_capability_descriptor_list ( const LinphoneParticipantDeviceIdentity * device_identity )

Get the capability descriptor (currently +org.linphone.specs value) for this participant device identity.

Parameters

device_identity the LinphoneParticipantDeviceIdentity object

Returns: the capability descriptor list.

◆ linphone_participant_device_identity_new()

LinphoneParticipantDeviceIdentity* linphone_participant_device_identity_new	(	const LinphoneAddress *	address,
		const char *	name
	)

Constructs a LinphoneParticipantDeviceIdentity object.

Parameters

address	a LinphoneAddress of the participant device
name	the name of the participant device

Returns: a new LinphoneParticipantDeviceIdentity

◆ linphone_participant_device_identity_ref()

LinphoneParticipantDeviceIdentity* linphone_participant_device_identity_ref ( LinphoneParticipantDeviceIdentity * device_identity )

Increment reference count of LinphoneParticipantDeviceIdentity object.

Parameters

device_identity the LinphoneParticipantDeviceIdentity object

Returns: the same LinphoneParticipantDeviceIdentity object

◆ linphone_participant_device_identity_set_capability_descriptor()

MS2_DEPRECATED void linphone_participant_device_identity_set_capability_descriptor	(	LinphoneParticipantDeviceIdentity *	device_identity,
		const char *	capability_descriptor
	)

Set the capability descriptor (currently +org.linphone.specs value) for this participant device identity.

Parameters

device_identity	the LinphoneParticipantDeviceIdentity object
capability_descriptor	the capability descriptor string.

Deprecated:: 12/06/2023 Use linphone_participant_device_identity_set_capability_descriptor_2() instead

◆ linphone_participant_device_identity_set_capability_descriptor_2()

void linphone_participant_device_identity_set_capability_descriptor_2	(	LinphoneParticipantDeviceIdentity *	device_identity,
		const bctbx_list_t *	capability_descriptor_list
	)

Set the capability descriptor (currently +org.linphone.specs value) for this participant device identity.

Parameters

device_identity	the LinphoneParticipantDeviceIdentity object
capability_descriptor_list	the capability descriptor list.

◆ linphone_participant_device_identity_unref()

void linphone_participant_device_identity_unref ( LinphoneParticipantDeviceIdentity * device_identity )

Decrement reference count of LinphoneParticipantDeviceIdentity object.

When dropped to zero, memory is freed.

Parameters

device_identity the LinphoneParticipantDeviceIdentity object

◆ linphone_participant_device_is_in_conference()

bool_t linphone_participant_device_is_in_conference ( const LinphoneParticipantDevice * participant_device )

Returns whether the participant device is in a conference or not.

Parameters

participant_device A LinphoneParticipantDevice object

Returns: a boolean to state whether the device is in a conference

◆ linphone_participant_device_ref()

LinphoneParticipantDevice* linphone_participant_device_ref ( LinphoneParticipantDevice * participant_device )

Increments reference count of LinphoneParticipantDevice object.

Parameters

participant_device the LinphoneParticipantDevice object

Returns: the same LinphoneParticipantDevice object

◆ linphone_participant_device_remove_callbacks()

void linphone_participant_device_remove_callbacks	(	LinphoneParticipantDevice *	participant_device,
		LinphoneParticipantDeviceCbs *	cbs
	)

Remove a listener from a LinphoneParticipantDevice.

Parameters

participant_device	LinphoneParticipantDevice object.
cbs	LinphoneParticipantDeviceCbs object to remove.

◆ linphone_participant_device_screen_sharing_enabled()

bool_t linphone_participant_device_screen_sharing_enabled ( const LinphoneParticipantDevice * participant_device )

Returns whether the participant device is screen sharing or not.

Parameters

participant_device The LinphoneParticipantDevice object

Returns: TRUE if the participant device is screen sharing, FALSE otherwise.

◆ linphone_participant_device_set_native_video_window_id()

void linphone_participant_device_set_native_video_window_id	(	LinphoneParticipantDevice *	participant_device,
		void *	window_id
	)

Sets the the native window ID where video for this participant device is to be rendered.

Parameters

participant_device	A LinphoneParticipantDevice object
window_id	the window ID of the device

◆ linphone_participant_device_set_user_data()

void linphone_participant_device_set_user_data	(	LinphoneParticipantDevice *	participant_device,
		void *	user_data
	)

Assigns a user pointer to the participant's device.

Parameters

participant_device	A LinphoneParticipantDevice object
user_data	The user pointer to associate with the participant's device.

◆ linphone_participant_device_unref()

void linphone_participant_device_unref ( LinphoneParticipantDevice * participant_device )

Decrements reference count of LinphoneParticipantDevice object.

Parameters

participant_device the LinphoneParticipantDevice object

◆ linphone_participant_find_device()

LinphoneParticipantDevice* linphone_participant_find_device	(	const LinphoneParticipant *	participant,
		const LinphoneAddress *	address
	)

Find a device in the list of devices from a chat room's participant.

Parameters

participant	A LinphoneParticipant object
address	A LinphoneAddress object

Returns: a LinphoneParticipantDevice or NULL if not found.

◆ linphone_participant_find_device_2()

LinphoneParticipantDevice* linphone_participant_find_device_2	(	const LinphoneParticipant *	participant,
		const LinphoneCall *	call
	)

Find a device in the list of devices from a chat room's participant.

Parameters

participant	A LinphoneParticipant object
call	A LinphoneCall object

Returns: a LinphoneParticipantDevice or NULL if not found.

◆ linphone_participant_get_address()

const LinphoneAddress* linphone_participant_get_address ( const LinphoneParticipant * participant )

Get the address of a conference participant.

Parameters

participant A LinphoneParticipant object

Returns: The LinphoneAddress of the participant

◆ linphone_participant_get_creation_time()

time_t linphone_participant_get_creation_time ( const LinphoneParticipant * participant )

Get the timestamp of the creation of the participant.

Parameters

participant A LinphoneParticipant object

Returns: time of creation of the participant as returned by time(nullptr). For UNIX based systems it is the number of seconds since 00:00hours of the 1st of January 1970

◆ linphone_participant_get_devices()

bctbx_list_t* linphone_participant_get_devices ( const LinphoneParticipant * participant )

Gets the list of devices from a chat room's participant.

Parameters

participant A LinphoneParticipant object

Returns: List of devices.

◆ linphone_participant_get_role()

LinphoneParticipantRole linphone_participant_get_role ( const LinphoneParticipant * participant )

Get the role of the participant within the conference.

Parameters

participant A LinphoneParticipant object

Returns: role within the conference LinphoneParticipantRole

◆ linphone_participant_get_security_level()

LinphoneChatRoomSecurityLevel linphone_participant_get_security_level ( const LinphoneParticipant * participant )

Get the security level of a participant.

Parameters

participant A LinphoneParticipant object

Returns: The LinphoneChatRoomSecurityLevel of the participant

◆ linphone_participant_get_user_data()

void* linphone_participant_get_user_data ( const LinphoneParticipant * participant )

Retrieve the user pointer associated with the conference participant.

Parameters

participant A LinphoneParticipant object

Returns: The user pointer associated with the participant.

◆ linphone_participant_imdn_state_get_participant()

const LinphoneParticipant* linphone_participant_imdn_state_get_participant ( const LinphoneParticipantImdnState * state )

Get the participant concerned by a LinphoneParticipantImdnState.

Parameters

state A LinphoneParticipantImdnState object

Returns: The LinphoneParticipant concerned by the LinphoneParticipantImdnState

◆ linphone_participant_imdn_state_get_state()

LinphoneChatMessageState linphone_participant_imdn_state_get_state ( const LinphoneParticipantImdnState * state )

Get the chat message state the participant is in.

Parameters

state A LinphoneParticipantImdnState object

Returns: The LinphoneChatMessageState the participant is in

◆ linphone_participant_imdn_state_get_state_change_time()

time_t linphone_participant_imdn_state_get_state_change_time ( const LinphoneParticipantImdnState * state )

Get the timestamp at which a participant has reached the state described by a LinphoneParticipantImdnState.

Parameters

state A LinphoneParticipantImdnState object

Returns: The timestamp at which the participant has reached the state described in the LinphoneParticipantImdnState

◆ linphone_participant_imdn_state_get_user_data()

void* linphone_participant_imdn_state_get_user_data ( const LinphoneParticipantImdnState * state )

Retrieve the user pointer associated with a LinphoneParticipantImdnState.

Parameters

state A LinphoneParticipantImdnState object

Returns: The user pointer associated with the LinphoneParticipantImdnState.

◆ linphone_participant_imdn_state_ref()

LinphoneParticipantImdnState* linphone_participant_imdn_state_ref ( LinphoneParticipantImdnState * state )

Increment reference count of LinphoneParticipantImdnState object.

Parameters

state the LinphoneParticipantImdnState object

Returns: the same LinphoneParticipantImdnState object

◆ linphone_participant_imdn_state_set_user_data()

void linphone_participant_imdn_state_set_user_data	(	LinphoneParticipantImdnState *	state,
		void *	user_data
	)

Assign a user pointer to a LinphoneParticipantImdnState.

Parameters

state	A LinphoneParticipantImdnState object
user_data	The user pointer to associate with the LinphoneParticipantImdnState.

◆ linphone_participant_imdn_state_unref()

void linphone_participant_imdn_state_unref ( LinphoneParticipantImdnState * state )

Decrement reference count of LinphoneParticipantImdnState object.

Parameters

state the LinphoneParticipantImdnState object

◆ linphone_participant_is_admin()

bool_t linphone_participant_is_admin ( const LinphoneParticipant * participant )

Tells whether a conference participant is an administrator of the conference.

Parameters

participant A LinphoneParticipant object

Returns: A boolean value telling whether the participant is an administrator

◆ linphone_participant_is_focus()

bool_t linphone_participant_is_focus ( const LinphoneParticipant * participant )

Tells whether a conference participant is the focus of the conference.

Parameters

participant A LinphoneParticipant object

Returns: A boolean value telling whether the participant is a focus of a conference

◆ linphone_participant_ref()

LinphoneParticipant* linphone_participant_ref ( LinphoneParticipant * participant )

Increment reference count of LinphoneParticipant object.

Parameters

participant a LinphoneParticipant object

Returns: the same LinphoneParticipant object

◆ linphone_participant_set_user_data()

void linphone_participant_set_user_data	(	LinphoneParticipant *	participant,
		void *	user_data
	)

Assign a user pointer to the conference participant.

Parameters

participant	A LinphoneParticipant object
user_data	The user pointer to associate with the participant.

◆ linphone_participant_unref()

void linphone_participant_unref ( LinphoneParticipant * participant )

Decrement reference count of LinphoneParticipant object.

Parameters

participant a LinphoneParticipant object

◆ linphone_push_notification_config_clone()

LinphonePushNotificationConfig* linphone_push_notification_config_clone ( const LinphonePushNotificationConfig * push_cfg )

Instantiate a new push notification parameters with values from source.

Parameters

push_cfg The LinphonePushNotificationConfig object to be cloned.

Returns: The newly created LinphonePushNotificationConfig object.

◆ linphone_push_notification_config_get_bundle_identifier()

const char* linphone_push_notification_config_get_bundle_identifier ( const LinphonePushNotificationConfig * push_cfg )

Gets the app's bundle identifier for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The app's bundle identifier if set, NULL otherwise.

◆ linphone_push_notification_config_get_call_snd()

const char* linphone_push_notification_config_get_call_snd ( const LinphonePushNotificationConfig * push_cfg )

Gets the call_snd for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The call_snd, default value "notes_of_the_optimistic.caf".

◆ linphone_push_notification_config_get_call_str()

const char* linphone_push_notification_config_get_call_str ( const LinphonePushNotificationConfig * push_cfg )

Gets the call_str for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The call_str, default value "IC_MSG".

◆ linphone_push_notification_config_get_group_chat_str()

const char* linphone_push_notification_config_get_group_chat_str ( const LinphonePushNotificationConfig * push_cfg )

Gets the groupchat_str for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The groupchat_str, default value "GC_MSG".

◆ linphone_push_notification_config_get_msg_snd()

const char* linphone_push_notification_config_get_msg_snd ( const LinphonePushNotificationConfig * push_cfg )

Gets the msg_snd for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The msg_snd, default value "msg.caf".

◆ linphone_push_notification_config_get_msg_str()

const char* linphone_push_notification_config_get_msg_str ( const LinphonePushNotificationConfig * push_cfg )

Gets the msg_str for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The msg_str, default value "IM_MSG".

◆ linphone_push_notification_config_get_param()

const char* linphone_push_notification_config_get_param ( const LinphonePushNotificationConfig * push_cfg )

Gets the param for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The param if set, NULL otherwise.

◆ linphone_push_notification_config_get_prid()

const char* linphone_push_notification_config_get_prid ( const LinphonePushNotificationConfig * push_cfg )

Gets the prid for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The prid if set, NULL otherwise.

◆ linphone_push_notification_config_get_provider()

const char* linphone_push_notification_config_get_provider ( const LinphonePushNotificationConfig * push_cfg )

Gets the provider for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The provider if set, NULL otherwise.

◆ linphone_push_notification_config_get_remote_token()

const char* linphone_push_notification_config_get_remote_token ( const LinphonePushNotificationConfig * push_cfg )

Gets the remote token for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The remote token if set, NULL otherwise.

◆ linphone_push_notification_config_get_team_id()

const char* linphone_push_notification_config_get_team_id ( const LinphonePushNotificationConfig * push_cfg )

Gets the team id for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The team id if set, NULL otherwise.

◆ linphone_push_notification_config_get_voip_token()

const char* linphone_push_notification_config_get_voip_token ( const LinphonePushNotificationConfig * push_cfg )

Gets the voip token for "contact uri parameter".

Parameters

push_cfg The LinphonePushNotificationConfig object

Returns: The voip token if set, NULL otherwise.

◆ linphone_push_notification_config_is_equal()

bool_t linphone_push_notification_config_is_equal	(	const LinphonePushNotificationConfig *	push_cfg,
		const LinphonePushNotificationConfig *	other_config
	)

Checks if two Push Notification Configurations are identical.

Parameters

push_cfg	The LinphonePushNotificationConfig object to be compared.
other_config	The LinphonePushNotificationConfig object to compare to.

Returns: True only if the two configurations are identical.

◆ linphone_push_notification_config_ref()

LinphonePushNotificationConfig* linphone_push_notification_config_ref ( LinphonePushNotificationConfig * push_cfg )

Take a reference on a LinphonePushNotificationConfig.

Parameters

push_cfg the LinphonePushNotificationConfig object

Returns: the same LinphonePushNotificationConfig object

◆ linphone_push_notification_config_set_bundle_identifier()

void linphone_push_notification_config_set_bundle_identifier	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	bundle_identifier
	)

Sets the bundle_identifier for "contact uri parameter".

It's not necessary if param is set. See linphone_push_notification_config_set_param().

Parameters

push_cfg	The LinphonePushNotificationConfig object
bundle_identifier	The new bundle_identifier set for push notification config.

◆ linphone_push_notification_config_set_call_snd()

void linphone_push_notification_config_set_call_snd	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	call_snd
	)

Sets the call_snd for "contact uri parameter", specific for remote push notification.

Parameters

push_cfg	The LinphonePushNotificationConfig object
call_snd	The new call_snd set for push notification config.

◆ linphone_push_notification_config_set_call_str()

void linphone_push_notification_config_set_call_str	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	call_str
	)

Sets the call_str for "contact uri parameter", specific for remote push notification.

Parameters

push_cfg	The LinphonePushNotificationConfig object
call_str	The new call_str set for push notification config.

◆ linphone_push_notification_config_set_group_chat_str()

void linphone_push_notification_config_set_group_chat_str	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	group_chat_str
	)

Sets the group_chat_str for "contact uri parameter", specific for remote push notification.

Parameters

push_cfg	The LinphonePushNotificationConfig object
group_chat_str	The new group_chat_str set for push notification config.

◆ linphone_push_notification_config_set_msg_snd()

void linphone_push_notification_config_set_msg_snd	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	msg_snd
	)

Sets the msg_snd for "contact uri parameter", specific for remote push notification.

Parameters

push_cfg	The LinphonePushNotificationConfig object
msg_snd	The new msg_snd set for push notification config.

◆ linphone_push_notification_config_set_msg_str()

void linphone_push_notification_config_set_msg_str	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	msg_str
	)

Sets the msg_str for "contact uri parameter", specific for remote push notification.

Parameters

push_cfg	The LinphonePushNotificationConfig object
msg_str	The new msg_str set for push notification config.

◆ linphone_push_notification_config_set_param()

void linphone_push_notification_config_set_param	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	param
	)

Sets the param for "contact uri parameter".

If it's not set, "team_id.bundle_identifier.services" will be used.

Parameters

push_cfg	The LinphonePushNotificationConfig object
param	The new param set for push notification config.

◆ linphone_push_notification_config_set_prid()

void linphone_push_notification_config_set_prid	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	prid
	)

Sets the prid for "contact uri parameter".

If it's not set, "voip_token&remote_token" will be used.

Parameters

push_cfg	The LinphonePushNotificationConfig object
prid	The new prid set for push notification config.

◆ linphone_push_notification_config_set_provider()

void linphone_push_notification_config_set_provider	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	provider
	)

Sets the provider for "contact uri parameter".

If not set, the default value will be used for "contact uri parameter", "firebase" for android or "apns" for ios.

Parameters

push_cfg	The LinphonePushNotificationConfig object
provider	The new provider set for push notification config.

◆ linphone_push_notification_config_set_remote_push_interval()

void linphone_push_notification_config_set_remote_push_interval	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	remote_push_interval
	)

Specifies the interval in seconds between to subsequent remote push notifications when remote push notifications are used to notify a call invite to clients that haven't published any token for VoIP and background push notifications.

In that case, several PNs are sent subsequently until the call is picked up, declined or canceled. This parameter sets a value for 'pn-call-remote-push-interval' Contact header inside SIP REGISTER requests. A value of zero will cause the deactivation of push notification repetitions and the sending of the final notification. Thus, only the first push notification will be sent. If specified the value must be in [0;30] If not specified 'pn-call-remote-push-interval' will not be added to Contact header.

Parameters

push_cfg	The LinphonePushNotificationConfig object
remote_push_interval	The new remote push interval set for push notification config.

◆ linphone_push_notification_config_set_remote_token()

void linphone_push_notification_config_set_remote_token	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	remote_token
	)

Sets the remote_token for "contact uri parameter", specific for remote push notification.

It's not necessary if prid is set. See linphone_push_notification_config_set_prid().

Parameters

push_cfg	The LinphonePushNotificationConfig object
remote_token	The new remote_token set for push notification config.

◆ linphone_push_notification_config_set_team_id()

void linphone_push_notification_config_set_team_id	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	team_id
	)

Sets the team id for "contact uri parameter".

It's not necessary if param is set. See linphone_push_notification_config_set_param().

Parameters

push_cfg	The LinphonePushNotificationConfig object
team_id	The new team id set for push notification config.

◆ linphone_push_notification_config_set_voip_token()

void linphone_push_notification_config_set_voip_token	(	LinphonePushNotificationConfig *	push_cfg,
		const char *	voip_token
	)

Sets the voip_token for "contact uri parameter", specific for voip push notification.

It's not necessary if prid is set. See linphone_push_notification_config_set_prid().

Parameters

push_cfg	The LinphonePushNotificationConfig object
voip_token	The new voip_token set for push notification config.

◆ linphone_push_notification_config_unref()

void linphone_push_notification_config_unref ( LinphonePushNotificationConfig * push_cfg )

Release a LinphonePushNotificationConfig.

Parameters

push_cfg the LinphonePushNotificationConfig object

◆ linphone_push_notification_message_get_call_id()

const char* linphone_push_notification_message_get_call_id ( const LinphonePushNotificationMessage * message )

Gets the call id.

Parameters

message The LinphonePushNotificationMessage object

Returns: The call id.

◆ linphone_push_notification_message_get_from_addr()

const LinphoneAddress* linphone_push_notification_message_get_from_addr ( const LinphonePushNotificationMessage * message )

Gets the from address.

Parameters

message The LinphonePushNotificationMessage object

Returns: The from LinphoneAddress.

◆ linphone_push_notification_message_get_local_addr()

const LinphoneAddress* linphone_push_notification_message_get_local_addr ( const LinphonePushNotificationMessage * message )

Gets the local address.

Parameters

message The LinphonePushNotificationMessage object

Returns: The local LinphoneAddress.

◆ linphone_push_notification_message_get_peer_addr()

const LinphoneAddress* linphone_push_notification_message_get_peer_addr ( const LinphonePushNotificationMessage * message )

Gets the peer address.

Parameters

message The LinphonePushNotificationMessage object

Returns: The peer LinphoneAddress.

◆ linphone_push_notification_message_get_reaction_content()

const char* linphone_push_notification_message_get_reaction_content ( const LinphonePushNotificationMessage * message )

Gets the reaction content.

Parameters

message The LinphonePushNotificationMessage object

Returns: The reaction content or NULL.

◆ linphone_push_notification_message_get_subject()

const char* linphone_push_notification_message_get_subject ( const LinphonePushNotificationMessage * message )

Gets the subject.

Parameters

message The LinphonePushNotificationMessage object

Returns: The subject or NULL.

◆ linphone_push_notification_message_get_text_content()

const char* linphone_push_notification_message_get_text_content ( const LinphonePushNotificationMessage * message )

Gets the text content.

Parameters

message The LinphonePushNotificationMessage object

Returns: The text content or NULL.

◆ linphone_push_notification_message_is_conference_invitation_cancellation()

bool_t linphone_push_notification_message_is_conference_invitation_cancellation ( const LinphonePushNotificationMessage * message )

Tells whether or not this message contains a conference invitation cancellation.

Parameters

message The LinphonePushNotificationMessage object

Returns: TRUE if this message carries a conference invitation cancellation, FALSE otherwise.

◆ linphone_push_notification_message_is_conference_invitation_new()

bool_t linphone_push_notification_message_is_conference_invitation_new ( const LinphonePushNotificationMessage * message )

Tells whether or not this message contains a new conference invitation.

Parameters

message The LinphonePushNotificationMessage object

Returns: TRUE if this message carries a new conference invitation, FALSE otherwise.

◆ linphone_push_notification_message_is_conference_invitation_update()

bool_t linphone_push_notification_message_is_conference_invitation_update ( const LinphonePushNotificationMessage * message )

Tells whether or not this message contains a conference invitation update.

Parameters

message The LinphonePushNotificationMessage object

Returns: TRUE if this message carries a conference invitation update, FALSE otherwise.

◆ linphone_push_notification_message_is_icalendar()

bool_t linphone_push_notification_message_is_icalendar ( const LinphonePushNotificationMessage * message )

Tells whether or not this message contains an icalendar by checking it's content type.

Parameters

message The LinphonePushNotificationMessage object

Returns: TRUE if this content type is 'text/calendar;conference-event=yes', FALSE otherwise.

◆ linphone_push_notification_message_is_text()

bool_t linphone_push_notification_message_is_text ( const LinphonePushNotificationMessage * message )

Returns wether it is a text message or not.

Parameters

message The LinphonePushNotificationMessage object

Returns: TRUE if it is a text message, FALSE otherwise.

◆ linphone_push_notification_message_ref()

LinphonePushNotificationMessage* linphone_push_notification_message_ref ( LinphonePushNotificationMessage * message )

Take a reference on a LinphonePushNotificationMessage.

Parameters

message the LinphonePushNotificationMessage object

Returns: the same LinphonePushNotificationMessage object

◆ linphone_push_notification_message_unref()

void linphone_push_notification_message_unref ( LinphonePushNotificationMessage * message )

Release a LinphonePushNotificationMessage.

Parameters

message the LinphonePushNotificationMessage object

◆ linphone_range_get_max()

int linphone_range_get_max ( const LinphoneRange * range )

Gets the higher value of the range.

Parameters

range a LinphoneRange

Returns: The higher value

◆ linphone_range_get_min()

int linphone_range_get_min ( const LinphoneRange * range )

Gets the lower value of the range.

Parameters

range a LinphoneRange

Returns: The lower value

◆ linphone_range_get_user_data()

void* linphone_range_get_user_data ( const LinphoneRange * range )

Gets the user data in the LinphoneRange object.

Parameters

range the LinphoneRange

Returns: the user data.

◆ linphone_range_ref()

LinphoneRange* linphone_range_ref ( LinphoneRange * range )

Increment refcount.

Parameters

range LinphoneRange object

Returns: the same LinphoneRange object

◆ linphone_range_set_max()

void linphone_range_set_max	(	LinphoneRange *	range,
		int	max
	)

Sets the higher value of the range.

Parameters

range	a LinphoneRange
max	the value to set

◆ linphone_range_set_min()

void linphone_range_set_min	(	LinphoneRange *	range,
		int	min
	)

Sets the lower value of the range.

Parameters

range	a LinphoneRange
min	the value to set

◆ linphone_range_set_user_data()

void linphone_range_set_user_data	(	LinphoneRange *	range,
		void *	user_data
	)

Sets the user data in the LinphoneRange object.

Parameters

range	the LinphoneRange object
user_data	the user data

◆ linphone_range_unref()

void linphone_range_unref ( LinphoneRange * range )

Decrement refcount and possibly free the object.

Parameters

range LinphoneRange object

◆ linphone_reason_to_error_code()

int linphone_reason_to_error_code ( LinphoneReason reason )

Converts a LinphoneReason to an error code.

Parameters

reason A LinphoneReason

Returns: The error code corresponding to the specified LinphoneReason

◆ linphone_reason_to_string()

const char* linphone_reason_to_string ( LinphoneReason error )

Converts a LinphoneReason enum to a string.

Parameters

error A LinphoneReason

Returns: The string representation of the specified LinphoneReason

◆ linphone_search_result_get_address()

const LinphoneAddress* linphone_search_result_get_address ( const LinphoneSearchResult * search_result )

Gets the address of the search result if any.

Parameters

search_result the LinphoneSearchResult object

Returns: The associed LinphoneAddress or NULL.

◆ linphone_search_result_get_capabilities()

int linphone_search_result_get_capabilities ( const LinphoneSearchResult * search_result )

Returns the capabilities mask of the search result.

Parameters

search_result the LinphoneSearchResult object

Returns: the capabilities mask associated to the search result

◆ linphone_search_result_get_friend()

LinphoneFriend* linphone_search_result_get_friend ( const LinphoneSearchResult * search_result )

Gets the friend of the search result if any.

Parameters

search_result the LinphoneSearchResult object

Returns: The associated LinphoneFriend or NULL.

◆ linphone_search_result_get_phone_number()

const char* linphone_search_result_get_phone_number ( const LinphoneSearchResult * search_result )

Gets the phone number of the search result if any.

Parameters

search_result the LinphoneSearchResult object

Returns: The associed phone number or NULL.

◆ linphone_search_result_get_source_flags()

int linphone_search_result_get_source_flags ( const LinphoneSearchResult * search_result )

Gets source flags of the search result.

Parameters

search_result the LinphoneSearchResult object

Returns: the source flags from LinphoneMagicSearchSource

◆ linphone_search_result_get_weight()

unsigned int linphone_search_result_get_weight ( const LinphoneSearchResult * search_result )

Gets the weight of the search result.

Parameters

search_result the LinphoneSearchResult object

Returns: the result weight

◆ linphone_search_result_has_capability()

bool_t linphone_search_result_has_capability	(	const LinphoneSearchResult *	search_result,
		const LinphoneFriendCapability	capability
	)

Returns whether or not the search result has the given capability.

Parameters

search_result	the LinphoneSearchResult object
capability	the LinphoneFriendCapability to check

Returns: TRUE if it has the capability, FALSE otherwise.

◆ linphone_search_result_has_source_flag()

bool_t linphone_search_result_has_source_flag	(	const LinphoneSearchResult *	search_result,
		const LinphoneMagicSearchSource	source
	)

Returns whether or not the search result has the given source flag.

Parameters

search_result	the LinphoneSearchResult object
source	the LinphoneMagicSearchSource to check

Returns: TRUE if it has the source flag, FALSE otherwise.

◆ linphone_search_result_ref()

LinphoneSearchResult* linphone_search_result_ref ( LinphoneSearchResult * search_result )

Increment reference count of LinphoneSearchResult object.

Parameters

search_result the LinphoneSearchResult object

Returns: the same LinphoneSearchResult object

◆ linphone_search_result_unref()

void linphone_search_result_unref ( LinphoneSearchResult * search_result )

Decrement reference count of LinphoneSearchResult object.

When dropped to zero, memory is freed.

Parameters

search_result the LinphoneSearchResult object

◆ linphone_transport_parse()

LinphoneTransportType linphone_transport_parse ( const char * transport )

Converts a lowercase string to a LinphoneTransportType enum.

Parameters

transport the transport to parse.

Returns: LinphoneTransportType 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.

Parameters

transport a LinphoneTransportType to convert to string

Returns: the string representation of the LinphoneTransportType

core	LinphoneCore object
current_version	The current version of the application

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ LinphoneContent

◆ LinphoneCoreCbsChatRoomExhumedCb

◆ LinphoneCoreCbsEcCalibrationAudioInitCb

◆ LinphoneCoreCbsEcCalibrationAudioUninitCb

◆ LinphoneCoreCbsEcCalibrationResultCb

◆ LinphoneErrorInfo

◆ LinphoneHeaders

◆ LinphoneImEncryptionEngine

◆ LinphoneImEncryptionEngineCbs

◆ LinphoneImEncryptionEngineCbsDownloadingFileCb

◆ LinphoneImEncryptionEngineCbsGenerateFileTransferKeyCb

◆ LinphoneImEncryptionEngineCbsIncomingMessageCb

◆ LinphoneImEncryptionEngineCbsIsEncryptionEnabledForFileTransferCb

◆ LinphoneImEncryptionEngineCbsOutgoingMessageCb

◆ LinphoneImEncryptionEngineCbsUploadingFileCb

◆ LinphoneMagicSearchCbsLdapHaveMoreResultsCb

◆ LinphoneMagicSearchCbsMoreResultsAvailableCb

◆ LinphoneMagicSearchCbsSearchResultsReceivedCb

◆ LinphoneReason

◆ LinphoneSecurityLevel

◆ LinphoneXmlRpcRequestCbsResponseCb

Enumeration Type Documentation

◆ _LinphoneReason

◆ _LinphoneSecurityLevel

◆ _LinphoneToneID

Function Documentation

◆ linphone_buffer_get_content()

◆ linphone_buffer_get_size()

◆ linphone_buffer_get_string_content()

◆ linphone_buffer_get_user_data()

◆ linphone_buffer_is_empty()

◆ linphone_buffer_new()

◆ linphone_buffer_new_from_data()

◆ linphone_buffer_new_from_string()

◆ linphone_buffer_ref()

◆ linphone_buffer_set_content()

◆ linphone_buffer_set_size()

◆ linphone_buffer_set_string_content()

◆ linphone_buffer_set_user_data()

◆ linphone_buffer_unref()

◆ linphone_call_stats_get_user_data()

◆ linphone_call_stats_ref()

◆ linphone_call_stats_set_user_data()

◆ linphone_call_stats_unref()

◆ linphone_configuring_state_to_string()

◆ linphone_content_add_content_type_parameter()

◆ linphone_content_add_custom_header()

◆ linphone_content_export_plain_file()

◆ linphone_content_find_part_by_header()

◆ linphone_content_get_buffer()

◆ linphone_content_get_creation_timestamp()

◆ linphone_content_get_custom_header()

◆ linphone_content_get_disposition()

◆ linphone_content_get_encoding()

◆ linphone_content_get_file_duration()

◆ linphone_content_get_file_path()

◆ linphone_content_get_file_size()

◆ linphone_content_get_key()

◆ linphone_content_get_key_size()

◆ linphone_content_get_name()

◆ linphone_content_get_part()

◆ linphone_content_get_parts()

◆ linphone_content_get_plain_file_path()

◆ linphone_content_get_related_chat_message_id()

◆ linphone_content_get_size()

◆ linphone_content_get_string_buffer()

◆ linphone_content_get_subtype()

◆ linphone_content_get_type()

◆ linphone_content_get_user_data()

◆ linphone_content_get_utf8_text()

◆ linphone_content_is_file()

◆ linphone_content_is_file_encrypted()

◆ linphone_content_is_file_transfer()

◆ linphone_content_is_icalendar()

◆ linphone_content_is_multipart()