Table of Contents

Class KaraokeBlock

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

Karaoke audio effect block that removes or reduces center-panned vocals from stereo audio. This block uses advanced audio processing techniques to isolate and suppress vocal content that is typically recorded in the center of the stereo image. Features configurable filtering levels and frequency ranges to optimize vocal removal for different music types. Essential for karaoke applications, vocal isolation, instrumental track creation, and audio remixing. Works best with well-mixed stereo recordings where vocals are center-panned. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class KaraokeBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

KaraokeBlock(KaraokeAudioEffect)

Initializes a new instance of the VisioForge.Core.MediaBlocks.AudioProcessing.KaraokeBlock class with specified karaoke effect settings for vocal removal.

public KaraokeBlock(KaraokeAudioEffect settings)

Parameters

settings KaraokeAudioEffect

The karaoke effect settings controlling vocal removal parameters.

Properties

Input

Gets the input.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets the inputs.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the output.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets the outputs.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Settings

Gets or sets the karaoke effect settings that control vocal removal parameters. Includes settings for filter level, frequency range, and processing mode to optimize vocal suppression for different types of audio content.

public KaraokeAudioEffect Settings { get; set; }

Property Value

KaraokeAudioEffect

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the karaoke filter and its associated GStreamer elements. This method creates the filter with the specified karaoke settings, establishes input and output pads, and prepares the block for removing or reducing center-panned vocals from stereo audio streams.

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 karaoke effect 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 karaoke filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer karaoke filter.

GetElement()

Gets the underlying GStreamer element that performs the karaoke vocal removal processing.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the karaoke 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 karaoke effect 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