Class PayloadType
Object representing an RTP payload type.
Inherited Members
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class PayloadType : LinphoneObject
Properties
Channels
Get the number of channels.
Declaration
public int Channels { get; }
Property Value
Type | Description |
---|---|
System.Int32 | The number of channels. |
ClockRate
Get the clock rate of a payload type.
Declaration
public int ClockRate { get; }
Property Value
Type | Description |
---|---|
System.Int32 | The clock rate in Hz. |
Description
Return a string describing a payload type.
The format of the string is <mime_type>/<clock_rate>/<channels>.
Declaration
public string Description { get; }
Property Value
Type | Description |
---|---|
System.String | The description of the payload type. Must be release after use. |
EncoderDescription
Get a description of the encoder used to provide a payload type.
Declaration
public string EncoderDescription { get; }
Property Value
Type | Description |
---|---|
System.String | The description of the encoder. Can be null if the payload type is not supported by Mediastreamer2. |
IsUsable
Check whether the payload is usable according the bandwidth targets set in the core.
Declaration
public bool IsUsable { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the payload type is usable. |
IsVbr
Tells whether the specified payload type represents a variable bitrate codec.
Declaration
public bool IsVbr { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the payload type represents a VBR codec, false instead. |
MimeType
Get the mime type.
Declaration
public string MimeType { get; }
Property Value
Type | Description |
---|---|
System.String | The mime type. |
NormalBitrate
Get the normal bitrate in bits/s.
Declaration
public int NormalBitrate { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The normal bitrate in bits/s or -1 if an error has occured. |
Number
Returns the payload type number assigned for this codec.
Declaration
public int Number { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The number of the payload type. |
RecvFmtp
Get the format parameters for incoming streams.
Declaration
public string RecvFmtp { get; set; }
Property Value
Type | Description |
---|---|
System.String | The format parameters as string. |
SendFmtp
Get the format parameters for outgoing streams.
Declaration
public string SendFmtp { get; set; }
Property Value
Type | Description |
---|---|
System.String | The format parameters as string. |
Type
Get the type of a payload type.
Declaration
public int Type { get; }
Property Value
Type | Description |
---|---|
System.Int32 | The type of the payload e.g. PAYLOAD_AUDIO_CONTINUOUS or PAYLOAD_VIDEO. |
Methods
Clone()
Instantiates a new payload type with values from source.
Declaration
public PayloadType Clone()
Returns
Type | Description |
---|---|
PayloadType | The newly created PayloadType object. |
Enable(Boolean)
Enable/disable a payload type.
Declaration
public int Enable(bool enabled)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enabled | Set true for enabling and false for disabling. |
Returns
Type | Description |
---|---|
System.Int32 | 0 for success, -1 for failure. |
Enabled()
Check whether a palyoad type is enabled.
Declaration
public bool Enabled()
Returns
Type | Description |
---|---|
System.Boolean | true if enabled, false if disabled. |