Class OPUSEncoderSettings

OPUS encoder settings.

Inheritance
object
OPUSEncoderSettings
Implements
Inherited Members
Namespace: VisioForge.Core.Types.X.AudioEncoders
Assembly: VisioForge.Core.dll
Syntax
public class OPUSEncoderSettings : IAudioEncoder, IMediaBlockSettings, IEncoderTextInfo
Remarks

Supported formats: PCM S16LE. Supported sample rates: 8000, 12000, 16000, 24000, 48000. Supported channels: [1..8].

Fields

Name

The name.

Declaration
public static string Name
Field Value
Type Description
string

Properties

AudioType

Gets or sets the type of the audio.

Declaration
public OPUSAudioType AudioType { get; set; }
Property Value
Type Description
OPUSAudioType

Bandwidth

Gets or sets the bandwidth.

Declaration
public OPUSBandwidth Bandwidth { get; set; }
Property Value
Type Description
OPUSBandwidth

Bitrate

Gets or sets the encoding bit-rate (in Kbps).

Declaration
public int Bitrate { get; set; }
Property Value
Type Description
int

The bitrate.

Complexity

Gets or sets the complexity.

Declaration
public int Complexity { get; set; }
Property Value
Type Description
int

The complexity.

DTX

Gets or sets a value indicating whether DTX (Discontinuous Transmission) is enabled.

Declaration
public bool DTX { get; set; }
Property Value
Type Description
bool

FrameSize

Gets or sets the the duration of an audio frame, in ms.

Declaration
public OPUSFrameSize FrameSize { get; set; }
Property Value
Type Description
OPUSFrameSize

InBandFEC

Gets or sets a value indicating whether the forward error correction is enabled.

Declaration
public bool InBandFEC { get; set; }
Property Value
Type Description
bool

MaxPayloadSize

Gets or sets the maximum payload size in bytes.

Declaration
public uint MaxPayloadSize { get; set; }
Property Value
Type Description
uint

PacketLossPercentage

Gets or sets the packet loss percentage.

Declaration
public int PacketLossPercentage { get; set; }
Property Value
Type Description
int

The packet loss percentage.

RateControl

Gets or sets the rate control.

Declaration
public OPUSRateControl RateControl { get; set; }
Property Value
Type Description
OPUSRateControl

Methods

CreateBlock()

Creates the block.

Declaration
public MediaBlock CreateBlock()
Returns
Type Description
MediaBlock

MediaBlock.

GetCaps()

Gets the caps.

Declaration
public string GetCaps()
Returns
Type Description
string

System.String.

GetParameters()

Gets the parameters as string.

Declaration
public string GetParameters()
Returns
Type Description
string

System.String.

GetRateControlList()

Gets the rate control list.

Declaration
public static IEnumerable<string> GetRateControlList()
Returns
Type Description
IEnumerable<string>

IEnumerable<System.String>.

GetSupportedBitrates()

Gets the supported bitrates.

Declaration
public int[] GetSupportedBitrates()
Returns
Type Description
int[]

System.Int32[].

GetSupportedChannelCounts()

Gets the supported channel counts range.

Declaration
public int[] GetSupportedChannelCounts()
Returns
Type Description
int[]

System.Int32[].

GetSupportedSampleRates()

Gets the supported sample rates.

Declaration
public int[] GetSupportedSampleRates()
Returns
Type Description
int[]

System.Int32[].

IsAvailable()

Determines whether this encoder is available.

Declaration
public static bool IsAvailable()
Returns
Type Description
bool

true if this encoder is available; otherwise, false.

ToString()

Returns a string that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents this instance.
Overrides
object.ToString()

Implements

IAudioEncoder
IMediaBlockSettings
IEncoderTextInfo