Table of Contents

Class CompressorExpanderBlock

Namespace
VisioForge.Core.MediaBlocks.AudioProcessing
Assembly
VisioForge.Core.dll

Audio compressor/expander block for dynamic range control and audio level management. This block provides professional-grade dynamic range processing including compression to reduce dynamic range and expansion to increase it. Features configurable ratio, threshold, attack/release times, and soft/hard knee characteristics. Essential for audio mastering, broadcast normalization, voice processing, and maintaining consistent audio levels in multimedia applications. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class CompressorExpanderBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

CompressorExpanderBlock()

Initializes a new instance of the VisioForge.Core.MediaBlocks.AudioProcessing.CompressorExpanderBlock class with default settings for dynamic range processing.

public CompressorExpanderBlock()

Properties

Characteristics

Gets or sets the knee characteristics for the compression/expansion curve. Soft-knee provides gradual transition around the threshold for transparent processing, while hard-knee creates an abrupt transition for more aggressive dynamics control. Default: HardKnee.

public AudioDynamicCharacteristics Characteristics { get; set; }

Property Value

AudioDynamicCharacteristics

Input

Gets the input.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets the inputs.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Mode

Gets or sets the dynamic range processing mode. Compressor mode reduces dynamic range by making loud sounds quieter, while expander mode increases dynamic range by making quiet sounds quieter. Default: Compressor.

public AudioCompressorMode Mode { get; set; }

Property Value

AudioCompressorMode

Output

Gets the output.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets the outputs.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Ratio

Gets or sets the compression/expansion ratio. For compression: Values greater than 1 reduce dynamic range (e.g., 4:1 means 4dB input change results in 1dB output change). For expansion: Values control how much quieter signals become. Default: 1 (no compression/expansion).

public float Ratio { get; set; }

Property Value

float

Threshold

Gets or sets the threshold level in dB where dynamic processing begins. Signals above this level are affected by compression, signals below by expansion. Typical values range from -60dB to 0dB. Default: 0dB.

public float Threshold { get; set; }

Property Value

float

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the compressor/expander filter and its associated GStreamer elements. This method creates the filter with the specified settings, establishes input and output pads, and prepares the block for dynamic range processing with configured ratio, threshold, and knee characteristics.

public override bool Build()

Returns

bool

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

CleanUp()

Releases all resources and performs cleanup operations for this compressor/expander filter 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 compressor/expander filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer compressor/expander filter.

GetElement()

Gets the underlying GStreamer element that performs the dynamic range processing.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the compressor/expander filter.

IsAvailable()

Determines whether this media block is available. Correct NuGet SDK redist should be included into your project.

public static bool IsAvailable()

Returns

bool

true if this media block is available; otherwise, false.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Associates this compressor/expander filter 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