Table of Contents

Class KaraokeAudioEffect

Namespace
VisioForge.Core.Types.X.AudioEffects
Assembly
VisioForge.Core.dll

Karaoke effect removes or reduces center-panned vocals from stereo audio by filtering the center channel. Uses the GStreamer 'audiokaraoke' element to analyze and suppress mono (center) content. Useful for vocal removal, karaoke track creation, or isolating background music.

public class KaraokeAudioEffect : BaseAudioEffect, ISharedAudioEffectX, IVideoEditXAudioEffect

Inheritance

Implements

Inherited Members

Remarks

GStreamer element: audiokaraoke Properties:

  • level: Overall effect strength (0.0 to 1.0, where 1.0 = maximum vocal removal)
  • mono-level: Suppression level for mono/center content (0.0 to 1.0)
  • filter-band: Center frequency of the filter band in Hz (typically 100-400 Hz)
  • filter-width: Width of the frequency band to process in Hz

The effect works by:

  1. Identifying content that's identical in left and right channels (center-panned)
  2. Applying frequency-selective filtering to target vocal ranges
  3. Reducing or removing the identified center content

Works best on:

  • Studio recordings with center-panned vocals
  • Professional mixes with clear stereo separation

Less effective on:

  • Live recordings
  • Mono or pseudo-stereo sources
  • Vocals with heavy stereo processing

Constructors

KaraokeAudioEffect()

Initializes a new instance of the VisioForge.Core.Types.X.AudioEffects.KaraokeAudioEffect class.

public KaraokeAudioEffect()

Properties

FilterBand

Gets or sets the center frequency of the filter band. This defines the frequency range where vocal removal is most effective. Range: Typically 100-400 Hz. Default: 220 Hz (middle of typical vocal fundamental range). Lower values target deeper voices, higher values target higher voices.

public float FilterBand { get; set; }

Property Value

float

FilterWidth

Gets or sets the width of the frequency band to filter. This determines how wide a frequency range around FilterBand will be affected. Range: Typically 50-200 Hz. Default: 100 Hz. Wider bands remove more frequency content but may affect instruments. Narrower bands are more selective but may miss some vocal content.

public float FilterWidth { get; set; }

Property Value

float

Level

Gets or sets the overall level of the karaoke effect. Controls how strongly center-panned content is suppressed. Range: 0.0 (no effect) to 1.0 (maximum suppression). Default: 1.0. Lower values (0.3-0.6) reduce vocals subtly. Higher values (0.8-1.0) attempt complete vocal removal.

public float Level { get; set; }

Property Value

float

MonoLevel

Gets or sets the suppression level for mono/center channel content. Specifically targets audio that appears identically in both stereo channels. Range: 0.0 (no suppression) to 1.0 (complete suppression). Default: 1.0. This is the primary control for vocal removal strength.

public float MonoLevel { get; set; }

Property Value

float

Methods

GenerateDescription()

Generates the description.

public string GenerateDescription()

Returns

string

A string representation of the audio effect parameters.