Table of Contents

Class OPUSEncoderSettings

Namespace
VisioForge.Core.Types.X.AudioEncoders
Assembly
VisioForge.Core.dll

OPUS encoder settings.

public class OPUSEncoderSettings : IAudioEncoder, IMediaBlockSettings, IEncoderTextInfo

Inheritance

Implements

Inherited Members

Remarks

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

Fields

Name

The name.

public static string Name

Field Value

string

Properties

AudioType

Gets or sets the type of the audio.

public OPUSAudioType AudioType { get; set; }

Property Value

OPUSAudioType

Bandwidth

Gets or sets the bandwidth.

public OPUSBandwidth Bandwidth { get; set; }

Property Value

OPUSBandwidth

Bitrate

Gets or sets the encoding bit-rate in kilobits per second (Kbps). Valid range: 6-510 Kbps. Default is 64 Kbps.

public int Bitrate { get; set; }

Property Value

int

Remarks

Common bitrates: 8, 16, 32, 64, 96, 128, 192, 510 Kbps. The encoder will convert this value to bits per second internally.

Complexity

Gets or sets the complexity.

public int Complexity { get; set; }

Property Value

int

DTX

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

public bool DTX { get; set; }

Property Value

bool

FrameSize

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

public OPUSFrameSize FrameSize { get; set; }

Property Value

OPUSFrameSize

InBandFEC

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

public bool InBandFEC { get; set; }

Property Value

bool

MaxPayloadSize

Gets or sets the maximum payload size in bytes.

public uint MaxPayloadSize { get; set; }

Property Value

uint

PacketLossPercentage

Gets or sets the packet loss percentage.

public int PacketLossPercentage { get; set; }

Property Value

int

RateControl

Gets or sets the rate control.

public OPUSRateControl RateControl { get; set; }

Property Value

OPUSRateControl

Methods

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

GetCaps()

Gets the caps.

public string GetCaps()

Returns

string

System.String.

GetParameters()

Gets the parameters as string.

public string GetParameters()

Returns

string

System.String.

GetRateControlList()

Gets the rate control list.

public static IEnumerable<string> GetRateControlList()

Returns

IEnumerable<string>

IEnumerable<System.String>.

GetSupportedBitrates()

Gets the supported bitrates.

public int[] GetSupportedBitrates()

Returns

int[]

System.Int32[].

GetSupportedChannelCounts()

Gets the supported channel counts range.

public int[] GetSupportedChannelCounts()

Returns

int[]

System.Int32[].

GetSupportedSampleRates()

Gets the supported sample rates.

public int[] GetSupportedSampleRates()

Returns

int[]

System.Int32[].

IsAvailable()

Determines whether this encoder is available.

public static bool IsAvailable()

Returns

bool

true if this encoder is available; otherwise, false.

ToString()

Returns a String that represents this instance.

public override string ToString()

Returns

string

A String that represents this instance.

See Also