Class AptXDecoderBlock

Namespace

VisioForge.Core.MediaBlocks.AudioEncoders

Assembly

VisioForge.Core.dll

MediaBlock that decodes AptX compressed audio streams into raw PCM audio. AptX is a psychoacoustic audio codec algorithm that provides CD-like audio quality with low latency, making it ideal for wireless audio reception over Bluetooth. This decoder handles AptX bitstreams and outputs high-quality stereo PCM audio. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class AptXDecoderBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

object

MediaBlock

AptXDecoderBlock

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

AptXDecoderBlock(AptXDecoderSettings)

Initializes a new instance of the VisioForge.Core.MediaBlocks.AudioEncoders.AptXDecoderBlock class with the specified decoding settings.

public AptXDecoderBlock(AptXDecoderSettings settings)

Parameters

settings AptXDecoderSettings

The AptX decoder settings that define decoding parameters and behavior.

Properties

Input

Gets the single audio input pad for this decoder block.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets all input pads for this decoder block.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the single audio output pad for this decoder block.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets all output pads for this decoder block.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Settings

Gets the decoder settings for this AptX decoder block.

public AptXDecoderSettings Settings { get; }

Property Value

AptXDecoderSettings

Type

Gets the MediaBlock type identifier for this decoder.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the AptX decoder and its associated GStreamer elements. This method creates the decoder with the specified settings, establishes input and output pads, and prepares the block for high-quality Bluetooth audio decoding.

public override bool Build()

Returns

bool

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

CleanUp()

Releases all resources and performs cleanup operations for this AptX decoder block. This method disposes of GStreamer elements, releases memory, and ensures proper shutdown of the block. Called automatically during pipeline teardown.

public void CleanUp()

Dispose(bool)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Properly disposes of the GStreamer AptX decoder element and associated 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 AptX decoder element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer AptX decoder.

GetElement()

Gets the underlying GStreamer element that performs the AptX audio decoding.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the AptX decoder.

IsAvailable(AptXDecoderSettings)

Determines whether AptX decoding is available with the specified settings. Checks for the presence of the GStreamer openaptxdec plugin.

public static bool IsAvailable(AptXDecoderSettings settings)

Parameters

settings AptXDecoderSettings

The AptX decoder settings to validate.

Returns

bool

true if AptX decoding is available; otherwise, false.

SetContext(MediaBlocksPipeline)

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

public void SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The MediaBlocksPipeline instance that will manage this block.

See Also

MediaBlock

IMediaBlockInternals

IDisposable