Table of Contents

Class VorbisEncoderSettings

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

Vorbis encoder settings.

public class VorbisEncoderSettings : IAudioEncoder, IMediaBlockSettings, IEncoderTextInfo

Inheritance

Implements

Inherited Members

Remarks

Supported formats: F32LE. Supported sample rates: [1..200000]. Supported channels: [1..9].

Fields

Name

The name.

public static string Name

Field Value

string

Properties

Bitrate

Gets or sets the target bitrate in kilobits per second (Kbps). Attempts to encode at a bitrate averaging this value. This uses the bitrate management engine. Using the Quality property is recommended for most users instead of bitrate.

public int Bitrate { get; set; }

Property Value

int

Remarks

The encoder will convert this value to bits per second internally.

MaxBitrate

Gets or sets the maximum bitrate in kilobits per second (Kbps). Useful for streaming applications to cap the maximum bandwidth.

public int MaxBitrate { get; set; }

Property Value

int

Remarks

The encoder will convert this value to bits per second internally.

MinBitrate

Gets or sets the minimum bitrate in kilobits per second (Kbps). Useful for encoding for a fixed-size channel to guarantee minimum quality.

public int MinBitrate { get; set; }

Property Value

int

Remarks

The encoder will convert this value to bits per second internally.

Quality

Gets or sets the quality instead of specifying a particular bitrate. -1 = lowest, 10 = highest.

public int Quality { get; set; }

Property Value

int

RateControl

Gets or sets the rate control.

public VorbisEncoderRateControl RateControl { get; set; }

Property Value

VorbisEncoderRateControl

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.

GetSupportedBitrates()

Gets the supported bitrates.

public int[] GetSupportedBitrates()

Returns

int[]

System.Int32[].

GetSupportedChannelCounts()

Gets the supported channel counts.

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