Audio Effects API Reference¶

Video Capture SDK .Net Video Edit SDK .Net Media Blocks SDK .Net

Complete parameter reference for all audio effects available in VisioForge .NET SDKs. Each cross-platform effect wraps a GStreamer element and supports real-time parameter changes from C# code during playback. Cross-platform effects work on Windows, macOS, Linux, iOS, and Android.

For an overview of effect categories and usage patterns, see Audio Effects.

Volume and Dynamics Effects¶

VolumeAudioEffect¶

GStreamer Element: volume

Purpose: Control audio volume level with optional mute.

Parameters:

• Level (double): Volume multiplier
  • Range: 0.0 to unlimited
  • Default: 1.0 (100%)
  • Examples: 0.5 = 50%, 2.0 = 200%
• Mute (bool): Mute audio output
  • Default: false

Usage:

var effect = new VolumeAudioEffect(1.5); // 150% volume
effect.Mute = true; // Temporarily mute

AmplifyAudioEffect¶

GStreamer Element: audioamplify

Purpose: Amplify audio with clipping control.

Parameters:

• Level (double): Amplification level
  • Range: 1.0 to 10.0
  • Default: 1.0
• ClippingMethod (AmplifyClippingMethod): How to handle peaks
  • Options: Normal, HardClip, SoftClip
  • Default: Normal

Usage:

var effect = new AmplifyAudioEffect(2.0);
effect.ClippingMethod = AmplifyClippingMethod.SoftClip;

CompressorExpanderAudioEffect¶

GStreamer Element: audiodynamic

Purpose: Dynamic range compression or expansion.

Parameters:

• Threshold (double): Activation threshold
  • Range: 0.0 to 1.0
  • Default: 0.0
• Ratio (double): Compression/expansion ratio
  • Range: 1.0+
  • Default: 1.0
  • Typical: 2:1 to 10:1 for compression
• Mode (AudioCompressorMode): Compressor or Expander
  • Default: Compressor
• Characteristics (AudioDynamicCharacteristics): HardKnee or SoftKnee
  • Default: SoftKnee

Usage:

var effect = new CompressorExpanderAudioEffect();
effect.Threshold = 0.5;
effect.Ratio = 4.0; // 4:1 compression
effect.Characteristics = AudioDynamicCharacteristics.SoftKnee;

DynamicAmplifyAudioEffect¶

Purpose: Adaptive gain control.

Parameters:

• AttackTime (uint): Response time in ms
  • Typical: 10-100 ms
• MaxAmplification (uint): Maximum gain
  • 10000 = 1x (no change)
  • 20000 = 2x amplification
  • Default: 10000
• ReleaseTime (TimeSpan): Time before resuming amplification
  • Typical: 100-1000 ms

Usage:

var effect = new DynamicAmplifyAudioEffect(50, 20000, TimeSpan.FromMilliseconds(500));

Equalization Effects¶

Equalizer10AudioEffect¶

GStreamer Element: equalizer-10bands

Purpose: 10-band graphic equalizer with fixed frequencies.

Frequency Bands:

1. 29 Hz (Sub-bass)
2. 59 Hz (Bass)
3. 119 Hz (Bass)
4. 237 Hz (Low midrange)
5. 474 Hz (Midrange)
6. 947 Hz (Midrange)
7. 1889 Hz (Upper midrange)
8. 3770 Hz (Presence)
9. 7523 Hz (Brilliance)
10. 15011 Hz (Air)

Parameters:

• Levels (double[]): Gain for each band in dB
  • Range per band: -24 to +12 dB
  • Array must contain exactly 10 values

Usage:

var levels = new double[] {
    3.0,   // 29 Hz: +3 dB
    2.0,   // 59 Hz: +2 dB
    0.0,   // 119 Hz: 0 dB (no change)
    -2.0,  // 237 Hz: -2 dB
    0.0,   // 474 Hz
    0.0,   // 947 Hz
    1.0,   // 1889 Hz: +1 dB
    2.0,   // 3770 Hz: +2 dB
    3.0,   // 7523 Hz: +3 dB
    4.0    // 15011 Hz: +4 dB
};
var effect = new Equalizer10AudioEffect(levels);

EqualizerParametricAudioEffect¶

GStreamer Element: equalizer-nbands

Purpose: Parametric equalizer with configurable bands.

Parameters:

• Bands (ParametricEqualizerBand[]): Array of bands
  • Count: 1 to 64 bands
  • Each band: Frequency, Gain, Bandwidth (Q)

Usage:

var effect = new EqualizerParametricAudioEffect(3);
effect.Bands[0].Frequency = 100;  // Hz
effect.Bands[0].Gain = -6;        // dB
effect.Bands[0].Bandwidth = 1.0;  // Q factor
// Configure other bands...
effect.Update(); // Apply changes

TrebleEnhancerAudioEffect¶

Purpose: Boost high frequencies.

Parameters:

• Frequency (int): Starting frequency in Hz
  • Typical: 4000-8000 Hz
  • Frequencies above this are boosted
• Volume (ushort): Boost amount
  • Range: 0 to 10000
  • 0 = no effect

Usage:

var effect = new TrebleEnhancerAudioEffect(6000, 5000);

TrueBassAudioEffect¶

Purpose: Boost low frequencies.

Parameters:

• Frequency (int): Upper frequency limit in Hz
  • Typical: 100-300 Hz
  • Frequencies below this are boosted
• Volume (ushort): Boost amount
  • Range: 0 to 10000
  • 0 = no effect

Usage:

var effect = new TrueBassAudioEffect(150, 5000);

Filter Effects¶

HighPassAudioEffect¶

Implementation: Custom DSP (IIR high-pass filter)

Purpose: Remove low frequencies.

Parameters:

• CutOff (uint): Cutoff frequency in Hz
  • Frequencies below are attenuated
  • Typical: 80-200 Hz for voice, 40 Hz for music

Common Frequencies:

• 20-40 Hz: Sub-sonic removal
• 60-80 Hz: Rumble removal
• 100-150 Hz: Clarity improvement

Usage:

var effect = new HighPassAudioEffect(100); // Remove frequencies below 100 Hz

LowPassAudioEffect¶

Implementation: Custom DSP (IIR low-pass filter)

Purpose: Remove high frequencies.

Parameters:

• CutOff (uint): Cutoff frequency in Hz
  • Frequencies above are attenuated
  • Typical: 8000-12000 Hz for hiss removal

Common Frequencies:

• 15000-20000 Hz: Gentle air reduction
• 8000-10000 Hz: Warmth
• 3000-5000 Hz: Telephone effect

Usage:

var effect = new LowPassAudioEffect(10000); // Remove frequencies above 10 kHz

BandPassAudioEffect¶

Implementation: Custom DSP (state-variable filter)

Purpose: Allow only specific frequency range.

Parameters:

• CutOffHigh (float): Upper frequency boundary in Hz
• CutOffLow (float): Lower frequency boundary in Hz

Usage:

// Constructor: BandPassAudioEffect(cutOffHigh, cutOffLow)
var effect = new BandPassAudioEffect(5000, 300); // Allow 300-5000 Hz

NotchAudioEffect¶

Implementation: Custom DSP (band-reject filter)

Purpose: Remove specific frequency.

Parameters:

• CutOff (uint): Center frequency to remove in Hz
  • Typical: 50/60 Hz for hum removal

Usage:

var effect = new NotchAudioEffect(60); // Remove 60 Hz hum

ChebyshevLimitAudioEffect¶

GStreamer Element: audiocheblimit

Purpose: Sharp low/high-pass filtering with ripple control.

Parameters:

• CutOffFrequency (float): Cutoff frequency in Hz
• Mode (ChebyshevLimitAudioEffectMode): LowPass or HighPass
• Poles (int): Filter order (2-8 typical)
  • Default: 4
  • More poles = steeper rolloff
• Ripple (float): Passband ripple in dB
  • Default: 0.25
• Type (int): Chebyshev type (1 or 2)
  • Default: 1

Usage:

var effect = new ChebyshevLimitAudioEffect();
effect.CutOffFrequency = 100;
effect.Mode = ChebyshevLimitAudioEffectMode.HighPass;
effect.Poles = 6;

ChebyshevBandPassRejectAudioEffect¶

GStreamer Element: audiochebband

Purpose: Sharp band-pass or band-reject filtering.

Parameters:

• LowerFrequency (float): Lower band boundary in Hz
• UpperFrequency (float): Upper band boundary in Hz
• Mode (ChebyshevBandPassRejectAudioEffectMode): BandPass or BandReject
• Poles (int): Filter order (2-8 typical)
  • Default: 4
• Ripple (float): Passband ripple in dB
  • Default: 0.25
• Type (int): Chebyshev type (1 or 2)
  • Default: 1

Usage:

var effect = new ChebyshevBandPassRejectAudioEffect();
effect.LowerFrequency = 300;
effect.UpperFrequency = 3000;
effect.Mode = ChebyshevBandPassRejectAudioEffectMode.BandPass;

Spatial and Stereo Effects¶

BalanceAudioEffect¶

GStreamer Element: audiopanorama

Purpose: Stereo balance (pan) control.

Parameters:

• Level (double): Balance position
  • Range: -1.0 to 1.0
  • -1.0 = full left
  • 0.0 = center
  • 1.0 = full right
  • Default: 0.0

Usage:

var effect = new BalanceAudioEffect(-0.5); // Pan 50% left

WideStereoAudioEffect¶

GStreamer Element: stereo

Purpose: Enhance stereo width.

Parameters:

• Level (float): Widening intensity
  • Range: 0.0+
  • Default: 0.01
  • Typical: 0.01 to 1.0
  • Higher values = wider stereo field

Usage:

var effect = new WideStereoAudioEffect();
effect.Level = 0.5f;

Sound3DAudioEffect¶

Purpose: 3D spatial audio simulation.

Parameters:

• Value (uint): Spatial amplification
  • Range: 1 to 20000
  • 1000 = neutral (disabled)
  • < 1000 = narrower stereo

  • 1000 = wider stereo

  • 10000 may distort

Usage:

var effect = new Sound3DAudioEffect(2000); // 2x spatial width

PhaseInvertAudioEffect¶

Purpose: Invert audio phase by 180 degrees.

Parameters: None.

Usage:

var effect = new PhaseInvertAudioEffect();

HRTFRenderAudioEffect¶

GStreamer Element: hrtfrender (rsaudiofx)

Purpose: HRTF-based 3D spatial audio.

Parameters:

• HrirFile (string): Path to HRIR data file
• InterpolationSteps (ulong): Interpolation quality
  • Default: 8
• BlockLength (ulong): Processing block size
  • Default: 512
• DistanceGain (float): Distance attenuation factor
  • Default: 1.0

Usage:

var effect = new HRTFRenderAudioEffect("/path/to/hrir.dat");
effect.InterpolationSteps = 16; // Higher quality

Time-Based Effects¶

EchoAudioEffect¶

GStreamer Element: audioecho

Purpose: Echo and delay effects.

Parameters:

• Delay (TimeSpan): Echo delay time
  • Must not exceed MaxDelay
• MaxDelay (TimeSpan): Maximum delay buffer
  • Must be >= Delay
  • Set before starting playback
• Intensity (float): Echo volume
  • Range: 0.0 to 1.0
  • Default: 1.0
• Feedback (float): Echo repetition amount
  • Range: 0.0 to 1.0
  • Default: 0.0
  • Higher = more echoes

Usage:

var delay = TimeSpan.FromMilliseconds(500);
var effect = new EchoAudioEffect(delay);
effect.Intensity = 0.7f;
effect.Feedback = 0.4f;

RSAudioEchoAudioEffect¶

GStreamer Element: rsaudioecho (rsaudiofx)

Purpose: Enhanced echo with advanced controls.

Parameters:

• Delay (TimeSpan): Echo delay time
• MaxDelay (TimeSpan): Maximum delay buffer
• Intensity (double): Echo intensity
  • Range: 0.0 to 1.0
• Feedback (double): Feedback amount
  • Range: 0.0 to 1.0

Usage:

var effect = new RSAudioEchoAudioEffect();
effect.Delay = TimeSpan.FromMilliseconds(750);
effect.Intensity = 0.6;
effect.Feedback = 0.3;

ReverberationAudioEffect¶

GStreamer Element: freeverb

Purpose: Room reverberation simulation.

Parameters:

• RoomSize (float): Virtual room size
  • Range: 0.0 to 1.0
  • Default: 0.5
  • Larger = longer reverb tail
• Damping (float): High-frequency absorption
  • Range: 0.0 to 1.0
  • Default: 0.2
  • Higher = darker reverb
• Level (float): Wet/dry mix
  • Range: 0.0 to 1.0
  • Default: 0.5
  • 0 = dry, 1 = wet
• Width (float): Stereo width
  • Range: 0.0 to 1.0
  • Default: 1.0
  • 0 = mono, 1 = full stereo

Usage:

var effect = new ReverberationAudioEffect();
effect.RoomSize = 0.8f; // Large room
effect.Damping = 0.3f;
effect.Level = 0.4f;

FadeAudioEffect¶

Purpose: Volume fade in/out automation.

Parameters:

• StartVolume (uint): Volume at start time
• StopVolume (uint): Volume at stop time
• StartTime (TimeSpan): When fade begins
• StopTime (TimeSpan): When fade completes

Usage:

// Fade out over 3 seconds starting at 10 seconds
var effect = new FadeAudioEffect(
    100, 0,
    TimeSpan.FromSeconds(10),
    TimeSpan.FromSeconds(13)
);

Modulation Effects¶

PhaserAudioEffect¶

Purpose: Phaser effect with LFO modulation.

Parameters:

• Depth (byte): Sweep depth
  • Range: 0 to 255
• DryWetRatio (byte): Mix ratio
  • Range: 0 to 255
  • 0 = dry, 255 = wet
• Feedback (byte): Resonance
  • Range: -100 to 100
• Frequency (float): LFO speed in Hz
  • Typical: 0.1 to 5 Hz
• Stages (byte): Number of stages
  • Range: 2 to 24 recommended
  • More = stronger effect
• StartPhase (float): LFO start phase in radians

Usage:

var effect = new PhaserAudioEffect(
    150,      // depth
    128,      // 50% mix
    50,       // feedback
    0.5f,     // 0.5 Hz LFO
    6,        // 6 stages
    0f        // start phase
);

FlangerAudioEffect¶

Purpose: Flanging effect with delay modulation.

Parameters:

• Delay (TimeSpan): Base delay time
  • Typical: 1-15 ms
• Frequency (float): LFO speed in Hz
  • Typical: 0.1 to 5 Hz
• PhaseInvert (bool): Invert delayed signal phase
  • Default: false

Usage:

var effect = new FlangerAudioEffect(
    TimeSpan.FromMilliseconds(5),
    1.0f,
    false
);

Pitch and Tempo Effects¶

PitchShiftAudioEffect¶

Purpose: Change pitch without changing speed.

Parameters:

• Pitch (float): Pitch shift ratio
  • 1.0 = no change
  • 2.0 = one octave up
  • 0.5 = one octave down
  • Typical range: 0.5 to 2.0

Musical Intervals:

• 0.5 = -12 semitones
• 1.059 = +1 semitone
• 1.122 = +2 semitones
• 2.0 = +12 semitones

Usage:

var effect = new PitchShiftAudioEffect(1.5f); // Up by a fifth

ScaleTempoAudioEffect¶

GStreamer Element: scaletempo

Purpose: Change tempo without changing pitch (WSOLA algorithm).

Parameters:

• Rate (double): Playback speed
  • 1.0 = normal
  • 2.0 = double speed
  • 0.5 = half speed
  • Default: 1.0
• Stride (TimeSpan): Processing stride
  • Default: 30 ms
• Overlap (double): Overlap percentage
  • Range: 0.0 to 1.0
  • Default: 0.2
• Search (TimeSpan): Search window
  • Default: 14 ms

Usage:

var effect = new ScaleTempoAudioEffect(1.5); // 1.5x speed

Special Effects¶

KaraokeAudioEffect¶

GStreamer Element: audiokaraoke

Purpose: Remove center-panned vocals.

Parameters:

• FilterBand (float): Center frequency in Hz
  • Default: 220 Hz
  • Typical: 80-400 Hz
• FilterWidth (float): Filter bandwidth in Hz
  • Default: 100 Hz
• Level (float): Effect intensity
  • Range: 0.0 to 1.0
  • Default: 1.0
• MonoLevel (float): Mono channel level
  • Range: 0.0 to 1.0
  • Default: 1.0

Usage:

var effect = new KaraokeAudioEffect();
effect.FilterBand = 250f;
effect.Level = 1.0f;

RemoveSilenceAudioEffect¶

Purpose: Automatically remove silent sections.

Parameters:

• Threshold (double): Silence detection threshold
  • Range: 0.0 to 1.0
  • Default: 0.05
  • Lower = more sensitive
• Squash (bool): Remove vs. reduce silence
  • true = remove completely
  • false = reduce level
  • Default: true

Usage:

var effect = new RemoveSilenceAudioEffect("silence-remover");
effect.Threshold = 0.02;
effect.Squash = true;

CsoundAudioEffect¶

GStreamer Element: csoundfilter

Purpose: Csound-based audio programming.

Platforms: Windows, macOS, Linux (requires Csound installation).

Parameters:

• CsdText (string): Csound CSD document as text
• Location (string): Path to CSD file
• Loop (bool): Loop score continuously
  • Default: false
• ScoreOffset (double): Start time in seconds
  • Default: 0.0

Usage:

var csd = @"<CsoundSynthesizer>
<CsInstruments>
; Your Csound code here
</CsInstruments>
<CsScore>
; Your score here
</CsScore>
</CsoundSynthesizer>";

var effect = new CsoundAudioEffect("my-csound", csd);
effect.Loop = false;

Noise Reduction and Measurement¶

AudioRNNoiseAudioEffect¶

GStreamer Element: audiornnoise (rsaudiofx)

Purpose: AI-based noise reduction.

Parameters:

• VadThreshold (float): Voice activity detection threshold
  • Range: 0.0 to 1.0
  • Default: 0.0
  • Higher = more sensitive to voice

Usage:

var effect = new AudioRNNoiseAudioEffect();
effect.VadThreshold = 0.5f;

AudioLoudNormAudioEffect¶

GStreamer Element: audioloudnorm (rsaudiofx)

Purpose: EBU R128 loudness normalization.

Parameters:

• LoudnessTarget (double): Target loudness in LUFS
  • Range: -70.0 to -5.0
  • Default: -24.0
• LoudnessRangeTarget (double): Target range in LU
  • Range: 1.0 to 20.0
  • Default: 7.0
• MaxTruePeak (double): Max true peak in dbTP
  • Range: -9.0 to 0.0
  • Default: -2.0
• Offset (double): Offset gain in LU
  • Range: -99.0 to 99.0
  • Default: 0.0

Usage:

var effect = new AudioLoudNormAudioEffect();
effect.LoudnessTarget = -16.0; // Streaming standard
effect.MaxTruePeak = -1.0;

EbuR128LevelAudioEffect¶

GStreamer Element: ebur128level (rsaudiofx)

Purpose: EBU R128 loudness measurement.

Parameters:

• Mode (EbuR128Mode): Measurement types to calculate
  • Options: Momentary, ShortTerm, Global, LoudnessRange, SamplePeak, TruePeak, All
  • Default: All
• PostMessages (bool): Post measurement messages
  • Default: true
• Interval (TimeSpan): Measurement update interval
  • Default: 1 second

Usage:

var effect = new EbuR128LevelAudioEffect();
effect.Mode = EbuR128Mode.All;
effect.Interval = TimeSpan.FromSeconds(0.5);

Channel Management¶

ChannelOrderAudioEffect¶

Purpose: Remap audio channels.

Parameters:

• Orders (byte[,]): 2D array of [target, source] pairs
  • Format: [[target0, source0], [target1, source1], ...]
  • Channels are zero-indexed

Usage:

// Swap left and right channels
var orders = new byte[2, 2] {
    { 0, 1 },  // Output channel 0 gets input channel 1 (right)
    { 1, 0 }   // Output channel 1 gets input channel 0 (left)
};
var effect = new ChannelOrderAudioEffect(orders);

DownMixAudioEffect¶

Implementation: Custom DSP (channel averaging)

Purpose: Reduce channel count (e.g., 5.1 to stereo).

Parameters: None (automatic downmixing).

Usage:

var effect = new DownMixAudioEffect();

DirectSound Effects (Classic SDKs, Windows Only)¶

The following effects are available only in Video Capture SDK (VideoCaptureCore), Media Player SDK (MediaPlayerCore), and Video Edit SDK (VideoEditCore) on Windows. They use DirectSound/DirectX technology.

DS Chorus¶

Creates a chorus effect with multiple delayed and modulated copies.

Properties:

• WetDryMix (float): Dry/wet mix (0-100)
• Depth (float): Modulation depth (0-100)
• Feedback (float): Feedback amount (0-100)
• Frequency (float): LFO frequency (0-10 Hz)
• Waveform: Sine or Triangle
• Delay (float): Base delay (0-20 ms)
• Phase: Phase relationship for stereo (-180 to 180 degrees)

Usage:

videoCaptureCore.Audio_Effects_DS_Chorus(0, "chorus", true,
    wetDryMix: 50, depth: 25, feedback: 25, frequency: 1.1f,
    waveform: DSChorusWaveForm.Sine, delay: 16, phase: DSChorusPhase.Phase90);

DS Distortion¶

Adds distortion/overdrive to audio signal.

Properties:

• Gain (float): Pre-distortion gain (-60 to 0 dB)
• Edge (float): Distortion amount (0-100%)
• PostEQCenterFrequency (float): Post-EQ center (100-8000 Hz)
• PostEQBandwidth (float): Post-EQ bandwidth (100-8000 Hz)
• PreLowpassCutoff (float): Pre-distortion lowpass (100-8000 Hz)

Usage:

videoCaptureCore.Audio_Effects_DS_Distortion(0, "distortion", true,
    gain: -18, edge: 50, postEQCenterFrequency: 2400,
    postEQBandwidth: 2400, preLowpassCutoff: 8000);

DS Gargle¶

Creates a gargling/tremolo modulation effect.

Properties:

• RateHz (uint): Modulation rate (1-1000 Hz)
• WaveShape: Triangle or Square wave

Usage:

videoCaptureCore.Audio_Effects_DS_Gargle(0, "gargle", true,
    rateHz: 20, waveShape: DSGargleWaveForm.Triangle);

DS Reverb (I3DL2)¶

Professional reverb with environmental modeling.

Properties:

• Room (int): Room effect level (-10000 to 0 mB)
• RoomHF (int): High-frequency room effect (-10000 to 0 mB)
• RoomRolloffFactor (float): Rolloff factor (0 to 10)
• DecayTime (float): Decay time (0.1 to 20 seconds)
• DecayHFRatio (float): HF decay ratio (0.1 to 2.0)
• Reflections (int): Early reflections (-10000 to 1000 mB)
• ReflectionsDelay (float): Reflections delay (0 to 0.3 seconds)
• Reverb (int): Late reverb level (-10000 to 2000 mB)
• ReverbDelay (float): Reverb delay (0 to 0.1 seconds)
• Diffusion (float): Diffusion (0 to 100%)
• Density (float): Density (0 to 100%)
• HFReference (float): Reference HF (20 to 20000 Hz)

DS Waves Reverb¶

Simplified reverb with basic parameters.

Properties:

• InGain (float): Input gain (0 to 96 dB)
• ReverbMix (float): Reverb mix (0 to 96 dB)
• ReverbTime (float): Reverb time (0.001 to 3000 ms)
• HighFreqRTRatio (float): HF reverb time ratio (0.001 to 0.999)

Usage:

videoCaptureCore.Audio_Effects_DS_WavesReverb(0, "reverb", true,
    inGain: 0, reverbMix: -10, reverbTime: 1000, highFreqRTRatio: 0.001f);

Effects Availability Matrix¶

Legend:

• Cross-platform SDKs = Media Blocks SDK, Video Capture SDK (VideoCaptureCoreX), Media Player SDK (MediaPlayerCoreX)
• Classic SDKs = Video Capture SDK (VideoCaptureCore), Media Player SDK (MediaPlayerCore), Video Edit SDK (VideoEditCore) — Windows only

Audio Elements Reference¶

Frequently Asked Questions¶

See Also¶

• Audio Effects Overview
• Audio Sample Grabber
• Audio Processing Blocks (Media Blocks SDK)