Class SpeexEncoderSettings

Speex encoder settings. Implements the IAudioEncoder.

Inheritance

object

SpeexEncoderSettings

Implements

IAudioEncoder

IMediaBlockSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VisioForge.Core.Types.X.AudioEncoders

Assembly: VisioForge.Core.dll

Syntax

public class SpeexEncoderSettings : IAudioEncoder, IMediaBlockSettings

Fields

Name

The name.

Declaration

public static string Name

Field Value

Type	Description
string

Properties

ABR

Gets or sets the average bitrate (0 = disabled).

Declaration

public float ABR { get; set; }

Property Value

Type	Description
float

Bitrate

Gets or sets the encoding bit-rate (in bps). (0 = automatic).

Declaration

public float Bitrate { get; set; }

Property Value

Type	Description
float

Channels

Gets or sets the channels. Supported values are 1, 2.

Declaration

public int Channels { get; set; }

Property Value

Type	Description
int	The channels.

Complexity

Gets or sets the encoding complexity.

Declaration

public int Complexity { get; set; }

Property Value

Type	Description
int

DTX

Gets or sets a value indicating whether to enable discontinuous transmission.

Declaration

public bool DTX { get; set; }

Property Value

Type	Description
bool

Mode

Gets or sets the mode.

Declaration

public SpeexEncoderMode Mode { get; set; }

Property Value

Type	Description
SpeexEncoderMode

NFrames

Gets or sets the number of frames per buffer.

Declaration

public int NFrames { get; set; }

Property Value

Type	Description
int

Quality

Gets or sets the quality. [0..10].

Declaration

public float Quality { get; set; }

Property Value

Type	Description
float

SampleRate

Gets or sets the sample rate. Supported values are 8000, 16000, 32000.

Declaration

public int SampleRate { get; set; }

Property Value

Type	Description
int	The sample rate.

VAD

Gets or sets a value indicating whether to enable voice activity detection.

Declaration

public bool VAD { get; set; }

Property Value

Type	Description
bool

VBR

Gets or sets a value indicating whether to enable variable bitrate.

Declaration

public bool VBR { get; set; }

Property Value

Type	Description
bool

Methods

CreateBlock()

Creates the block.

Declaration

public MediaBlock CreateBlock()

Returns

Type	Description
MediaBlock	MediaBlock.

GetModes()

Gets the mode list.

Declaration

public static IEnumerable<string> GetModes()

Returns

Type	Description
IEnumerable<string>	IEnumerable<System.String>.

GetSupportedBitrates()

Gets the supported bitrates. Use GetSupportedBitratesFloat for the correct float values. Ignore this method.

Declaration

public int[] GetSupportedBitrates()

Returns

Type	Description
int[]	System.Int32[].

GetSupportedBitratesFloat()

Gets the bitrate list.

Declaration

public float[] GetSupportedBitratesFloat()

Returns

Type	Description
float[]	float.

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

See Also

IAudioEncoder