SpeechEncoder Class

SpeechEncoder Class

SpeechEncoder handles the encoding of speech audio frames.

Inheritance Hierarchy

SystemObject
StreamCoders.EncoderSpeechEncoder

Namespace: StreamCoders.Encoder
Assembly: MediaSuite (in MediaSuite.dll) Version: 2.0.5.0 (2.0.5.0)

Syntax

public class SpeechEncoder : ISpeechEncoder, 
	IDisposable

Public Class SpeechEncoder
	Implements ISpeechEncoder, IDisposable

public ref class SpeechEncoder : ISpeechEncoder, 
	IDisposable

type SpeechEncoder =  
    class
        interface ISpeechEncoder
        interface IDisposable
    end

The SpeechEncoder type exposes the following members.

Constructors

	Name	Description
	SpeechEncoder	Default constructor.

Properties

	Name	Description
	CompatibilityMode	Gets the Compatibility Mode.
	InputBitsPerSample	Set the size of each sample in bits of the input stream. Default: 16.
	InputChannels	Set the number of channels the input PCM stream contains. If the channels are greater than 1, then the channels will be merged.
	InputSampleRate	Gets or sets the input sample rate of the PCM stream. In all cases it must be a valid samplerate used by the selected codec.
	MaximumInputDataLength	Set/Get the maximum size of the input data in bytes that can be encoded at once.
	OutputBitrate	Gets or sets the output bitrate of the codec. Default: 64000.
	PacketDuration	Set/Get maximum packet duration. After calling SetCodec the PacketDuration will have it's default value depending on the codec selected.
	PayloadType	Set/Get Payload Type of produced RTP packets.
	StreamType	Gets or sets or Sets the StreamType property.

Methods

	Name	Description
	Dispose	Destructor.
	EncodeToBuffer	Encodes an array of PCM data to the selected codec and stores it in a byte array. Note: The size of the input data is dependent on the value of MaximumInputDataLength
	EncodeToFrame	Encodes an array of PCM data to the selected codec and stores it in an RTP Frame. Note: The size of the input data is dependent on the value of MaximumInputDataLength
	GetCodec	Gets the codec.
	Init	Initializes the SpeechEncoder.
	SetCodec	Sets the Codec the data will be encoded to. This function also set the correct packet duration for the codec.

Extension Methods

	Name	Description
	Copy	Overloaded. Creates a copy of the object. (Defined by ObjectExtensions.)
	Copy(Object)	Overloaded. Creates a deep copy of the object using the supplied object as a target for the copy operation. (Defined by ObjectExtensions.)

Remarks

SpeechEncoder handles 16-bit sample sizes and 1 channel.

Supported codecs are:

SpeechEncoder is able to produce raw and RTP streams.