Functions
bool_t	linphone_call_params_ringing_disabled (const LinphoneCallParams *params)

void	linphone_call_params_disable_ringing (LinphoneCallParams *params, bool_t disable)

bool_t	linphone_call_params_tone_indications_enabled (const LinphoneCallParams *params)

void	linphone_call_params_enable_tone_indications (LinphoneCallParams *params, bool_t enable)

bool_t	linphone_call_params_capability_negotiation_reinvite_enabled (const LinphoneCallParams *params)

void	linphone_call_params_enable_capability_negotiation_reinvite (LinphoneCallParams *params, bool_t enable)

bool_t	linphone_call_params_capability_negotiations_enabled (const LinphoneCallParams *params)

bool_t	linphone_call_params_cfg_lines_merged (const LinphoneCallParams *params)

bool_t	linphone_call_params_tcap_lines_merged (const LinphoneCallParams *params)

bool_t	linphone_call_params_is_media_encryption_supported (const LinphoneCallParams *params, const LinphoneMediaEncryption encryption)

bctbx_list_t *	linphone_call_params_get_supported_encryptions (const LinphoneCallParams *params)

bctbx_list_t *	linphone_call_params_get_srtp_suites (const LinphoneCallParams *call_params)

void	linphone_call_params_set_srtp_suites (LinphoneCallParams call_params, bctbx_list_t srtpSuites)

void	linphone_call_params_enable_audio_multicast (LinphoneCallParams *params, bool_t yesno)

bool_t	linphone_call_params_audio_multicast_enabled (const LinphoneCallParams *params)

void	linphone_call_params_enable_video_multicast (LinphoneCallParams *params, bool_t yesno)

bool_t	linphone_call_params_video_multicast_enabled (const LinphoneCallParams *params)

LinphoneStatus	linphone_call_params_enable_realtime_text (LinphoneCallParams *params, bool_t yesno)

bool_t	linphone_call_params_realtime_text_enabled (const LinphoneCallParams *params)

void	linphone_call_params_set_realtime_text_keepalive_interval (LinphoneCallParams *params, unsigned int interval)

unsigned int	linphone_call_params_get_realtime_text_keepalive_interval (const LinphoneCallParams *params)

void	linphone_call_params_add_custom_sdp_attribute (LinphoneCallParams params, const char attribute_name, const char *attribute_value)

void	linphone_call_params_add_custom_sdp_media_attribute (LinphoneCallParams params, LinphoneStreamType type, const char attribute_name, const char *attribute_value)

bool_t	linphone_call_params_has_custom_sdp_attribute (const LinphoneCallParams params, const char attribute_name)

const char *	linphone_call_params_get_custom_sdp_attribute (const LinphoneCallParams params, const char attribute_name)

bool_t	linphone_call_params_has_custom_sdp_media_attribute (const LinphoneCallParams params, LinphoneStreamType type, const char attribute_name)

const char *	linphone_call_params_get_custom_sdp_media_attribute (const LinphoneCallParams params, LinphoneStreamType type, const char attribute_name)

void	linphone_call_params_clear_custom_sdp_attributes (LinphoneCallParams *params)

void	linphone_call_params_clear_custom_sdp_media_attributes (LinphoneCallParams *params, LinphoneStreamType type)

bctbx_list_t *	linphone_call_params_get_custom_contents (const LinphoneCallParams *params)

void	linphone_call_params_add_custom_content (LinphoneCallParams params, LinphoneContent content)

bool_t	linphone_call_params_rtp_bundle_enabled (const LinphoneCallParams *params)

MS2_DEPRECATED void	linphone_call_params_enable_rtp_bundle (LinphoneCallParams *params, bool_t value)

void	linphone_call_params_enable_mic (LinphoneCallParams *params, bool_t enable)

bool_t	linphone_call_params_mic_enabled (const LinphoneCallParams *params)

MS2_DEPRECATED bool_t	linphone_call_params_is_capability_negotiation_reinvite_enabled (const LinphoneCallParams *params)

LinphoneVideoDefinition *	linphone_video_definition_ref (LinphoneVideoDefinition *video_definition)

void	linphone_video_definition_unref (LinphoneVideoDefinition *video_definition)

void *	linphone_video_definition_get_user_data (const LinphoneVideoDefinition *video_definition)

void	linphone_video_definition_set_user_data (LinphoneVideoDefinition video_definition, void user_data)

LinphoneVideoDefinition *	linphone_video_definition_clone (const LinphoneVideoDefinition *video_definition)

unsigned int	linphone_video_definition_get_width (const LinphoneVideoDefinition *video_definition)

void	linphone_video_definition_set_width (LinphoneVideoDefinition *video_definition, unsigned int width)

unsigned int	linphone_video_definition_get_height (const LinphoneVideoDefinition *video_definition)

void	linphone_video_definition_set_height (LinphoneVideoDefinition *video_definition, unsigned int height)

void	linphone_video_definition_set_definition (LinphoneVideoDefinition *video_definition, unsigned int width, unsigned int height)

const char *	linphone_video_definition_get_name (const LinphoneVideoDefinition *video_definition)

void	linphone_video_definition_set_name (LinphoneVideoDefinition video_definition, const char name)

bool_t	linphone_video_definition_equals (const LinphoneVideoDefinition video_definition1, const LinphoneVideoDefinition video_definition2)

bool_t	linphone_video_definition_strict_equals (const LinphoneVideoDefinition video_definition1, const LinphoneVideoDefinition video_definition2)

bool_t	linphone_video_definition_is_undefined (const LinphoneVideoDefinition *video_definition)

Detailed Description

Function Documentation

void linphone_call_params_add_custom_content	(	LinphoneCallParams *	params,
		LinphoneContent *	content
	)

Adds a LinphoneContent to be added to the INVITE SDP.

Parameters

params	The LinphoneCallParams in which to set the custom LinphoneContent.
content	The LinphoneContent to be added.

void linphone_call_params_add_custom_sdp_attribute	(	LinphoneCallParams *	params,
		const char *	attribute_name,
		const char *	attribute_value
	)

Add a custom attribute related to all the streams in the SDP exchanged within SIP messages during a call.

Parameters

params	The LinphoneCallParams to add a custom SDP attribute to.
attribute_name	The name of the attribute to add.
attribute_value	The content value of the attribute to add.

void linphone_call_params_add_custom_sdp_media_attribute	(	LinphoneCallParams *	params,
		LinphoneStreamType	type,
		const char *	attribute_name,
		const char *	attribute_value
	)

Add a custom attribute related to a specific stream in the SDP exchanged within SIP messages during a call.

Parameters

params	The LinphoneCallParams to add a custom SDP attribute to.
type	The type of the stream to add a custom SDP attribute to.
attribute_name	The name of the attribute to add.
attribute_value	The content value of the attribute to add.

bool_t linphone_call_params_audio_multicast_enabled ( const LinphoneCallParams * params )

Use to get multicast state of audio stream.

Parameters

params LinphoneCallParams

Returns: true if subsequent calls will propose multicast ip set by linphone_core_set_audio_multicast_addr()

bool_t linphone_call_params_capability_negotiation_reinvite_enabled ( const LinphoneCallParams * params )

Check if the capability negotiation (RFC5939) reINVITE is enabled or not.

Parameters

params the LinphoneCallParams

Returns: TRUE if capability negotiation reINVITE is enabled; FALSE otherwise.

bool_t linphone_call_params_capability_negotiations_enabled ( const LinphoneCallParams * params )

Indicates whether capability negotiations (RFC5939) is enabled.

Parameters

params the LinphoneCallParams

Returns: a boolean indicating the enablement of capability negotiations.

bool_t linphone_call_params_cfg_lines_merged ( const LinphoneCallParams * params )

Indicates whether cfg lines with consecutive indexes are going to be merged or not if capability negotiations (RFC5939) is enabled.

Parameters

params the LinphoneCallParams

Returns: a boolean indicating the enablement of pcfg and acfg line merging

void linphone_call_params_clear_custom_sdp_attributes ( LinphoneCallParams * params )

Clear the custom SDP attributes related to all the streams in the SDP exchanged within SIP messages during a call.

Parameters

params The LinphoneCallParams to clear the custom SDP attributes from.

void linphone_call_params_clear_custom_sdp_media_attributes	(	LinphoneCallParams *	params,
		LinphoneStreamType	type
	)

Clear the custom SDP attributes related to a specific stream in the SDP exchanged within SIP messages during a call.

Parameters

params	The LinphoneCallParams to clear the custom SDP attributes from.
type	The type of the stream to clear the custom SDP attributes from.

void linphone_call_params_disable_ringing	(	LinphoneCallParams *	params,
		bool_t	disable
	)

Define whether ringing is disabled.

Parameters

params	the LinphoneCallParams
disable	TRUE to disable ringing; FALSE otherwise.

void linphone_call_params_enable_audio_multicast	(	LinphoneCallParams *	params,
		bool_t	yesno
	)

Use to enable multicast rtp for audio stream.

If enabled, outgoing calls put a multicast address from linphone_core_get_video_multicast_addr() into audio cline. In case of outgoing call audio stream is sent to this multicast address.
For incoming calls behavior is unchanged.
Parameters

params LinphoneCallParams

yesno if yes, subsequent calls will propose multicast ip set by linphone_core_set_audio_multicast_addr()

void linphone_call_params_enable_capability_negotiation_reinvite	(	LinphoneCallParams *	params,
		bool_t	enable
	)

Define whether capability negotiation (RFC5939) reINVITE is enabled.

Parameters

params	the LinphoneCallParams
enable	TRUE to enable capability negotiation reINVITE; FALSE otherwise.

void linphone_call_params_enable_mic	(	LinphoneCallParams *	params,
		bool_t	enable
	)

Enable or disable the microphone at the call creation.

Warning: This method won't have any effect once the call has been created! Instead use linphone_call_set_microphone_muted() when call has been created.

Parameters

params	LinphoneCallParams object
enable	TRUE to enable the microphone, FALSE to disable it.

LinphoneStatus linphone_call_params_enable_realtime_text	(	LinphoneCallParams *	params,
		bool_t	yesno
	)

Use to enable real time text following rfc4103.

If enabled, outgoing calls put a m=text line in SDP offer .

Parameters

params	LinphoneCallParams
yesno	if yes, subsequent outgoing calls will propose rtt

Returns: 0

MS2_DEPRECATED void linphone_call_params_enable_rtp_bundle	(	LinphoneCallParams *	params,
		bool_t	value
	)

Enables or disables RTP bundle mode (Media Multiplexing).

See https://datatracker.ietf.org/doc/html/rfc8843 for more information about the feature. When enabled, liblinphone will try to negociate the use of a single port for all streams. It automatically enables rtcp-mux.

Parameters

params	the LinphoneCallParams
value	a boolean to indicate whether the feature is to be enabled.

Deprecated:: This property can no longer be controlled via LinphoneCallParams. Use linphone_account_params_enable_rtp_bundle().

void linphone_call_params_enable_tone_indications	(	LinphoneCallParams *	params,
		bool_t	enable
	)

Define whether tone indications are enabled.

Parameters

params	the LinphoneCallParams
enable	TRUE to enable tone indications; FALSE otherwise.

void linphone_call_params_enable_video_multicast	(	LinphoneCallParams *	params,
		bool_t	yesno
	)

Use to enable multicast rtp for video stream.

If enabled, outgoing calls put a multicast address from linphone_core_get_video_multicast_addr() into video cline. In case of outgoing call video stream is sent to this multicast address.
For incoming calls behavior is unchanged.

Parameters

params	LinphoneCallParams
yesno	if yes, subsequent outgoing calls will propose multicast ip set by linphone_core_set_video_multicast_addr()

bctbx_list_t* linphone_call_params_get_custom_contents ( const LinphoneCallParams * params )

Gets a list of LinphoneContent set if exists.

Parameters

params The LinphoneCallParams to get the custom Content from.

Returns: A list of LinphoneContent set if exists, NULL otherwise.

const char* linphone_call_params_get_custom_sdp_attribute	(	const LinphoneCallParams *	params,
		const char *	attribute_name
	)

Get a custom SDP attribute that is related to all the streams.

Parameters

params	The LinphoneCallParams to get the custom SDP attribute from.
attribute_name	The name of the attribute to get.

Returns: The content value of the attribute or NULL if not found.

const char* linphone_call_params_get_custom_sdp_media_attribute	(	const LinphoneCallParams *	params,
		LinphoneStreamType	type,
		const char *	attribute_name
	)

Get a custom SDP attribute that is related to a specific stream.

Parameters

params	The LinphoneCallParams to get the custom SDP attribute from.
type	The type of the stream to add a custom SDP attribute to.
attribute_name	The name of the attribute to get.

Returns: The content value of the attribute or NULL if not found.

unsigned int linphone_call_params_get_realtime_text_keepalive_interval ( const LinphoneCallParams * params )

Use to get keep alive interval of real time text following rfc4103.

Parameters

params LinphoneCallParams

Returns: returns keep alive interval of real time text.

bctbx_list_t* linphone_call_params_get_srtp_suites ( const LinphoneCallParams * call_params )

Returns the list of enable srtp suite in the call (enforced only if SDES is the selected encryption mode)

Parameters

call_params the LinphoneCallParams

Returns: a list of srtp suite enabled in a given call

bctbx_list_t* linphone_call_params_get_supported_encryptions ( const LinphoneCallParams * params )

Returns the list of supported encryptions in the call.

Parameters

params the LinphoneCallParams

Returns: a list of encryptions supported in a given call

bool_t linphone_call_params_has_custom_sdp_attribute	(	const LinphoneCallParams *	params,
		const char *	attribute_name
	)

Returns TRUE if a custom SDP attribute that is related to all the streams is present.

Parameters

params	The LinphoneCallParams to get the custom SDP attribute from.
attribute_name	The name of the attribute to get.

Returns: Whether the attribute is present.

bool_t linphone_call_params_has_custom_sdp_media_attribute	(	const LinphoneCallParams *	params,
		LinphoneStreamType	type,
		const char *	attribute_name
	)

Indicates whether a custom SDP attribute that is related to a specific stream is present or not.

Parameters

params	The LinphoneCallParams to get the custom SDP attribute from.
type	The type of the stream to add a custom SDP attribute to.
attribute_name	The name of the attribute to get.

Returns: Whether the attribute is present.

MS2_DEPRECATED bool_t linphone_call_params_is_capability_negotiation_reinvite_enabled ( const LinphoneCallParams * params )

Check if the capability negotiation (RFC5939) reINVITE is enabled or not.

Parameters

params the LinphoneCallParams

Returns: TRUE if capability negotiation reINVITE is enabled; FALSE otherwise.

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

bool_t linphone_call_params_is_media_encryption_supported	(	const LinphoneCallParams *	params,
		const LinphoneMediaEncryption	encryption
	)

Returns the encryption is supported.

Parameters

params	the LinphoneCallParams
encryption	The LinphoneMediaEncryption to check whether is supported

Returns: a boolean indicating whether the encryption is supported

bool_t linphone_call_params_mic_enabled ( const LinphoneCallParams * params )

Tells whether the microphone will be enabled when the call will be created.

Warning: This method only concerns the call creation, it doesn't reflect the actual microphone status during a call. Instead use linphone_call_get_microphone_muted() when call has been created.

Parameters

params LinphoneCallParams object

Returns: TRUE if the microphone will be enabled, FALSE if disabled.

bool_t linphone_call_params_realtime_text_enabled ( const LinphoneCallParams * params )

Use to get real time text following rfc4103.

Parameters

params LinphoneCallParams

Returns: returns true if call rtt is activated.

bool_t linphone_call_params_ringing_disabled ( const LinphoneCallParams * params )

Check if ringing is disabled.

Parameters

params the LinphoneCallParams

Returns: TRUE if ringing is disabled; FALSE otherwise.

bool_t linphone_call_params_rtp_bundle_enabled ( const LinphoneCallParams * params )

Indicates whether RTP bundle mode (also known as Media Multiplexing) is enabled.

See https://datatracker.ietf.org/doc/html/rfc8843 for more information.

Parameters

params the LinphoneCallParams

Returns: a boolean indicating the enablement of rtp bundle mode.

void linphone_call_params_set_realtime_text_keepalive_interval	(	LinphoneCallParams *	params,
		unsigned int	interval
	)

Use to set keep alive interval for real time text following rfc4103.

Parameters

params	LinphoneCallParams
interval	The keep alive interval for real time text, 25000 by default.

void linphone_call_params_set_srtp_suites	(	LinphoneCallParams *	call_params,
		bctbx_list_t *	srtpSuites
	)

Sets the list of srtp suite enabled(enforced only when SDES is the encryption mode)

Parameters

call_params	LinphoneCallParams object
srtpSuites	list with the list of SRTP encryption suites enabled in a given call

bool_t linphone_call_params_tcap_lines_merged ( const LinphoneCallParams * params )

Indicates whether tcap lines with consecutive indexes are going to be merged or not if capability negotiations (RFC5939) is enabled.

Parameters

params the LinphoneCallParams

Returns: a boolean indicating the enablement of tcap line merging

bool_t linphone_call_params_tone_indications_enabled ( const LinphoneCallParams * params )

Check if tone indications are enabled.

Parameters

params the LinphoneCallParams

Returns: TRUE if tone indications are enabled; FALSE otherwise.

bool_t linphone_call_params_video_multicast_enabled ( const LinphoneCallParams * params )

Use to get multicast state of video stream.

Parameters

params LinphoneCallParams

Returns: true if subsequent calls will propose multicast ip set by linphone_core_set_video_multicast_addr()

LinphoneVideoDefinition* linphone_video_definition_clone ( const LinphoneVideoDefinition * video_definition )

Clone a video definition.

Parameters

video_definition LinphoneVideoDefinition object to be cloned

Returns: The new clone of the video definition

bool_t linphone_video_definition_equals	(	const LinphoneVideoDefinition *	video_definition1,
		const LinphoneVideoDefinition *	video_definition2
	)

Tells whether two LinphoneVideoDefinition objects are equal (the widths and the heights are the same but can be switched).

Parameters

video_definition1	LinphoneVideoDefinition object
video_definition2	LinphoneVideoDefinition object

Returns: A boolean value telling whether the two LinphoneVideoDefinition objects are equal.

unsigned int linphone_video_definition_get_height ( const LinphoneVideoDefinition * video_definition )

Get the height of the video definition.

Parameters

video_definition LinphoneVideoDefinition object

Returns: The height of the video definition

const char* linphone_video_definition_get_name ( const LinphoneVideoDefinition * video_definition )

Get the name of the video definition.

Parameters

video_definition LinphoneVideoDefinition object

Returns: The name of the video definition

void* linphone_video_definition_get_user_data ( const LinphoneVideoDefinition * video_definition )

Retrieve the user pointer associated with the video definition.

Parameters

video_definition LinphoneVideoDefinition object.

Returns: The user pointer associated with the video definition.

unsigned int linphone_video_definition_get_width ( const LinphoneVideoDefinition * video_definition )

Get the width of the video definition.

Parameters

video_definition LinphoneVideoDefinition object

Returns: The width of the video definition

bool_t linphone_video_definition_is_undefined ( const LinphoneVideoDefinition * video_definition )

Tells whether a LinphoneVideoDefinition is undefined.

Parameters

video_definition LinphoneVideoDefinition object

Returns: A boolean value telling whether the LinphoneVideoDefinition is undefined.

LinphoneVideoDefinition* linphone_video_definition_ref ( LinphoneVideoDefinition * video_definition )

Acquire a reference to the video definition.

Parameters

video_definition LinphoneVideoDefinition object.

Returns: The same LinphoneVideoDefinition object.

void linphone_video_definition_set_definition	(	LinphoneVideoDefinition *	video_definition,
		unsigned int	width,
		unsigned int	height
	)

Set the width and the height of the video definition.

Parameters

video_definition	LinphoneVideoDefinition object
width	The width of the video definition
height	The height of the video definition

void linphone_video_definition_set_height	(	LinphoneVideoDefinition *	video_definition,
		unsigned int	height
	)

Set the height of the video definition.

Parameters

video_definition	LinphoneVideoDefinition object
height	The height of the video definition

void linphone_video_definition_set_name	(	LinphoneVideoDefinition *	video_definition,
		const char *	name
	)

Set the name of the video definition.

Parameters

video_definition	LinphoneVideoDefinition object
name	The name of the video definition

void linphone_video_definition_set_user_data	(	LinphoneVideoDefinition *	video_definition,
		void *	user_data
	)

Assign a user pointer to the video definition.

Parameters

video_definition	LinphoneVideoDefinition object.
user_data	The user pointer to associate with the video definition.

void linphone_video_definition_set_width	(	LinphoneVideoDefinition *	video_definition,
		unsigned int	width
	)

Set the width of the video definition.

Parameters

video_definition	LinphoneVideoDefinition object
width	The width of the video definition

bool_t linphone_video_definition_strict_equals	(	const LinphoneVideoDefinition *	video_definition1,
		const LinphoneVideoDefinition *	video_definition2
	)

Tells whether two LinphoneVideoDefinition objects are strictly equal (the widths are the same and the heights are the same).

Parameters

video_definition1	LinphoneVideoDefinition object
video_definition2	LinphoneVideoDefinition object

Returns: A boolean value telling whether the two LinphoneVideoDefinition objects are strictly equal.

void linphone_video_definition_unref ( LinphoneVideoDefinition * video_definition )

Release reference to the video definition.

Parameters

video_definition LinphoneVideoDefinition object.

Functions

Detailed Description

Function Documentation