Functions
void	linphone_call_params_add_custom_header (LinphoneCallParams call_params, const char header_name, const char *header_value)
	Add a custom SIP header in the INVITE for a call. More...

const char *	linphone_call_params_get_custom_header (const LinphoneCallParams call_params, const char header_name)
	Get a custom SIP header. More...

MS2_DEPRECATED LinphoneCallParams *	linphone_call_params_copy (const LinphoneCallParams *call_params)
	Copy an existing LinphoneCallParams object to a new LinphoneCallParams object. More...

bool_t	linphone_call_params_is_valid (const LinphoneCallParams *params)
	Check if call parameters are valid. More...

bool_t	linphone_call_params_early_media_sending_enabled (const LinphoneCallParams *call_params)
	Indicate whether sending of early media was enabled. More...

void	linphone_call_params_enable_early_media_sending (LinphoneCallParams *call_params, bool_t enabled)
	Enable sending of real early media (during outgoing calls). More...

void	linphone_call_params_enable_low_bandwidth (LinphoneCallParams *call_params, bool_t enabled)
	Indicate low bandwith mode. More...

void	linphone_call_params_enable_audio (LinphoneCallParams *call_params, bool_t enabled)
	Enable audio stream. More...

void	linphone_call_params_enable_capability_negotiations (LinphoneCallParams *params, bool_t enabled)
	Enable capability negotiations (RFC5939). More...

void	linphone_call_params_enable_cfg_lines_merging (LinphoneCallParams *params, bool_t enabled)
	Enable merging of cfg lines with consecutive indexes if capability negotiations (RFC5939) is enabled. More...

void	linphone_call_params_enable_tcap_line_merging (LinphoneCallParams *params, bool_t enabled)
	Enable merging of tcap lines with consecutive indexes if capability negotiations (RFC5939) is enabled. More...

void	linphone_call_params_set_supported_encryptions (LinphoneCallParams params, bctbx_list_t encs)
	Sets the list of supported encryptions. More...

void	linphone_call_params_enable_camera (LinphoneCallParams *call_params, bool_t enabled)
	Enable camera stream. More...

void	linphone_call_params_enable_screen_sharing (LinphoneCallParams *call_params, bool_t enabled)
	Enable screen sharing stream. More...

void	linphone_call_params_enable_video (LinphoneCallParams *call_params, bool_t enabled)
	Enable video stream. More...

LinphoneConferenceLayout	linphone_call_params_get_conference_video_layout (const LinphoneCallParams *params)
	Set video layout for conference. More...

void	linphone_call_params_set_conference_video_layout (LinphoneCallParams *params, LinphoneConferenceLayout layout)
	Set video layout for conference. More...

bool_t	linphone_call_params_get_local_conference_mode (const LinphoneCallParams *call_params)
	Tell whether the call is part of the locally managed conference. More...

LinphoneMediaEncryption	linphone_call_params_get_media_encryption (const LinphoneCallParams *call_params)
	Get the kind of media encryption selected for the call. More...

LinphonePrivacyMask	linphone_call_params_get_privacy (const LinphoneCallParams *call_params)
	Get requested level of privacy for the call. More...

float	linphone_call_params_get_received_framerate (const LinphoneCallParams *call_params)
	Get the framerate of the video that is received. More...

const LinphoneVideoDefinition *	linphone_call_params_get_received_video_definition (const LinphoneCallParams *call_params)
	Get the definition of the received video. More...

const char *	linphone_call_params_get_record_file (const LinphoneCallParams *call_params)
	Get the path for the audio recording of the call. More...

const char *	linphone_call_params_get_rtp_profile (const LinphoneCallParams *call_params)
	Get the RTP profile being used. More...

float	linphone_call_params_get_sent_framerate (const LinphoneCallParams *call_params)
	Get the framerate of the video that is sent. More...

const LinphoneVideoDefinition *	linphone_call_params_get_sent_video_definition (const LinphoneCallParams *call_params)
	Get the definition of the sent video. More...

const char *	linphone_call_params_get_session_name (const LinphoneCallParams *call_params)
	Get the session name of the media session (ie in SDP). More...

const LinphonePayloadType *	linphone_call_params_get_used_audio_payload_type (const LinphoneCallParams *call_params)
	Get the audio payload type that has been selected by a call. More...

const LinphonePayloadType *	linphone_call_params_get_used_video_payload_type (const LinphoneCallParams *call_params)
	Get the video payload type that has been selected by a call. More...

const LinphonePayloadType *	linphone_call_params_get_used_text_payload_type (const LinphoneCallParams *call_params)
	Get the text payload type that has been selected by a call. More...

bool_t	linphone_call_params_low_bandwidth_enabled (const LinphoneCallParams *call_params)
	Tell whether the call has been configured in low bandwidth mode or not. More...

void	linphone_call_params_set_audio_bandwidth_limit (LinphoneCallParams *call_params, int bandwidth)
	Refine bandwidth settings for this call by setting a bandwidth limit for audio streams. More...

void	linphone_call_params_set_media_encryption (LinphoneCallParams *call_params, LinphoneMediaEncryption encryption)
	Set requested media encryption for a call. More...

void	linphone_call_params_set_privacy (LinphoneCallParams *call_params, LinphonePrivacyMask privacy)
	Set requested level of privacy for the call. More...

void	linphone_call_params_set_record_file (LinphoneCallParams call_params, const char path)
	Enable recording of the call. More...

void	linphone_call_params_set_session_name (LinphoneCallParams call_params, const char name)
	Set the session name of the media session (ie in SDP). More...

bool_t	linphone_call_params_audio_enabled (const LinphoneCallParams *call_params)
	Tell whether audio is enabled or not. More...

bool_t	linphone_call_params_camera_enabled (const LinphoneCallParams *call_params)
	Tell whether camera is enabled or not. More...

bool_t	linphone_call_params_screen_sharing_enabled (const LinphoneCallParams *call_params)
	Tell whether screen sharing is enabled or not. More...

bool_t	linphone_call_params_video_enabled (const LinphoneCallParams *call_params)
	Tell whether video is enabled or not. More...

bool_t	linphone_call_params_fec_enabled (const LinphoneCallParams *call_params)
	Tell whether FEC is enabled or not. More...

LinphoneMediaDirection	linphone_call_params_get_audio_direction (const LinphoneCallParams *call_params)
	Get the audio stream direction. More...

LinphoneMediaDirection	linphone_call_params_get_video_direction (const LinphoneCallParams *call_params)
	Get the video stream direction. More...

void	linphone_call_params_set_audio_direction (LinphoneCallParams *call_params, LinphoneMediaDirection direction)
	Set the audio stream direction. More...

void	linphone_call_params_set_video_direction (LinphoneCallParams *call_params, LinphoneMediaDirection direction)
	Set the video stream direction. More...

void	linphone_call_params_set_account (LinphoneCallParams params, LinphoneAccount account)
	Set the LinphoneAccount to use for the call. More...

LinphoneAccount *	linphone_call_params_get_account (const LinphoneCallParams *params)
	Get the LinphoneAccount that is used for the call. More...

void	linphone_call_params_enable_avpf (LinphoneCallParams *params, bool_t enable)
	Toggle feedback extension for AVP. More...

bool_t	linphone_call_params_avpf_enabled (const LinphoneCallParams *params)
	Whether or not the feedback extension will be used for AVP. More...

bool_t	linphone_call_params_is_recording (const LinphoneCallParams *params)
	Indicates whether the call is being recorded. More...

void	linphone_call_params_set_from_header (LinphoneCallParams call_params, const char from_value)
	Force the from header of a call when instanciating it (if set, it precludes the search in proxy and primary contact) More...

const char *	linphone_call_params_get_from_header (const LinphoneCallParams *call_params)
	Get the from header in the CallParams. More...

int	linphone_call_params_get_audio_bandwidth_limit (const LinphoneCallParams *params)

bool_t	linphone_call_params_real_early_media_enabled (const LinphoneCallParams *params)

bool_t	linphone_call_params_has_avpf_enabled_been_set (const LinphoneCallParams *params)

bool_t	linphone_call_params_mandatory_media_encryption_enabled (const LinphoneCallParams *params)

void	linphone_call_params_enable_mandatory_media_encryption (LinphoneCallParams *params, bool_t value)

uint16_t	linphone_call_params_get_avpf_rr_interval (const LinphoneCallParams *params)

void	linphone_call_params_set_avpf_rr_interval (LinphoneCallParams *params, uint16_t value)

void *	linphone_call_params_get_user_data (const LinphoneCallParams *call_params)
	Get the user data associated with the call params. More...

void	linphone_call_params_set_user_data (LinphoneCallParams call_params, void user_data)
	Assign a user data to the call params. More...

LinphoneCallParams *	linphone_call_params_ref (LinphoneCallParams *call_params)
	Acquire a reference to the call params. More...

void	linphone_call_params_unref (LinphoneCallParams *call_params)
	Release a reference to the call params. More...

void	linphone_call_params_set_input_audio_device (LinphoneCallParams params, LinphoneAudioDevice audio_device)
	Sets the given LinphoneAudioDevice as default input for a call to be created later. More...

void	linphone_call_params_set_output_audio_device (LinphoneCallParams params, LinphoneAudioDevice audio_device)
	Sets the given LinphoneAudioDevice as default output for a call to be created later. More...

const LinphoneAudioDevice *	linphone_call_params_get_input_audio_device (const LinphoneCallParams *params)
	Gets the default input audio device for a call that will be created using this call params. More...

const LinphoneAudioDevice *	linphone_call_params_get_output_audio_device (const LinphoneCallParams *params)
	Gets the default output audio device for a call that will be created using this call params. More...

MS2_DEPRECATED MSVideoSize	linphone_call_params_get_received_video_size (const LinphoneCallParams *call_params)
	Get the size of the video that is received. More...

MS2_DEPRECATED MSVideoSize	linphone_call_params_get_sent_video_size (const LinphoneCallParams *call_params)
	Gets the size of the video that is sent. More...

MS2_DEPRECATED void	linphone_call_params_set_proxy_config (LinphoneCallParams params, LinphoneProxyConfig proxy_config)
	Set the LinphoneProxyConfig to use for the call. More...

MS2_DEPRECATED LinphoneProxyConfig *	linphone_call_params_get_proxy_config (const LinphoneCallParams *params)
	Get the LinphoneProxyConfig that is used for the call. More...

Detailed Description

Function Documentation

◆ linphone_call_params_add_custom_header()

void linphone_call_params_add_custom_header	(	LinphoneCallParams *	call_params,
		const char *	header_name,
		const char *	header_value
	)

Add a custom SIP header in the INVITE for a call.

Parameters

call_params	The LinphoneCallParams to add a custom SIP header to.
header_name	The name of the header to add.
header_value	The content of the header to add.

◆ linphone_call_params_audio_enabled()

bool_t linphone_call_params_audio_enabled ( const LinphoneCallParams * call_params )

Tell whether audio is enabled or not.

Parameters

call_params LinphoneCallParams object

Returns: A boolean value telling whether audio is enabled or not.

◆ linphone_call_params_avpf_enabled()

bool_t linphone_call_params_avpf_enabled ( const LinphoneCallParams * params )

Whether or not the feedback extension will be used for AVP.

Parameters

[in] params LinphoneCallParams object

Returns: true if AVPF is enabled, false otherwise

◆ linphone_call_params_camera_enabled()

bool_t linphone_call_params_camera_enabled ( const LinphoneCallParams * call_params )

Tell whether camera is enabled or not.

The value returned by this function has a different meaning whether it is from local or remote parameters. The former states the will of the user to use the camera of his/her device. On the other hand, the latter is just a guess to know whether the remote party enabled its camera or not. For example, while the call is part of a conference a core will understand that the remote party disabled its camera if the thumbnail stream's direction is inactive.

Parameters

call_params LinphoneCallParams object

Returns: A boolean value telling whether camera is enabled or not.

◆ linphone_call_params_copy()

MS2_DEPRECATED LinphoneCallParams* linphone_call_params_copy ( const LinphoneCallParams * call_params )

Copy an existing LinphoneCallParams object to a new LinphoneCallParams object.

linphone_call_params_copy() is error-prone, leading to inconsistent parameters being passed to linphone_core_invite_address_with_params() or linphone_call_accept_with_params().

Deprecated:: use exclusively linphone_core_create_call_params() to create LinphoneCallParams object.

Parameters

call_params The LinphoneCallParams object to copy.

Returns: A copy of the LinphoneCallParams object.

◆ linphone_call_params_early_media_sending_enabled()

bool_t linphone_call_params_early_media_sending_enabled ( const LinphoneCallParams * call_params )

Indicate whether sending of early media was enabled.

Parameters

call_params LinphoneCallParams object

Returns: A boolean value telling whether sending of early media was enabled.

◆ linphone_call_params_enable_audio()

void linphone_call_params_enable_audio	(	LinphoneCallParams *	call_params,
		bool_t	enabled
	)

Enable audio stream.

Parameters

call_params	LinphoneCallParams object
enabled	A boolean value telling whether to enable audio or not.

◆ linphone_call_params_enable_avpf()

void linphone_call_params_enable_avpf	(	LinphoneCallParams *	params,
		bool_t	enable
	)

Toggle feedback extension for AVP.

Parameters

[in]	params	LinphoneCallParams object
[in]	enable	wether or not AVPF should be enabled

◆ linphone_call_params_enable_camera()

void linphone_call_params_enable_camera	(	LinphoneCallParams *	call_params,
		bool_t	enabled
	)

Enable camera stream.

Parameters

call_params	LinphoneCallParams object
enabled	A boolean value telling whether to enable camera or not.

◆ linphone_call_params_enable_capability_negotiations()

void linphone_call_params_enable_capability_negotiations	(	LinphoneCallParams *	params,
		bool_t	enabled
	)

Enable capability negotiations (RFC5939).

Parameters

params	LinphoneCallParams object
enabled	A boolean value telling whether to enable capability negotiations or not.

◆ linphone_call_params_enable_cfg_lines_merging()

void linphone_call_params_enable_cfg_lines_merging	(	LinphoneCallParams *	params,
		bool_t	enabled
	)

Enable merging of cfg lines with consecutive indexes if capability negotiations (RFC5939) is enabled.

Parameters

params	LinphoneCallParams object
enabled	A boolean value telling whether to merge pcfg and acfg lines

◆ linphone_call_params_enable_early_media_sending()

void linphone_call_params_enable_early_media_sending	(	LinphoneCallParams *	call_params,
		bool_t	enabled
	)

Enable sending of real early media (during outgoing calls).

Parameters

call_params	LinphoneCallParams object
enabled	A boolean value telling whether to enable early media sending or not.

◆ linphone_call_params_enable_low_bandwidth()

void linphone_call_params_enable_low_bandwidth	(	LinphoneCallParams *	call_params,
		bool_t	enabled
	)

Indicate low bandwith mode.

Configuring a call to low bandwidth mode will result in the core to activate several settings for the call in order to ensure that bitrate usage is lowered to the minimum possible. Typically, ptime (packetization time) will be increased, audio codec's output bitrate will be targetted to 20kbit/s provided that it is achievable by the codec selected after SDP handshake. Video is automatically disabled.

Parameters

call_params	LinphoneCallParams object
enabled	A boolean value telling whether to activate the low bandwidth mode or not.

◆ linphone_call_params_enable_screen_sharing()

void linphone_call_params_enable_screen_sharing	(	LinphoneCallParams *	call_params,
		bool_t	enabled
	)

Enable screen sharing stream.

Parameters

call_params	LinphoneCallParams object
enabled	A boolean value telling whether to enable screen sharing or not.

◆ linphone_call_params_enable_tcap_line_merging()

void linphone_call_params_enable_tcap_line_merging	(	LinphoneCallParams *	params,
		bool_t	enabled
	)

Enable merging of tcap lines with consecutive indexes if capability negotiations (RFC5939) is enabled.

Parameters

params	LinphoneCallParams object
enabled	A boolean value telling whether to merge tcap lines

◆ linphone_call_params_enable_video()

void linphone_call_params_enable_video	(	LinphoneCallParams *	call_params,
		bool_t	enabled
	)

Enable video stream.

Parameters

call_params	LinphoneCallParams object
enabled	A boolean value telling whether to enable video or not.

◆ linphone_call_params_fec_enabled()

bool_t linphone_call_params_fec_enabled ( const LinphoneCallParams * call_params )

Tell whether FEC is enabled or not.

The FEC is enbaled whether a FEC stream is found.

Parameters

call_params LinphoneCallParams object

Returns: A boolean value telling whether FEC is enabled or not.

◆ linphone_call_params_get_account()

LinphoneAccount* linphone_call_params_get_account ( const LinphoneCallParams * params )

Get the LinphoneAccount that is used for the call.

Parameters

params the LinphoneCallParams

Returns: The selected LinphoneAccount for the call, or NULL if none has been selected.

◆ linphone_call_params_get_audio_direction()

LinphoneMediaDirection linphone_call_params_get_audio_direction ( const LinphoneCallParams * call_params )

Get the audio stream direction.

Parameters

call_params LinphoneCallParams object

Returns: The audio stream LinphoneMediaDirection associated with the call params.

◆ linphone_call_params_get_conference_video_layout()

LinphoneConferenceLayout linphone_call_params_get_conference_video_layout ( const LinphoneCallParams * params )

Set video layout for conference.

Parameters

params The LinphoneCallParams to get the custom SIP header from.

Returns: Preferred LinphoneConferenceLayout to use at the start of a conference

◆ linphone_call_params_get_custom_header()

const char* linphone_call_params_get_custom_header	(	const LinphoneCallParams *	call_params,
		const char *	header_name
	)

Get a custom SIP header.

Parameters

call_params	The LinphoneCallParams to get the custom SIP header from.
header_name	The name of the header to get.

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

◆ linphone_call_params_get_from_header()

const char* linphone_call_params_get_from_header ( const LinphoneCallParams * call_params )

Get the from header in the CallParams.

Parameters

call_params The LinphoneCallParams to get the from header from.

Returns: The content of the from header, may be null.

◆ linphone_call_params_get_input_audio_device()

const LinphoneAudioDevice* linphone_call_params_get_input_audio_device ( const LinphoneCallParams * params )

Gets the default input audio device for a call that will be created using this call params.

Warning: This method only concerns the call creation, it doesn't reflect the currently used input audio device of the call. Instead use linphone_call_get_input_audio_device() when call has been created.

Parameters

params The LinphoneCallParams

Returns: the LinphoneAudioDevice that will be used by default as input when the call will be created

◆ linphone_call_params_get_local_conference_mode()

bool_t linphone_call_params_get_local_conference_mode ( const LinphoneCallParams * call_params )

Tell whether the call is part of the locally managed conference.

Warning: If a conference server is used to manage conferences, that function does not return TRUE even if the conference is running.
If you want to test whether the conference is running, you should test whether linphone_core_get_conference() return a non-null pointer.

Parameters

call_params LinphoneCallParams object

Returns: A boolean value telling whether the call is part of the locally managed conference.

◆ linphone_call_params_get_media_encryption()

LinphoneMediaEncryption linphone_call_params_get_media_encryption ( const LinphoneCallParams * call_params )

Get the kind of media encryption selected for the call.

Parameters

call_params LinphoneCallParams object

Returns: The kind of LinphoneMediaEncryption selected for the call.

◆ linphone_call_params_get_output_audio_device()

const LinphoneAudioDevice* linphone_call_params_get_output_audio_device ( const LinphoneCallParams * params )

Gets the default output audio device for a call that will be created using this call params.

Warning: This method only concerns the call creation, it doesn't reflect the currently used output audio device of the call. Instead use linphone_call_get_output_audio_device() when call has been created.

Parameters

params The LinphoneCallParams

Returns: the LinphoneAudioDevice that will be used by default as output when the call will be created

◆ linphone_call_params_get_privacy()

LinphonePrivacyMask linphone_call_params_get_privacy ( const LinphoneCallParams * call_params )

Get requested level of privacy for the call.

Parameters

call_params LinphoneCallParams object

Returns: The LinphonePrivacyMask used for the call.

◆ linphone_call_params_get_proxy_config()

MS2_DEPRECATED LinphoneProxyConfig* linphone_call_params_get_proxy_config ( const LinphoneCallParams * params )

Get the LinphoneProxyConfig that is used for the call.

Parameters

params the LinphoneCallParams

Returns: The selected LinphoneProxyConfig for the call, or NULL if none has been selected.

Deprecated:: 28/02/2021 Use linphone_call_params_get_account() instead.

◆ linphone_call_params_get_received_framerate()

float linphone_call_params_get_received_framerate ( const LinphoneCallParams * call_params )

Get the framerate of the video that is received.

Parameters

call_params LinphoneCallParams object

Returns: The actual received framerate in frames per seconds, 0 if not available.

◆ linphone_call_params_get_received_video_definition()

const LinphoneVideoDefinition* linphone_call_params_get_received_video_definition ( const LinphoneCallParams * call_params )

Get the definition of the received video.

Parameters

call_params LinphoneCallParams object

Returns: The received LinphoneVideoDefinition or NULL.

◆ linphone_call_params_get_received_video_size()

MS2_DEPRECATED MSVideoSize linphone_call_params_get_received_video_size ( const LinphoneCallParams * call_params )

Get the size of the video that is received.

Parameters

call_params LinphoneCallParams object

Returns: The received video size or MS_VIDEO_SIZE_UNKNOWN if not available.

Deprecated:: 22/11/2017 Use linphone_call_params_get_received_video_definition() instead.

◆ linphone_call_params_get_record_file()

const char* linphone_call_params_get_record_file ( const LinphoneCallParams * call_params )

Get the path for the audio recording of the call.

Parameters

call_params LinphoneCallParams object

Returns: The path to the audio recording of the call or NULL.

◆ linphone_call_params_get_rtp_profile()

const char* linphone_call_params_get_rtp_profile ( const LinphoneCallParams * call_params )

Get the RTP profile being used.

Parameters

call_params LinphoneCallParams object

Returns: The RTP profile.

◆ linphone_call_params_get_sent_framerate()

float linphone_call_params_get_sent_framerate ( const LinphoneCallParams * call_params )

Get the framerate of the video that is sent.

Parameters

call_params LinphoneCallParams object

Returns: The actual sent framerate in frames per seconds, 0 if not available.

◆ linphone_call_params_get_sent_video_definition()

const LinphoneVideoDefinition* linphone_call_params_get_sent_video_definition ( const LinphoneCallParams * call_params )

Get the definition of the sent video.

Parameters

call_params LinphoneCallParams object

Returns: The sent LinphoneVideoDefinition or NULL.

◆ linphone_call_params_get_sent_video_size()

MS2_DEPRECATED MSVideoSize linphone_call_params_get_sent_video_size ( const LinphoneCallParams * call_params )

Gets the size of the video that is sent.

Parameters

call_params LinphoneCallParams object

Returns: The sent video size or MS_VIDEO_SIZE_UNKNOWN if not available.

Deprecated:: 22/11/2017 Use linphone_call_params_get_sent_video_definition() instead.

◆ linphone_call_params_get_session_name()

const char* linphone_call_params_get_session_name ( const LinphoneCallParams * call_params )

Get the session name of the media session (ie in SDP).

Subject from the SIP message can be retrieved using linphone_call_params_get_custom_header() and is different.

Parameters

call_params LinphoneCallParams object

Returns: The session name of the media session or NULL.

◆ linphone_call_params_get_used_audio_payload_type()

const LinphonePayloadType* linphone_call_params_get_used_audio_payload_type ( const LinphoneCallParams * call_params )

Get the audio payload type that has been selected by a call.

Parameters

call_params The LinphoneCallParams object.

Returns: The selected LinphonePayloadType. NULL is returned if no audio payload type has been selected by the call.

◆ linphone_call_params_get_used_text_payload_type()

const LinphonePayloadType* linphone_call_params_get_used_text_payload_type ( const LinphoneCallParams * call_params )

Get the text payload type that has been selected by a call.

Parameters

call_params The LinphoneCallParams object.

Returns: The selected LinphonePayloadType. NULL is returned if no text payload type has been selected by the call.

◆ linphone_call_params_get_used_video_payload_type()

const LinphonePayloadType* linphone_call_params_get_used_video_payload_type ( const LinphoneCallParams * call_params )

Get the video payload type that has been selected by a call.

Parameters

call_params The LinphoneCallParams object.

Returns: The selected LinphonePayloadType. NULL is returned if no video payload type has been selected by the call.

◆ linphone_call_params_get_user_data()

void* linphone_call_params_get_user_data ( const LinphoneCallParams * call_params )

Get the user data associated with the call params.

Parameters

call_params LinphoneCallParams object

Returns: The user data associated with the call params.

◆ linphone_call_params_get_video_direction()

LinphoneMediaDirection linphone_call_params_get_video_direction ( const LinphoneCallParams * call_params )

Get the video stream direction.

Parameters

call_params LinphoneCallParams object

Returns: The video stream LinphoneMediaDirection associated with the call params.

◆ linphone_call_params_is_recording()

bool_t linphone_call_params_is_recording ( const LinphoneCallParams * params )

Indicates whether the call is being recorded.

Parameters

params the LinphoneCallParams

Returns: TRUE if the call is being recorded, FALSE otherwise.

◆ linphone_call_params_is_valid()

bool_t linphone_call_params_is_valid ( const LinphoneCallParams * params )

Check if call parameters are valid.

Parameters

params the LinphoneCallParams

Returns: TRUE if the parameters are valid; FALSE otherwise.

◆ linphone_call_params_low_bandwidth_enabled()

bool_t linphone_call_params_low_bandwidth_enabled ( const LinphoneCallParams * call_params )

Tell whether the call has been configured in low bandwidth mode or not.

This mode can be automatically discovered thanks to a stun server when activate_edge_workarounds=1 in section [net] of configuration file. An application that would have reliable way to know network capacity may not use activate_edge_workarounds=1 but instead manually configure low bandwidth mode with linphone_call_params_enable_low_bandwidth(). When enabled, this param may transform a call request with video in audio only mode.

Parameters

call_params LinphoneCallParams object

Returns: A boolean value telling whether the low bandwidth mode has been configured/detected.

◆ linphone_call_params_ref()

LinphoneCallParams* linphone_call_params_ref ( LinphoneCallParams * call_params )

Acquire a reference to the call params.

Parameters

call_params LinphoneCallParams object

Returns: The same LinphoneCallParams object

◆ linphone_call_params_screen_sharing_enabled()

bool_t linphone_call_params_screen_sharing_enabled ( const LinphoneCallParams * call_params )

Tell whether screen sharing is enabled or not.

Parameters

call_params LinphoneCallParams object

Returns: A boolean value telling whether screen sharing is enabled or not.

◆ linphone_call_params_set_account()

void linphone_call_params_set_account	(	LinphoneCallParams *	params,
		LinphoneAccount *	account
	)

Set the LinphoneAccount to use for the call.

Parameters

params	the LinphoneCallParams
account	The LinphoneAccount to use, or NULL if none has been selected. The LinphoneCallParams keeps a reference to it and removes the previous one, if any.

◆ linphone_call_params_set_audio_bandwidth_limit()

void linphone_call_params_set_audio_bandwidth_limit	(	LinphoneCallParams *	call_params,
		int	bandwidth
	)

Refine bandwidth settings for this call by setting a bandwidth limit for audio streams.

As a consequence, codecs whose bitrates are not compatible with this limit won't be used.

Parameters

call_params	LinphoneCallParams object
bandwidth	The audio bandwidth limit to set in kbit/s.

◆ linphone_call_params_set_audio_direction()

void linphone_call_params_set_audio_direction	(	LinphoneCallParams *	call_params,
		LinphoneMediaDirection	direction
	)

Set the audio stream direction.

Parameters

call_params	LinphoneCallParams object
direction	The audio stream LinphoneMediaDirection associated with this call params.

◆ linphone_call_params_set_conference_video_layout()

void linphone_call_params_set_conference_video_layout	(	LinphoneCallParams *	params,
		LinphoneConferenceLayout	layout
	)

Set video layout for conference.

Parameters

params	The LinphoneCallParams to get the custom SIP header from.
layout	LinphoneConferenceLayout to use as default when creating a conference

◆ linphone_call_params_set_from_header()

void linphone_call_params_set_from_header	(	LinphoneCallParams *	call_params,
		const char *	from_value
	)

Force the from header of a call when instanciating it (if set, it precludes the search in proxy and primary contact)

Parameters

call_params	The LinphoneCallParams to add the forced from to.
from_value	The value of the forced from, null to delete it.

◆ linphone_call_params_set_input_audio_device()

void linphone_call_params_set_input_audio_device	(	LinphoneCallParams *	params,
		LinphoneAudioDevice *	audio_device
	)

Sets the given LinphoneAudioDevice as default input for a call to be created later.

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

Parameters

params	The LinphoneCallParams
audio_device	The LinphoneAudioDevice. NULL does nothing.

◆ linphone_call_params_set_media_encryption()

void linphone_call_params_set_media_encryption	(	LinphoneCallParams *	call_params,
		LinphoneMediaEncryption	encryption
	)

Set requested media encryption for a call.

Parameters

call_params	LinphoneCallParams object
encryption	The LinphoneMediaEncryption to use for the call.

◆ linphone_call_params_set_output_audio_device()

void linphone_call_params_set_output_audio_device	(	LinphoneCallParams *	params,
		LinphoneAudioDevice *	audio_device
	)

Sets the given LinphoneAudioDevice as default output for a call to be created later.

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

Parameters

params	The LinphoneCallParams
audio_device	The LinphoneAudioDevice. NULL does nothing.

◆ linphone_call_params_set_privacy()

void linphone_call_params_set_privacy	(	LinphoneCallParams *	call_params,
		LinphonePrivacyMask	privacy
	)

Set requested level of privacy for the call.

Parameters

call_params	LinphoneCallParams object
privacy	The LinphonePrivacyMask to used for the call.

◆ linphone_call_params_set_proxy_config()

MS2_DEPRECATED void linphone_call_params_set_proxy_config	(	LinphoneCallParams *	params,
		LinphoneProxyConfig *	proxy_config
	)

Set the LinphoneProxyConfig to use for the call.

Parameters

params	the LinphoneCallParams
proxy_config	The LinphoneProxyConfig to use, or NULL if none has been selected. The LinphoneCallParams keep a reference on it and remove the older if it exists.

Deprecated:: 28/02/2021 Use linphone_call_params_set_account() instead.

◆ linphone_call_params_set_record_file()

void linphone_call_params_set_record_file	(	LinphoneCallParams *	call_params,
		const char *	path
	)

Enable recording of the call.

This function must be used before the call parameters are assigned to the call. The call recording can be started and paused after the call is established with linphone_call_start_recording() and linphone_call_pause_recording().

Parameters

call_params	LinphoneCallParams object
path	A string containing the path and filename of the file where audio/video streams are to be written. The filename must have an extension that maps to any of the supported file formats listed in LinphoneMediaFileFormat enum.

◆ linphone_call_params_set_session_name()

void linphone_call_params_set_session_name	(	LinphoneCallParams *	call_params,
		const char *	name
	)

Set the session name of the media session (ie in SDP).

Subject from the SIP message (which is different) can be set using linphone_call_params_set_custom_header().

Parameters

call_params	LinphoneCallParams object
name	The session name to be used.

◆ linphone_call_params_set_supported_encryptions()

void linphone_call_params_set_supported_encryptions	(	LinphoneCallParams *	params,
		bctbx_list_t *	encs
	)

Sets the list of supported encryptions.

Parameters

params	LinphoneCallParams object
encs	list with the list of encryptions supported in a given call

◆ linphone_call_params_set_user_data()

void linphone_call_params_set_user_data	(	LinphoneCallParams *	call_params,
		void *	user_data
	)

Assign a user data to the call params.

Parameters

call_params	LinphoneCallParams object
user_data	The user data to associate with the call params.

◆ linphone_call_params_set_video_direction()

void linphone_call_params_set_video_direction	(	LinphoneCallParams *	call_params,
		LinphoneMediaDirection	direction
	)

Set the video stream direction.

Parameters

call_params	LinphoneCallParams object
direction	The video stream LinphoneMediaDirection associated with this call params.

◆ linphone_call_params_unref()

void linphone_call_params_unref ( LinphoneCallParams * call_params )

Release a reference to the call params.

Parameters

call_params LinphoneCallParams object

◆ linphone_call_params_video_enabled()

bool_t linphone_call_params_video_enabled ( const LinphoneCallParams * call_params )

Tell whether video is enabled or not.

Parameters

call_params LinphoneCallParams object

Returns: A boolean value telling whether video is enabled or not.

Functions

Detailed Description

Function Documentation

◆ linphone_call_params_add_custom_header()

◆ linphone_call_params_audio_enabled()

◆ linphone_call_params_avpf_enabled()

◆ linphone_call_params_camera_enabled()

◆ linphone_call_params_copy()

◆ linphone_call_params_early_media_sending_enabled()

◆ linphone_call_params_enable_audio()

◆ linphone_call_params_enable_avpf()

◆ linphone_call_params_enable_camera()

◆ linphone_call_params_enable_capability_negotiations()

◆ linphone_call_params_enable_cfg_lines_merging()

◆ linphone_call_params_enable_early_media_sending()

◆ linphone_call_params_enable_low_bandwidth()

◆ linphone_call_params_enable_screen_sharing()

◆ linphone_call_params_enable_tcap_line_merging()

◆ linphone_call_params_enable_video()

◆ linphone_call_params_fec_enabled()

◆ linphone_call_params_get_account()

◆ linphone_call_params_get_audio_direction()

◆ linphone_call_params_get_conference_video_layout()

◆ linphone_call_params_get_custom_header()

◆ linphone_call_params_get_from_header()

◆ linphone_call_params_get_input_audio_device()

◆ linphone_call_params_get_local_conference_mode()

◆ linphone_call_params_get_media_encryption()

◆ linphone_call_params_get_output_audio_device()

◆ linphone_call_params_get_privacy()

◆ linphone_call_params_get_proxy_config()

◆ linphone_call_params_get_received_framerate()

◆ linphone_call_params_get_received_video_definition()

◆ linphone_call_params_get_received_video_size()

◆ linphone_call_params_get_record_file()

◆ linphone_call_params_get_rtp_profile()

◆ linphone_call_params_get_sent_framerate()

◆ linphone_call_params_get_sent_video_definition()

◆ linphone_call_params_get_sent_video_size()

◆ linphone_call_params_get_session_name()

◆ linphone_call_params_get_used_audio_payload_type()

◆ linphone_call_params_get_used_text_payload_type()

◆ linphone_call_params_get_used_video_payload_type()

◆ linphone_call_params_get_user_data()

◆ linphone_call_params_get_video_direction()

◆ linphone_call_params_is_recording()

◆ linphone_call_params_is_valid()

◆ linphone_call_params_low_bandwidth_enabled()

◆ linphone_call_params_ref()

◆ linphone_call_params_screen_sharing_enabled()

◆ linphone_call_params_set_account()

◆ linphone_call_params_set_audio_bandwidth_limit()

◆ linphone_call_params_set_audio_direction()

◆ linphone_call_params_set_conference_video_layout()

◆ linphone_call_params_set_from_header()

◆ linphone_call_params_set_input_audio_device()

◆ linphone_call_params_set_media_encryption()

◆ linphone_call_params_set_output_audio_device()

◆ linphone_call_params_set_privacy()

◆ linphone_call_params_set_proxy_config()

◆ linphone_call_params_set_record_file()

◆ linphone_call_params_set_session_name()

◆ linphone_call_params_set_supported_encryptions()

◆ linphone_call_params_set_user_data()

◆ linphone_call_params_set_video_direction()

◆ linphone_call_params_unref()

◆ linphone_call_params_video_enabled()