Liblinphone  5.4.0
Functions
Media_parameters

Functions

bool_t linphone_call_params_ringing_disabled (const LinphoneCallParams *params)
 Check if ringing is disabled. More...
 
void linphone_call_params_disable_ringing (LinphoneCallParams *params, bool_t disable)
 Define whether ringing is disabled. More...
 
bool_t linphone_call_params_tone_indications_enabled (const LinphoneCallParams *params)
 Check if tone indications are enabled. More...
 
void linphone_call_params_enable_tone_indications (LinphoneCallParams *params, bool_t enable)
 Define whether tone indications are enabled. More...
 
bool_t linphone_call_params_capability_negotiation_reinvite_enabled (const LinphoneCallParams *params)
 Check if the capability negotiation (RFC5939) reINVITE is enabled or not. More...
 
void linphone_call_params_enable_capability_negotiation_reinvite (LinphoneCallParams *params, bool_t enable)
 Define whether capability negotiation (RFC5939) reINVITE is enabled. More...
 
bool_t linphone_call_params_capability_negotiations_enabled (const LinphoneCallParams *params)
 Indicates whether capability negotiations (RFC5939) is enabled. More...
 
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. More...
 
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. More...
 
bool_t linphone_call_params_is_media_encryption_supported (const LinphoneCallParams *params, const LinphoneMediaEncryption encryption)
 Returns the encryption is supported. More...
 
bctbx_list_t * linphone_call_params_get_supported_encryptions (const LinphoneCallParams *params)
 Returns the list of supported encryptions in the call. More...
 
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) More...
 
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) More...
 
void linphone_call_params_enable_audio_multicast (LinphoneCallParams *params, bool_t yesno)
 Use to enable multicast rtp for audio stream. More...
 
bool_t linphone_call_params_audio_multicast_enabled (const LinphoneCallParams *params)
 Use to get multicast state of audio stream. More...
 
void linphone_call_params_enable_video_multicast (LinphoneCallParams *params, bool_t yesno)
 Use to enable multicast rtp for video stream. More...
 
bool_t linphone_call_params_video_multicast_enabled (const LinphoneCallParams *params)
 Use to get multicast state of video stream. More...
 
LinphoneStatus linphone_call_params_enable_realtime_text (LinphoneCallParams *params, bool_t yesno)
 Use to enable real time text following rfc4103. More...
 
bool_t linphone_call_params_realtime_text_enabled (const LinphoneCallParams *params)
 Use to get real time text following rfc4103. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
bctbx_list_t * linphone_call_params_get_custom_contents (const LinphoneCallParams *params)
 Gets a list of LinphoneContent set if exists. More...
 
void linphone_call_params_add_custom_content (LinphoneCallParams *params, LinphoneContent *content)
 Adds a LinphoneContent to be added to the INVITE SDP. More...
 
bool_t linphone_call_params_rtp_bundle_enabled (const LinphoneCallParams *params)
 Indicates whether RTP bundle mode (also known as Media Multiplexing) is enabled. More...
 
MS2_DEPRECATED void linphone_call_params_enable_rtp_bundle (LinphoneCallParams *params, bool_t value)
 Enables or disables RTP bundle mode (Media Multiplexing). More...
 
void linphone_call_params_enable_mic (LinphoneCallParams *params, bool_t enable)
 Enable or disable the microphone at the call creation. More...
 
bool_t linphone_call_params_mic_enabled (const LinphoneCallParams *params)
 Tells whether the microphone will be enabled when the call will be created. More...
 
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. More...
 
LinphoneVideoDefinitionlinphone_video_definition_ref (LinphoneVideoDefinition *video_definition)
 Acquire a reference to the video definition. More...
 
void linphone_video_definition_unref (LinphoneVideoDefinition *video_definition)
 Release reference to the video definition. More...
 
void * linphone_video_definition_get_user_data (const LinphoneVideoDefinition *video_definition)
 Retrieve the user pointer associated with the video definition. More...
 
void linphone_video_definition_set_user_data (LinphoneVideoDefinition *video_definition, void *user_data)
 Assign a user pointer to the video definition. More...
 
LinphoneVideoDefinitionlinphone_video_definition_clone (const LinphoneVideoDefinition *video_definition)
 Clone a video definition. More...
 
unsigned int linphone_video_definition_get_width (const LinphoneVideoDefinition *video_definition)
 Get the width of the video definition. More...
 
void linphone_video_definition_set_width (LinphoneVideoDefinition *video_definition, unsigned int width)
 Set the width of the video definition. More...
 
unsigned int linphone_video_definition_get_height (const LinphoneVideoDefinition *video_definition)
 Get the height of the video definition. More...
 
void linphone_video_definition_set_height (LinphoneVideoDefinition *video_definition, unsigned int height)
 Set the height of the video definition. More...
 
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. More...
 
const char * linphone_video_definition_get_name (const LinphoneVideoDefinition *video_definition)
 Get the name of the video definition. More...
 
void linphone_video_definition_set_name (LinphoneVideoDefinition *video_definition, const char *name)
 Set the name of the video definition. More...
 
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). More...
 
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). More...
 
bool_t linphone_video_definition_is_undefined (const LinphoneVideoDefinition *video_definition)
 Tells whether a LinphoneVideoDefinition is undefined. More...
 

Detailed Description

Function Documentation

◆ linphone_call_params_add_custom_content()

void linphone_call_params_add_custom_content ( LinphoneCallParams params,
LinphoneContent content 
)

Adds a LinphoneContent to be added to the INVITE SDP.

Parameters
paramsThe LinphoneCallParams in which to set the custom LinphoneContent.
contentThe LinphoneContent to be added.

◆ linphone_call_params_add_custom_sdp_attribute()

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
paramsThe LinphoneCallParams to add a custom SDP attribute to.
attribute_nameThe name of the attribute to add.
attribute_valueThe content value of the attribute to add.

◆ linphone_call_params_add_custom_sdp_media_attribute()

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
paramsThe LinphoneCallParams to add a custom SDP attribute to.
typeThe type of the stream to add a custom SDP attribute to.
attribute_nameThe name of the attribute to add.
attribute_valueThe content value of the attribute to add.

◆ linphone_call_params_audio_multicast_enabled()

bool_t linphone_call_params_audio_multicast_enabled ( const LinphoneCallParams params)

Use to get multicast state of audio stream.

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

◆ linphone_call_params_capability_negotiation_reinvite_enabled()

bool_t linphone_call_params_capability_negotiation_reinvite_enabled ( const LinphoneCallParams params)

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

Parameters
paramsthe LinphoneCallParams
Returns
TRUE if capability negotiation reINVITE is enabled; FALSE otherwise.

◆ linphone_call_params_capability_negotiations_enabled()

bool_t linphone_call_params_capability_negotiations_enabled ( const LinphoneCallParams params)

Indicates whether capability negotiations (RFC5939) is enabled.

Parameters
paramsthe LinphoneCallParams
Returns
a boolean indicating the enablement of capability negotiations.

◆ linphone_call_params_cfg_lines_merged()

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
paramsthe LinphoneCallParams
Returns
a boolean indicating the enablement of pcfg and acfg line merging

◆ linphone_call_params_clear_custom_sdp_attributes()

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
paramsThe LinphoneCallParams to clear the custom SDP attributes from.

◆ linphone_call_params_clear_custom_sdp_media_attributes()

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
paramsThe LinphoneCallParams to clear the custom SDP attributes from.
typeThe type of the stream to clear the custom SDP attributes from.

◆ linphone_call_params_disable_ringing()

void linphone_call_params_disable_ringing ( LinphoneCallParams params,
bool_t  disable 
)

Define whether ringing is disabled.

Parameters
paramsthe LinphoneCallParams
disableTRUE to disable ringing; FALSE otherwise.

◆ linphone_call_params_enable_audio_multicast()

void linphone_call_params_enable_audio_multicast ( LinphoneCallParams params,
bool_t  yesno 
)

Use to enable multicast rtp for audio stream.

◆ linphone_call_params_enable_capability_negotiation_reinvite()

void linphone_call_params_enable_capability_negotiation_reinvite ( LinphoneCallParams params,
bool_t  enable 
)

Define whether capability negotiation (RFC5939) reINVITE is enabled.

Parameters
paramsthe LinphoneCallParams
enableTRUE to enable capability negotiation reINVITE; FALSE otherwise.

◆ linphone_call_params_enable_mic()

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
paramsLinphoneCallParams object
enableTRUE to enable the microphone, FALSE to disable it.

◆ linphone_call_params_enable_realtime_text()

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
paramsLinphoneCallParams
yesnoif yes, subsequent outgoing calls will propose rtt
Returns
0

◆ linphone_call_params_enable_rtp_bundle()

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
paramsthe LinphoneCallParams
valuea 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().

◆ linphone_call_params_enable_tone_indications()

void linphone_call_params_enable_tone_indications ( LinphoneCallParams params,
bool_t  enable 
)

Define whether tone indications are enabled.

Parameters
paramsthe LinphoneCallParams
enableTRUE to enable tone indications; FALSE otherwise.

◆ linphone_call_params_enable_video_multicast()

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
paramsLinphoneCallParams
yesnoif yes, subsequent outgoing calls will propose multicast ip set by linphone_core_set_video_multicast_addr()

◆ linphone_call_params_get_custom_contents()

bctbx_list_t* linphone_call_params_get_custom_contents ( const LinphoneCallParams params)

Gets a list of LinphoneContent set if exists.

Parameters
paramsThe LinphoneCallParams to get the custom Content from.
Returns
A list of LinphoneContent set if exists, NULL otherwise.

◆ linphone_call_params_get_custom_sdp_attribute()

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
paramsThe LinphoneCallParams to get the custom SDP attribute from.
attribute_nameThe name of the attribute to get.
Returns
The content value of the attribute or NULL if not found.

◆ linphone_call_params_get_custom_sdp_media_attribute()

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
paramsThe LinphoneCallParams to get the custom SDP attribute from.
typeThe type of the stream to add a custom SDP attribute to.
attribute_nameThe name of the attribute to get.
Returns
The content value of the attribute or NULL if not found.

◆ linphone_call_params_get_realtime_text_keepalive_interval()

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
paramsLinphoneCallParams
Returns
returns keep alive interval of real time text.

◆ linphone_call_params_get_srtp_suites()

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_paramsthe LinphoneCallParams
Returns
a list of srtp suite enabled in a given call

◆ linphone_call_params_get_supported_encryptions()

bctbx_list_t* linphone_call_params_get_supported_encryptions ( const LinphoneCallParams params)

Returns the list of supported encryptions in the call.

Parameters
paramsthe LinphoneCallParams
Returns
a list of encryptions supported in a given call

◆ linphone_call_params_has_custom_sdp_attribute()

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
paramsThe LinphoneCallParams to get the custom SDP attribute from.
attribute_nameThe name of the attribute to get.
Returns
Whether the attribute is present.

◆ linphone_call_params_has_custom_sdp_media_attribute()

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
paramsThe LinphoneCallParams to get the custom SDP attribute from.
typeThe type of the stream to add a custom SDP attribute to.
attribute_nameThe name of the attribute to get.
Returns
Whether the attribute is present.

◆ linphone_call_params_is_capability_negotiation_reinvite_enabled()

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
paramsthe LinphoneCallParams
Returns
TRUE if capability negotiation reINVITE is enabled; FALSE otherwise.
Deprecated:
16/12/2021 Use linphone_call_params_capability_negotiation_reinvite_enabled() instead.

◆ linphone_call_params_is_media_encryption_supported()

bool_t linphone_call_params_is_media_encryption_supported ( const LinphoneCallParams params,
const LinphoneMediaEncryption  encryption 
)

Returns the encryption is supported.

Parameters
paramsthe LinphoneCallParams
encryptionThe LinphoneMediaEncryption to check whether is supported
Returns
a boolean indicating whether the encryption is supported

◆ linphone_call_params_mic_enabled()

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
paramsLinphoneCallParams object
Returns
TRUE if the microphone will be enabled, FALSE if disabled.

◆ linphone_call_params_realtime_text_enabled()

bool_t linphone_call_params_realtime_text_enabled ( const LinphoneCallParams params)

Use to get real time text following rfc4103.

Parameters
paramsLinphoneCallParams
Returns
returns true if call rtt is activated.

◆ linphone_call_params_ringing_disabled()

bool_t linphone_call_params_ringing_disabled ( const LinphoneCallParams params)

Check if ringing is disabled.

Parameters
paramsthe LinphoneCallParams
Returns
TRUE if ringing is disabled; FALSE otherwise.

◆ linphone_call_params_rtp_bundle_enabled()

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
paramsthe LinphoneCallParams
Returns
a boolean indicating the enablement of rtp bundle mode.

◆ linphone_call_params_set_realtime_text_keepalive_interval()

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
paramsLinphoneCallParams
intervalThe keep alive interval for real time text, 25000 by default.

◆ linphone_call_params_set_srtp_suites()

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_paramsLinphoneCallParams object
srtpSuiteslist with the list of SRTP encryption suites enabled in a given call

◆ linphone_call_params_tcap_lines_merged()

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
paramsthe LinphoneCallParams
Returns
a boolean indicating the enablement of tcap line merging

◆ linphone_call_params_tone_indications_enabled()

bool_t linphone_call_params_tone_indications_enabled ( const LinphoneCallParams params)

Check if tone indications are enabled.

Parameters
paramsthe LinphoneCallParams
Returns
TRUE if tone indications are enabled; FALSE otherwise.

◆ linphone_call_params_video_multicast_enabled()

bool_t linphone_call_params_video_multicast_enabled ( const LinphoneCallParams params)

Use to get multicast state of video stream.

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

◆ linphone_video_definition_clone()

LinphoneVideoDefinition* linphone_video_definition_clone ( const LinphoneVideoDefinition video_definition)

Clone a video definition.

Parameters
video_definitionLinphoneVideoDefinition object to be cloned
Returns
The new clone of the video definition

◆ linphone_video_definition_equals()

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_definition1LinphoneVideoDefinition object
video_definition2LinphoneVideoDefinition object
Returns
A boolean value telling whether the two LinphoneVideoDefinition objects are equal.

◆ linphone_video_definition_get_height()

unsigned int linphone_video_definition_get_height ( const LinphoneVideoDefinition video_definition)

Get the height of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
Returns
The height of the video definition

◆ linphone_video_definition_get_name()

const char* linphone_video_definition_get_name ( const LinphoneVideoDefinition video_definition)

Get the name of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
Returns
The name of the video definition

◆ linphone_video_definition_get_user_data()

void* linphone_video_definition_get_user_data ( const LinphoneVideoDefinition video_definition)

Retrieve the user pointer associated with the video definition.

Parameters
video_definitionLinphoneVideoDefinition object.
Returns
The user pointer associated with the video definition.

◆ linphone_video_definition_get_width()

unsigned int linphone_video_definition_get_width ( const LinphoneVideoDefinition video_definition)

Get the width of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
Returns
The width of the video definition

◆ linphone_video_definition_is_undefined()

bool_t linphone_video_definition_is_undefined ( const LinphoneVideoDefinition video_definition)

Tells whether a LinphoneVideoDefinition is undefined.

Parameters
video_definitionLinphoneVideoDefinition object
Returns
A boolean value telling whether the LinphoneVideoDefinition is undefined.

◆ linphone_video_definition_ref()

LinphoneVideoDefinition* linphone_video_definition_ref ( LinphoneVideoDefinition video_definition)

Acquire a reference to the video definition.

Parameters
video_definitionLinphoneVideoDefinition object.
Returns
The same LinphoneVideoDefinition object.

◆ linphone_video_definition_set_definition()

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_definitionLinphoneVideoDefinition object
widthThe width of the video definition
heightThe height of the video definition

◆ linphone_video_definition_set_height()

void linphone_video_definition_set_height ( LinphoneVideoDefinition video_definition,
unsigned int  height 
)

Set the height of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
heightThe height of the video definition

◆ linphone_video_definition_set_name()

void linphone_video_definition_set_name ( LinphoneVideoDefinition video_definition,
const char *  name 
)

Set the name of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
nameThe name of the video definition

◆ linphone_video_definition_set_user_data()

void linphone_video_definition_set_user_data ( LinphoneVideoDefinition video_definition,
void *  user_data 
)

Assign a user pointer to the video definition.

Parameters
video_definitionLinphoneVideoDefinition object.
user_dataThe user pointer to associate with the video definition.

◆ linphone_video_definition_set_width()

void linphone_video_definition_set_width ( LinphoneVideoDefinition video_definition,
unsigned int  width 
)

Set the width of the video definition.

Parameters
video_definitionLinphoneVideoDefinition object
widthThe width of the video definition

◆ linphone_video_definition_strict_equals()

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_definition1LinphoneVideoDefinition object
video_definition2LinphoneVideoDefinition object
Returns
A boolean value telling whether the two LinphoneVideoDefinition objects are strictly equal.

◆ linphone_video_definition_unref()

void linphone_video_definition_unref ( LinphoneVideoDefinition video_definition)

Release reference to the video definition.

Parameters
video_definitionLinphoneVideoDefinition object.