Table of Contents

Class SpeexEncoderSettings

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

Speex encoder settings. Implements the VisioForge.Core.Types.X.Output.IAudioEncoder.

public class SpeexEncoderSettings : IAudioEncoder, IMediaBlockSettings

Inheritance

Implements

Inherited Members

Fields

Name

The name.

public static string Name

Field Value

string

Properties

ABR

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

public float ABR { get; set; }

Property Value

float

Bitrate

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

public float Bitrate { get; set; }

Property Value

float

Channels

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

public int Channels { get; set; }

Property Value

int

Complexity

Gets or sets the encoding complexity.

public int Complexity { get; set; }

Property Value

int

DTX

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

public bool DTX { get; set; }

Property Value

bool

Mode

Gets or sets the mode.

public SpeexEncoderMode Mode { get; set; }

Property Value

SpeexEncoderMode

NFrames

Gets or sets the number of frames per buffer.

public int NFrames { get; set; }

Property Value

int

Quality

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

public float Quality { get; set; }

Property Value

float

SampleRate

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

public int SampleRate { get; set; }

Property Value

int

VAD

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

public bool VAD { get; set; }

Property Value

bool

VBR

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

public bool VBR { get; set; }

Property Value

bool

Methods

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

GetModes()

Gets the mode list.

public static IEnumerable<string> GetModes()

Returns

IEnumerable<string>

IEnumerable<System.String>.

GetSupportedBitrates()

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

public int[] GetSupportedBitrates()

Returns

int[]

System.Int32[].

GetSupportedBitratesFloat()

Gets the bitrate list.

public float[] GetSupportedBitratesFloat()

Returns

float[]

float.

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