Table of Contents

Class ADPCMEncoderBlock

Namespace
VisioForge.Core.MediaBlocks.AudioEncoders
Assembly
VisioForge.Core.dll

MediaBlock that encodes raw audio into ADPCM (Adaptive Differential Pulse Code Modulation) format. ADPCM is a lossy audio compression technique that reduces file size while maintaining reasonable quality, commonly used in telecommunications and embedded systems. This block supports configurable block alignment for optimized encoding performance. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class ADPCMEncoderBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

ADPCMEncoderBlock(int)

Initializes a new instance of the VisioForge.Core.MediaBlocks.AudioEncoders.ADPCMEncoderBlock class.

public ADPCMEncoderBlock(int blockAlign = 1024)

Parameters

blockAlign int

The block alignment value for ADPCM encoding. Controls the size of audio blocks processed during encoding.

Properties

BlockAlign

Gets or sets the block alignment value for ADPCM encoding. This parameter controls the size of audio blocks processed during encoding, affecting both compression efficiency and processing latency. Larger values typically provide better compression but may increase latency.

public int BlockAlign { get; set; }

Property Value

int

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[]

Type

Gets the MediaBlock type identifier for this encoder.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the ADPCM encoder and its associated GStreamer elements. This method creates the encoder with the specified block alignment settings, establishes input and output pads, and prepares the block for media processing.

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 ADPCM 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 ADPCM encoder element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer ADPCM encoder.

GetElement()

Gets the underlying GStreamer element that performs the ADPCM encoding.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the ADPCM encoder.

IsAvailable()

Determines whether the ADPCM encoder is available on the current system. This checks if the required GStreamer ADPCM 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 ADPCM encoder is available and can be used; otherwise, false.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Associates this ADPCM 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