Class SpeexEncoderBlock

Namespace

VisioForge.Core.MediaBlocks.AudioEncoders

Assembly

VisioForge.Core.dll

MediaBlock that encodes raw audio into Speex format. Speex is an open-source speech codec specifically designed for voice over IP (VoIP) applications and speech compression. It provides excellent compression for human speech while maintaining good quality at very low bitrates. The codec features variable bitrate encoding, noise suppression, echo cancellation, and is particularly well-suited for real-time voice communication systems, internet telephony, and voice recording applications. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class SpeexEncoderBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

object

MediaBlock

SpeexEncoderBlock

Implements

IMediaBlock

IDisposable

IMediaBlockInternals

Inherited Members

MediaBlock._isBuilt

MediaBlock._pipeline

MediaBlock._pipelineCtx

MediaBlock.GetPipelineContext()

MediaBlock.SetPipelineContext(BlockPipelineContext)

MediaBlock.SetPipeline(MediaBlocksPipeline)

MediaBlock.Context

MediaBlock.Name

MediaBlock.IsBuilt

MediaBlock.Owner

MediaBlock.Type

MediaBlock.ID

MediaBlock.Input

MediaBlock.Inputs

MediaBlock.Output

MediaBlock.Outputs

MediaBlock.HasInputs

MediaBlock.HasOutputs

MediaBlock.Build()

MediaBlock.CreateElements()

MediaBlock.AddElementsToPipeline()

MediaBlock.RemoveElementsFromPipeline()

MediaBlock.DeepCopy(string)

MediaBlock.Reset()

MediaBlock.ToYAMLBlock()

MediaBlock.ClearPads()

MediaBlock.Dispose(bool)

MediaBlock.Dispose()

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Extension Methods

MediaBlockExtensions.GetInputPadByType(IMediaBlock, MediaBlockPadMediaType)

MediaBlockExtensions.GetOutputPadByType(IMediaBlock, MediaBlockPadMediaType)

MediaBlockHelper.SendEndOfStream(MediaBlock)

MediaBlockHelper.SendEvent(MediaBlock, Event)

MediaBlockHelper.SetState(MediaBlock, State)

Constructors

SpeexEncoderBlock(SpeexEncoderSettings)

Initializes a new instance of the VisioForge.Core.MediaBlocks.AudioEncoders.SpeexEncoderBlock class with the specified speech encoding settings.

public SpeexEncoderBlock(SpeexEncoderSettings settings)

Parameters

settings SpeexEncoderSettings

The SpeexEncoderSettings that define quality, bitrate, and VoIP optimization for speech compression.

Properties

Input

Gets the single audio input pad for this encoder block.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets all input pads for this encoder block.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the single audio output pad for this encoder block.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets all output pads for this encoder block.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Settings

Gets or sets the Speex encoder settings that control speech compression quality and VoIP optimization. These settings include bitrate mode, quality level, complexity, and voice activity detection parameters optimized for speech encoding and real-time communication requirements.

public SpeexEncoderSettings Settings { get; set; }

Property Value

SpeexEncoderSettings

Type

Gets the MediaBlock type identifier for this encoder.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the Speex encoder and its associated GStreamer elements. This method creates the encoder with the specified settings, establishes input and output pads, and prepares the block for high-quality speech encoding optimized for VoIP applications.

public override bool Build()

Returns

bool

true if the encoder was successfully built and configured; false if initialization failed.

CleanUp()

Releases all resources and performs cleanup operations for this Speex encoder block. This method disposes of the GStreamer elements and resets the build state.

public void CleanUp()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetCore()

Gets the core BaseElement wrapper that provides additional functionality around the GStreamer Speex encoder element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer Speex encoder.

GetElement()

Gets the underlying GStreamer element that performs the Speex speech encoding.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the Speex encoder.

IsAvailable()

Determines whether the Speex encoder is available on the current system. This checks if the required GStreamer Speex encoder plugin is installed and accessible. The correct NuGet SDK redistribution package should be included in your project.

public static bool IsAvailable()

Returns

bool

true if the Speex encoder is available and can be used; otherwise, false.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Associates this Speex encoder block with a pipeline and initializes its internal context. This method is called internally when the block is added to a pipeline.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The MediaBlocksPipeline instance that will manage this block.

See Also

MediaBlock

IMediaBlockInternals

IDisposable