Inheritance diagram for Linphone.CallParams:

Public Member Functions
void	AddCustomContent (Linphone.Content content)

void	AddCustomHeader (string headerName, string headerValue)

void	AddCustomSdpAttribute (string attributeName, string attributeValue)

void	AddCustomSdpMediaAttribute (Linphone.StreamType type, string attributeName, string attributeValue)

bool	CfgLinesMerged ()

void	ClearCustomSdpAttributes ()

void	ClearCustomSdpMediaAttributes (Linphone.StreamType type)

Linphone.CallParams	Copy ()

void	DisableRinging (bool disable)

string	GetCustomHeader (string headerName)

string	GetCustomSdpAttribute (string attributeName)

string	GetCustomSdpMediaAttribute (Linphone.StreamType type, string attributeName)

bool	HasCustomSdpAttribute (string attributeName)

bool	HasCustomSdpMediaAttribute (Linphone.StreamType type, string attributeName)

bool	IsMediaEncryptionSupported (Linphone.MediaEncryption encryption)

bool	RingingDisabled ()

bool	TcapLinesMerged ()

Properties
Linphone.Account	Account `[get, set]`

int	AudioBandwidthLimit `[set]`

Linphone.MediaDirection	AudioDirection `[get, set]`

bool	AudioEnabled `[get, set]`

bool	AudioMulticastEnabled `[get, set]`

bool	AvpfEnabled `[get, set]`

bool	CameraEnabled `[get, set]`

bool	CapabilityNegotiationReinviteEnabled `[get, set]`

bool	CapabilityNegotiationsEnabled `[get, set]`

bool	CfgLinesMergingEnabled `[set]`

Linphone.ConferenceLayout	ConferenceVideoLayout `[get, set]`

IEnumerable< Linphone.Content >	CustomContents `[get]`

bool	EarlyMediaSendingEnabled `[get, set]`

bool	FecEnabled `[get]`

string	FromHeader `[get, set]`

Linphone.AudioDevice	InputAudioDevice `[get, set]`

bool	IsCapabilityNegotiationReinviteEnabled `[get]`

bool	IsRecording `[get]`

bool	IsValid `[get]`

bool	LocalConferenceMode `[get]`

bool	LowBandwidthEnabled `[get, set]`

Linphone.MediaEncryption	MediaEncryption `[get, set]`

bool	MicEnabled `[get, set]`

Linphone.AudioDevice	OutputAudioDevice `[get, set]`

uint	Privacy `[get, set]`

Linphone.ProxyConfig	ProxyConfig `[get, set]`

bool	RealtimeTextEnabled `[get, set]`

uint	RealtimeTextKeepaliveInterval `[get, set]`

float	ReceivedFramerate `[get]`

Linphone.VideoDefinition	ReceivedVideoDefinition `[get]`

string	RecordFile `[get, set]`

bool	RtpBundleEnabled `[get, set]`

string	RtpProfile `[get]`

bool	ScreenSharingEnabled `[get, set]`

float	SentFramerate `[get]`

Linphone.VideoDefinition	SentVideoDefinition `[get]`

string	SessionName `[get, set]`

bool	TcapLineMergingEnabled `[set]`

bool	ToneIndicationsEnabled `[get, set]`

Linphone.PayloadType	UsedAudioPayloadType `[get]`

Linphone.PayloadType	UsedTextPayloadType `[get]`

Linphone.PayloadType	UsedVideoPayloadType `[get]`

Linphone.MediaDirection	VideoDirection `[get, set]`

bool	VideoEnabled `[get, set]`

bool	VideoMulticastEnabled `[get, set]`

Additional Inherited Members
Protected Member Functions inherited from Linphone.LinphoneObject
static String	linphone_pointer_to_string (IntPtr ptr)

static IntPtr	linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)

IntPtr	StringArrayToBctbxList (IEnumerable< string > stringlist)

void	CleanStringArrayPtrs (IntPtr l)

Detailed Description

An object containing various parameters of a Linphone.Call.

You can specify your params while answering an incoming call using Linphone.Call.AcceptWithParams() or while initiating an outgoing call with Linphone.Core.InviteAddressWithParams(). This object can be created using Linphone.Core.CreateCallParams(), using null for the call pointer if you plan to use it for an outgoing call. For each call, three Linphone.CallParams are available: yours, your correspondent's and the one that describe the current state of the call that is the result of the negociation between the previous two. For example, you might enable a certain feature in your call param but this feature can be denied in the remote's configuration, hence the difference.

See : Linphone.Call.CurrentParams, Linphone.Call.RemoteParams and Linphone.Call.Params.

Member Function Documentation

void Linphone.CallParams.AddCustomContent ( Linphone.Content content )

inline

Adds a Linphone.Content to be added to the INVITE SDP.

Parameters

content The Linphone.Content to be added.

void Linphone.CallParams.AddCustomHeader	(	string	headerName,
		string	headerValue
	)

inline

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

Parameters

headerName	The name of the header to add.
headerValue	The content of the header to add.

void Linphone.CallParams.AddCustomSdpAttribute	(	string	attributeName,
		string	attributeValue
	)

inline

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

Parameters

attributeName	The name of the attribute to add.
attributeValue	The content value of the attribute to add.

void Linphone.CallParams.AddCustomSdpMediaAttribute	(	Linphone.StreamType	type,
		string	attributeName,
		string	attributeValue
	)

inline

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

Parameters

type	The type of the stream to add a custom SDP attribute to.
attributeName	The name of the attribute to add.
attributeValue	The content value of the attribute to add.

bool Linphone.CallParams.CfgLinesMerged ( )

inline

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

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

void Linphone.CallParams.ClearCustomSdpAttributes ( )

inline

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

void Linphone.CallParams.ClearCustomSdpMediaAttributes ( Linphone.StreamType type )

inline

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

Parameters

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

Linphone.CallParams Linphone.CallParams.Copy ( )

inline

Copy an existing Linphone.CallParams object to a new Linphone.CallParams object.

Linphone.CallParams.Copy() is error-prone, leading to inconsistent parameters being passed to Linphone.Core.InviteAddressWithParams() or Linphone.Call.AcceptWithParams().

Deprecated : use exclusively Linphone.Core.CreateCallParams() to create Linphone.CallParams object.

Returns: A copy of the Linphone.CallParams object.

void Linphone.CallParams.DisableRinging ( bool disable )

inline

Define whether ringing is disabled.

Parameters

disable true to disable ringing; false otherwise.

string Linphone.CallParams.GetCustomHeader ( string headerName )

inline

Get a custom SIP header.

Parameters

headerName The name of the header to get.

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

string Linphone.CallParams.GetCustomSdpAttribute ( string attributeName )

inline

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

Parameters

attributeName The name of the attribute to get.

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

string Linphone.CallParams.GetCustomSdpMediaAttribute	(	Linphone.StreamType	type,
		string	attributeName
	)

inline

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

Parameters

type	The type of the stream to add a custom SDP attribute to.
attributeName	The name of the attribute to get.

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

bool Linphone.CallParams.HasCustomSdpAttribute ( string attributeName )

inline

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

Parameters

attributeName The name of the attribute to get.

Returns: Whether the attribute is present.

bool Linphone.CallParams.HasCustomSdpMediaAttribute	(	Linphone.StreamType	type,
		string	attributeName
	)

inline

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

Parameters

type	The type of the stream to add a custom SDP attribute to.
attributeName	The name of the attribute to get.

Returns: Whether the attribute is present.

bool Linphone.CallParams.IsMediaEncryptionSupported ( Linphone.MediaEncryption encryption )

inline

Returns the encryption is supported.

Parameters

encryption The Linphone.MediaEncryption to check whether is supported

Returns: a boolean indicating whether the encryption is supported

bool Linphone.CallParams.RingingDisabled ( )

inline

Check if ringing is disabled.

Returns: true if ringing is disabled; false otherwise.

bool Linphone.CallParams.TcapLinesMerged ( )

inline

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

Returns: a boolean indicating the enablement of tcap line merging

Property Documentation

Linphone.Account Linphone.CallParams.Account

getset

Get the Linphone.Account that is used for the call.

Returns: The selected Linphone.Account for the call, or null if none has been selected.

int Linphone.CallParams.AudioBandwidthLimit

set

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

bandwidth The audio bandwidth limit to set in kbit/s.

Linphone.MediaDirection Linphone.CallParams.AudioDirection

getset

Get the audio stream direction.

Returns: The audio stream Linphone.MediaDirection associated with the call params.

bool Linphone.CallParams.AudioEnabled

getset

Tell whether audio is enabled or not.

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

bool Linphone.CallParams.AudioMulticastEnabled

getset

Use to get multicast state of audio stream.

Returns: true if subsequent calls will propose multicast ip set by Linphone.Core.AudioMulticastAddr

bool Linphone.CallParams.AvpfEnabled

getset

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

Returns: true if AVPF is enabled, false otherwise

bool Linphone.CallParams.CameraEnabled

getset

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.

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

bool Linphone.CallParams.CapabilityNegotiationReinviteEnabled

getset

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

Returns: true if capability negotiation reINVITE is enabled; false otherwise.

bool Linphone.CallParams.CapabilityNegotiationsEnabled

getset

Indicates whether capability negotiations (RFC5939) is enabled.

Returns: a boolean indicating the enablement of capability negotiations.

bool Linphone.CallParams.CfgLinesMergingEnabled

set

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

Parameters

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

Linphone.ConferenceLayout Linphone.CallParams.ConferenceVideoLayout

getset

Set video layout for conference.

Returns: Preferred Linphone.ConferenceLayout to use at the start of a conference

IEnumerable<Linphone.Content> Linphone.CallParams.CustomContents

get

Gets a list of Linphone.Content set if exists.

Returns: A list of Linphone.Content set if exists, null otherwise. A list of Linphone.Content objects.

bool Linphone.CallParams.EarlyMediaSendingEnabled

getset

Indicate whether sending of early media was enabled.

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

bool Linphone.CallParams.FecEnabled

get

Tell whether FEC is enabled or not.

The FEC is enbaled whether a FEC stream is found.

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

string Linphone.CallParams.FromHeader

getset

Get the from header in the CallParams.

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

Linphone.AudioDevice Linphone.CallParams.InputAudioDevice

getset

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.InputAudioDevice when call has been created.

Returns: the Linphone.AudioDevice that will be used by default as input when the call will be created

bool Linphone.CallParams.IsCapabilityNegotiationReinviteEnabled

get

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

Returns: true if capability negotiation reINVITE is enabled; false otherwise.

Deprecated : 16/12/2021 Use Linphone.CallParams.CapabilityNegotiationReinviteEnabled() instead.

bool Linphone.CallParams.IsRecording

get

Indicates whether the call is being recorded.

Returns: true if the call is being recorded, false otherwise.

bool Linphone.CallParams.IsValid

get

Check if call parameters are valid.

Returns: true if the parameters are valid; false otherwise.

bool Linphone.CallParams.LocalConferenceMode

get

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.

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

bool Linphone.CallParams.LowBandwidthEnabled

getset

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.CallParams.EnableLowBandwidth(). When enabled, this param may transform a call request with video in audio only mode.

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

Linphone.MediaEncryption Linphone.CallParams.MediaEncryption

getset

Get the kind of media encryption selected for the call.

Returns: The kind of Linphone.MediaEncryption selected for the call.

bool Linphone.CallParams.MicEnabled

getset

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.MicrophoneMuted when call has been created.

Returns: true if the microphone will be enabled, false if disabled.

Linphone.AudioDevice Linphone.CallParams.OutputAudioDevice

getset

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.OutputAudioDevice when call has been created.

Returns: the Linphone.AudioDevice that will be used by default as output when the call will be created

uint Linphone.CallParams.Privacy

getset

Get requested level of privacy for the call.

Returns: The LinphonePrivacyMask used for the call.

Linphone.ProxyConfig Linphone.CallParams.ProxyConfig

getset

Get the Linphone.ProxyConfig that is used for the call.

Returns: The selected Linphone.ProxyConfig for the call, or null if none has been selected.

Deprecated : 28/02/2021 Use Linphone.CallParams.Account instead.

bool Linphone.CallParams.RealtimeTextEnabled

getset

Use to get real time text following rfc4103.

Returns: returns true if call rtt is activated.

uint Linphone.CallParams.RealtimeTextKeepaliveInterval

getset

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

Returns: returns keep alive interval of real time text.

float Linphone.CallParams.ReceivedFramerate

get

Get the framerate of the video that is received.

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

Linphone.VideoDefinition Linphone.CallParams.ReceivedVideoDefinition

get

Get the definition of the received video.

Returns: The received Linphone.VideoDefinition or null.

string Linphone.CallParams.RecordFile

getset

Get the path for the audio recording of the call.

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

bool Linphone.CallParams.RtpBundleEnabled

getset

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

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

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

string Linphone.CallParams.RtpProfile

get

Get the RTP profile being used.

Returns: The RTP profile.

bool Linphone.CallParams.ScreenSharingEnabled

getset

Tell whether screen sharing is enabled or not.

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

float Linphone.CallParams.SentFramerate

get

Get the framerate of the video that is sent.

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

Linphone.VideoDefinition Linphone.CallParams.SentVideoDefinition

get

Get the definition of the sent video.

Returns: The sent Linphone.VideoDefinition or null.

string Linphone.CallParams.SessionName

getset

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

Subject from the SIP message can be retrieved using Linphone.CallParams.CustomHeader and is different.

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

bool Linphone.CallParams.TcapLineMergingEnabled

set

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

Parameters

enabled A boolean value telling whether to merge tcap lines

bool Linphone.CallParams.ToneIndicationsEnabled

getset

Check if tone indications are enabled.

Returns: true if tone indications are enabled; false otherwise.

Linphone.PayloadType Linphone.CallParams.UsedAudioPayloadType

get

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

Returns: The selected Linphone.PayloadType. null is returned if no audio payload type has been selected by the call.

Linphone.PayloadType Linphone.CallParams.UsedTextPayloadType

get

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

Returns: The selected Linphone.PayloadType. null is returned if no text payload type has been selected by the call.

Linphone.PayloadType Linphone.CallParams.UsedVideoPayloadType

get

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

Returns: The selected Linphone.PayloadType. null is returned if no video payload type has been selected by the call.

Linphone.MediaDirection Linphone.CallParams.VideoDirection

getset

Get the video stream direction.

Returns: The video stream Linphone.MediaDirection associated with the call params.

bool Linphone.CallParams.VideoEnabled

getset

Tell whether video is enabled or not.

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

bool Linphone.CallParams.VideoMulticastEnabled

getset

Use to get multicast state of video stream.

Returns: true if subsequent calls will propose multicast ip set by Linphone.Core.VideoMulticastAddr

The documentation for this class was generated from the following file:

LinphoneWrapper.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation