API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

C

classFlangerEffect

@codexo/exojs-audio-fx / audio / stable

Flanger effect using native WebAudio nodes (no worklet required). A flanger is a very short LFO-modulated delay (1-10 ms) with a feedback loop. Unlike a chorus - which uses longer delays without feedback to produce thickening - the flanger's feedback reinforces phase cancellation, creating the characteristic sweeping comb-filter "jet-plane" sound as notches and peaks slide up and down the spectrum. Node graph: ``` inputGain ┬── dryGain ─────────────────────────┐ │ ├── outputGain └──▶ delayNode ──▶ wetGain ───────────┘ ↑ │ feedbackGain ◀─┘ lfoOscillator ── lfoGain (depth in seconds) ──▶ delayNode.delayTime ``` Gains: `dryGain.gain = 1 - wet`; `wetGain.gain = wet`; `feedbackGain.gain = feedback`; `lfoGain.gain = depthMs / 1000`.

8
props
1
methods
0
events
Import
import { FlangerEffect } from '@codexo/exojs-audio-fx'

Flanger effect using native WebAudio nodes (no worklet required).

A flanger is a very short LFO-modulated delay (1-10 ms) with a feedback loop. Unlike a chorus - which uses longer delays without feedback to produce thickening - the flanger's feedback reinforces phase cancellation, creating the characteristic sweeping comb-filter "jet-plane" sound as notches and peaks slide up and down the spectrum.

Node graph: ``` inputGain ┬── dryGain ─────────────────────────┐ │ ├── outputGain └──▶ delayNode ──▶ wetGain ───────────┘ ↑ │ feedbackGain ◀─┘

lfoOscillator ── lfoGain (depth in seconds) ──▶ delayNode.delayTime ```

Gains: `dryGain.gain = 1 - wet`; `wetGain.gain = wet`; `feedbackGain.gain = feedback`; `lfoGain.gain = depthMs / 1000`.

Constructors1
new(options: FlangerEffectOptionsConstruction options for FlangerEffect.): FlangerEffect
Methods1
destroy(): void
Disconnects all audio nodes and releases resources. Must be called when the effect is no longer needed.
Properties8
delayMs: number
Base delay time in milliseconds. Range 0.5..20, default 3.
depthMs: number
LFO modulation depth in milliseconds (peak deviation from base delay). Range 0..10, default 2.
feedback: number
Feedback amount - fraction of delay output fed back to delay input. Range 0..0.95, default 0.5.
inputNode: AudioNode
The node where audio enters this effect. Throws if the audio context is not yet initialized.
outputNode: AudioNode
The node where audio exits this effect. Throws if the audio context is not yet initialized.
rateHz: number
LFO oscillation rate in Hz. Range 0..10, default 0.25.
ready: Promise<void>
Resolves when the effect is fully initialized. Defaults to immediately-resolved for sync effects.
wet: number
Wet (flanged) mix level, 0..1. The dry level is automatically 1 - wet. Default 0.5.
Source
packages/exojs-audio-fx/src/effects/FlangerEffect.ts