Linphone.PayloadType Class Reference

Inheritance diagram for Linphone.PayloadType:

Public Member Functions
Linphone.PayloadType	Clone ()
int	Enable (bool enabled)
bool	Enabled ()
bool	WeakEquals (Linphone.PayloadType otherPayloadType)

Properties
int	Channels [get]
int	ClockRate [get]
string	Description [get]
string	EncoderDescription [get]
bool	IsUsable [get]
bool	IsVbr [get]
string	MimeType [get]
int	NormalBitrate [get, set]
int	Number [get, set]
string	RecvFmtp [get, set]
string	SendFmtp [get, set]
int	Type [get]

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

Object representing an RTP payload type.

Member Function Documentation

Linphone.PayloadType Linphone.PayloadType.Clone ( )

inline

Instantiates a new payload type with values from source.

Returns

The newly created Linphone.PayloadType object.

int Linphone.PayloadType.Enable ( bool  enabled )

inline

Enable/disable a payload type.

Parameters

enabled

Set true for enabling and false for disabling.

Returns

0 for success, -1 for failure.

bool Linphone.PayloadType.Enabled ( )

inline

Check whether a palyoad type is enabled.

Returns

true if enabled, false if disabled.

bool Linphone.PayloadType.WeakEquals ( Linphone.PayloadType  otherPayloadType )

inline

Compare two payload types, and returns true if they are equal.

Parameters (fmtp strings) are not compared, hence the name 'weak equals'.

Parameters

otherPayloadType

another Linphone.PayloadType object

Returns

true if the payload types are "almost" equals.

Property Documentation

int Linphone.PayloadType.Channels

get

Get the number of channels.

Returns

The number of channels.

int Linphone.PayloadType.ClockRate

get

Get the clock rate of a payload type.

Returns

The clock rate in Hz.

string Linphone.PayloadType.Description

get

Return a string describing a payload type.

The format of the string is <mime_type>/<clock_rate>/<channels>.

Returns

The description of the payload type.

string Linphone.PayloadType.EncoderDescription

get

Get a description of the encoder used to provide a payload type.

Returns

The description of the encoder. Can be null if the payload type is not supported by Mediastreamer2.

bool Linphone.PayloadType.IsUsable

get

Check whether the payload is usable according the bandwidth targets set in the core.

Returns

true if the payload type is usable.

bool Linphone.PayloadType.IsVbr

get

Tells whether the specified payload type represents a variable bitrate codec.

Returns

true if the payload type represents a VBR codec, false instead.

string Linphone.PayloadType.MimeType

get

Get the mime type.

Returns

The mime type.

int Linphone.PayloadType.NormalBitrate

getset

Get the normal bitrate in bits/s.

Returns

The normal bitrate in bits/s or -1 if an error has occured.

int Linphone.PayloadType.Number

getset

Returns the payload type number assigned for this codec.

Returns

The number of the payload type.

string Linphone.PayloadType.RecvFmtp

getset

Get the format parameters for incoming streams.

Returns

The format parameters as string.

string Linphone.PayloadType.SendFmtp

getset

Get the format parameters for outgoing streams.

Returns

The format parameters as string.

int Linphone.PayloadType.Type

get

Get the type of a payload type.

Returns

The type of the payload e.g. PAYLOAD_AUDIO_CONTINUOUS or PAYLOAD_VIDEO.

---

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

• LinphoneWrapper.cs