Table of Contents

Namespace VisioForge.Core.Types.X.AudioEffects

Classes

AmplifyAudioEffect

Amplify audio effect amplifies an audio stream by a specified amplification factor. Uses the GStreamer 'audioamplify' element with configurable clipping methods to prevent distortion. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

AudioDelaySettings

Settings for delaying an audio stream by shifting its buffer timestamps.

AudioLoudNormAudioEffect

Audio loudness normalization effect from the rsaudiofx GStreamer plugin. Normalizes audio according to EBU R128 loudness standards. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

AudioMixerSettings

Configuration settings for the audio mixer, which combines multiple audio streams into a single output.

AudioRNNoiseAudioEffect

RNN-based audio noise reduction effect from the rsaudiofx GStreamer plugin. Uses a recurrent neural network to remove noise from audio streams. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

AudioResamplerSettings

Configuration settings for audio sample rate conversion using the GStreamer audioresample element.

AudioTimestampCorrectorSettings

Configuration settings for the audio timestamp corrector (audiorate element). Ensures a perfect audio stream by inserting silence or dropping samples to match expected timestamps.

BalanceAudioEffect

Balance audio effect controls the stereo balance (left-right panning) of an audio stream. Uses the GStreamer 'audiopanorama' element to adjust the stereo position. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

BandPassAudioEffect

Simple band-pass audio filter that passes frequencies within a specified range. Allows frequencies between the low and high cutoff points to pass while attenuating frequencies outside this range. Useful for isolating specific frequency bands, creating "telephone" or "radio" effects, or frequency-selective processing. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

BaseAudioEffect

Base class for all audio effects. Provides common identification, naming, and change notification.

ChannelOrderAudioEffect

Remaps audio channels to different output positions for custom channel routing. Allows complete control over which input channel feeds which output channel. Essential for fixing incorrectly mapped audio or creating custom channel configurations. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

ChebyshevBandPassRejectAudioEffect

Chebyshev band pass and band reject audio filter for precise frequency range control. Uses the GStreamer 'audiochebband' element implementing Chebyshev Type I or Type II filters. Provides steeper roll-off than standard filters, useful for frequency isolation or notch filtering.

ChebyshevLimitAudioEffect

Chebyshev low-pass and high-pass audio filter for frequency range control. Uses the GStreamer 'audiocheblimit' element implementing Chebyshev Type I or Type II filters. Provides steep roll-off for aggressive frequency limiting, common in synthesis and audio processing.

CompressorExpanderAudioEffect

Compressor/expander effect for dynamic range control of audio signals. Uses the GStreamer 'audiodynamic' element to compress loud signals or expand quiet signals. Essential for broadcast, mastering, and controlling audio dynamics.

CsoundAudioEffect

Advanced audio synthesis and processing using the Csound programming language. Uses the GStreamer 'csoundfilter' element to apply custom Csound algorithms to audio streams. Enables sophisticated audio effects, synthesis, and real-time audio programming capabilities. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect. Implements the VisioForge.Core.Types.X.AudioEffects.IVideoEditXAudioEffect.

DownMixAudioEffect

Downmixes multi-channel audio to stereo or mono output. Intelligently combines surround sound channels into fewer output channels. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

DynamicAmplifyAudioEffect

Automatically adjusts audio gain based on signal level for dynamic loudness control. Amplifies quiet passages while limiting loud peaks using adaptive gain control. Provides smooth, musical dynamics processing with configurable attack and release times. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

EbuR128LevelAudioEffect

EBU R128 loudness level measurement effect from the rsaudiofx GStreamer plugin. Measures and reports loudness levels according to EBU R128 standard. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

EchoAudioEffect

Echo audio effect creates echo/delay effects by repeating the audio signal with configurable delay, intensity, and feedback. Uses the GStreamer 'audioecho' element to produce single or multiple echo repetitions.

Equalizer10AudioEffect

10-band graphic equalizer for precise frequency control across the audio spectrum. Uses the GStreamer 'equalizer-10bands' element with fixed center frequencies. Each band can be adjusted independently to shape the tonal balance of audio.

EqualizerParametricAudioEffect

Parametric n-band audio equalizer with adjustable frequency, Q (bandwidth), and gain for each band. Provides more precise and flexible frequency control compared to graphic equalizers. Ideal for surgical EQ adjustments, feedback elimination, and professional audio work.

FadeAudioEffect

Creates smooth volume transitions (fade-in/fade-out) over specified time periods. Gradually changes volume between two levels across a defined time range for professional audio transitions. Essential for smooth intro/outro effects and preventing audio pops or clicks. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

FlangerAudioEffect

Flanger audio effect creates a sweeping, "jet plane" sound by mixing the audio signal with a delayed copy of itself. The delay time is modulated by a low-frequency oscillator (LFO), creating the characteristic swooshing effect. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

HRTFRenderAudioEffect

Head-Related Transfer Function (HRTF) spatial audio rendering effect from the rsaudiofx GStreamer plugin. Renders spatial audio using HRTF data for 3D positional audio. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

HighPassAudioEffect

High-pass audio filter that attenuates frequencies below a specified cutoff frequency. Allows high frequencies to pass through while progressively removing low frequencies. Also known as a low-cut filter. Essential for removing rumble, reducing muddiness, and improving clarity. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

KaraokeAudioEffect

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.

LowPassAudioEffect

Low-pass audio filter that attenuates frequencies above a specified cutoff frequency. Allows low frequencies to pass through while progressively removing high frequencies. Also known as a high-cut filter. Used for removing harshness, controlling brightness, creating warmth, or special effects. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

NotchAudioEffect

Notch filter (band-stop filter) that attenuates a narrow frequency band. Ideal for removing specific frequency interference like 50/60 Hz hum or feedback. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

ParametricEqualizerBand

Defines a single band for a parametric equalizer, with center frequency, bandwidth, and gain.

PhaseInvertAudioEffect

Inverts the phase (polarity) of audio signal by 180 degrees. Multiplies the audio waveform by -1, effectively flipping it vertically. Used for phase correction, cancelling audio signals, or creative stereo effects. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

PhaserAudioEffect

Classic phaser effect that creates sweeping, swirling tones through phase shifting. Modulates the phase of audio frequencies using an LFO (Low Frequency Oscillator). Popular in rock and electronic music for its distinctive "swooshing" sound. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

PitchAudioEffect

Pitch audio effect changes the pitch of audio without affecting playback speed. Uses the GStreamer 'pitch' element from the soundtouch library. Supports pitch shifting, tempo adjustment, and rate control independently.

PitchShiftAudioEffect

Pitch shift audio effect changes the pitch of audio without affecting its tempo/speed. Uses the SoundTouch library via GStreamer to perform high-quality pitch shifting. Useful for key transposition, vocal correction, or special effects. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

RSAudioEchoAudioEffect

RS Audio Echo effect from the rsaudiofx GStreamer plugin. Provides echo and reverb effects with configurable delay, intensity, and feedback. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

RemoveSilenceAudioEffect

Audio effect for automatic silence detection and removal. This effect analyzes audio streams to identify sections where the signal level falls below a specified threshold and either removes these sections completely or reduces their volume. Useful for cleaning up recordings, podcasts, and voice content by eliminating unwanted silent gaps. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

RemoveSilenceSettings

Configuration settings for the remove silence audio effect. This effect automatically detects and removes silent or quiet sections from audio streams, useful for audio cleanup, podcast processing, and voice recording optimization.

ReverberationAudioEffect

Reverberation audio effect adds simulated room acoustics and spatial depth to audio. Uses the GStreamer 'freeverb' element, implementing the Freeverb algorithm for realistic room simulation. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

ScaleTempoAudioEffect

Scale tempo audio effect changes the playback speed (tempo) of audio without significantly affecting pitch. Uses the GStreamer 'scaletempo' element with WSOLA (Waveform Similarity Overlap-Add) algorithm. Ideal for time-stretching audio, creating slow-motion or fast-forward effects while preserving pitch.

Sound3DAudioEffect

Creates spatial 3D audio effects by enhancing stereo width and channel separation. Simulates three-dimensional sound positioning for increased immersion and spatial perception. Can enhance stereo width from natural to extreme depending on amplification value. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

TrebleEnhancerAudioEffect

Boosts high-frequency content (treble) above a specified frequency threshold. Enhances clarity, presence, and "air" in audio by amplifying treble frequencies. Opposite of TrueBass effect - targets high frequencies instead of low. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

TrueBassAudioEffect

TrueBass audio effect enhances low frequencies to provide richer bass response. Boosts bass frequencies within a specified range to add depth and punch to audio. Useful for improving bass on small speakers or enhancing low-end in music. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

VolumeAudioEffect

Volume audio effect controls the volume level of an audio stream. Uses the GStreamer 'volume' element to adjust audio amplification and mute state. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

WeightedChannelMixAudioEffect

Weighted channel mixing audio effect for dual-mono audio sources like CD+G karaoke files. This effect mixes stereo channels with adjustable weights and outputs the merged mono signal to both speakers. Perfect for karaoke applications where left channel contains music only and right channel contains music + vocals.

WideStereoAudioEffect

Wide stereo audio effect enhances the stereo image by increasing the perceived width and spaciousness. Uses the GStreamer 'stereo' element to widen the stereo field without phase issues. Creates a more immersive, spacious sound from stereo recordings.

Interfaces

ISharedAudioEffectX

Common interface for audio effects, providing identification and naming.

IVideoEditXAudioEffect

Interface for audio effects that can generate a GStreamer pipeline description string. Used by video editing pipelines to serialize effect parameters.

Enums

AmplifyClippingMethod

Audio amplify effect clipping method.

AudioCompressorMode

Audio compressor mode.

AudioDynamicCharacteristics

Specifies the knee characteristic for dynamic audio processing (compressor/expander). Controls how abruptly the gain change is applied around the threshold.

AudioEffectID

Audio effect ID.

AudioPanoramaMethod

Specifies the panning algorithm used for stereo balance/panorama adjustment.

AudioResamplerFilterInterpolation

Specifies how the sinc filter table is interpolated during audio resampling. Controls the tradeoff between filter accuracy and memory usage.

AudioResamplerFilterMode

Specifies how the sinc filter table is stored for audio resampling. Controls the tradeoff between memory usage and CPU cost.

AudioResamplerMethod

Specifies the resampling algorithm used for sample rate conversion. Higher-quality methods produce better audio but require more CPU.

ChebyshevBandPassRejectAudioEffectMode

Specifies the operating mode for the Chebyshev band-pass/band-reject filter.

ChebyshevLimitAudioEffectMode

Specifies the operating mode for the Chebyshev frequency limit filter.

ChorusPhase

LFO phase offset for the chorus effect, in degrees. Controls the phase difference between left and right channel modulation, affecting the stereo width of the chorus effect.

ChorusWaveForm

LFO waveform shape for the chorus effect. Controls how the delay time is modulated over time.

EbuR128Mode

EBU R128 loudness measurement mode flags for the EbuR128Level effect. These flags specify which types of loudness measurements to calculate.

EqualizerPreset

Equalizer presets. All except 'Custom' have 10 bands.

FlangerPhase

LFO phase offset for the flanger effect, in degrees. Controls the phase difference between left and right channel modulation, affecting the stereo width of the flanging effect.

FlangerWaveForm

LFO waveform shape for the flanger effect. Controls how the delay time is modulated over time.

GargleWaveForm

Modulation waveform shape for the gargle (ring modulation) effect.