Class MP3EncoderSettings

MP3 encoder settings.

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

Supported formats: S16LE. Supported sample rates: 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000. Supported channels: 1, 2.

Fields

Name

The name.

Declaration
public static string Name
Field Value
Type Description
string

Properties

Bitrate

Gets or sets the bitrate. Bitrate in Kbit/s.

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

Only valid if target is bitrate, for CBR one of 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256 or 320.

EncodingEngineQuality

Gets or sets the encoding engine quality/speed of the encoding engine, this does not affect the bitrate!.

Declaration
public MP3EncodingQuality EncodingEngineQuality { get; set; }
Property Value
Type Description
MP3EncodingQuality

The encoding engine quality.

ForceMono

Gets or sets a value indicating whether mono output will be used.

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

true if force mono; otherwise, false.

Quality

Gets or sets the VBR Quality from 0 to 10. 0 being the best (Only valid if target is quality).

Declaration
public float Quality { get; set; }
Property Value
Type Description
float

The quality.

RateControl

Gets or sets the rate control.

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

The rate control.

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.
Exceptions
Type Condition
ArgumentOutOfRangeException

GetQualityList()

Gets the quality list.

Declaration
public static IEnumerable<string> GetQualityList()
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.

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