API reference

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

C

classChorusEffect

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

Chorus effect using native WebAudio nodes (no worklet required). The signal splits into a dry path and a wet path. The wet path passes through a DelayNode whose delay time is modulated by a sine-wave LFO, producing the characteristic pitch-wobble / thickening of chorus. Node graph: ``` inputGain ┬── dryGain ────────────────┐ │ ├── outputGain └── delayNode ── wetGain ────┘ lfoOscillator ── lfoGain (depth) ── delayNode.delayTime ```

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

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

The signal splits into a dry path and a wet path. The wet path passes through a DelayNode whose delay time is modulated by a sine-wave LFO, producing the characteristic pitch-wobble / thickening of chorus.

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

lfoOscillator ── lfoGain (depth) ── delayNode.delayTime ```

Constructors1
new(options: ChorusEffectOptionsConstruction options for ChorusEffect.): ChorusEffect
Methods1
destroy(): void
Disconnects all audio nodes and releases resources. Must be called when the effect is no longer needed.
Properties7
delayMs: number
Base delay time in milliseconds. Default 25.
depthMs: number
LFO modulation depth in milliseconds (peak deviation from base delay). Default 5.
inputNode: AudioNode
The node where audio enters this effect.
outputNode: AudioNode
The node where audio exits this effect.
rateHz: number
LFO oscillation rate in Hz. Typical chorus range is 0.1-5 Hz; 5-15 Hz produces a vibrato effect. Default 1.5.
ready: Promise<void>
Resolves when the effect is fully initialized. Defaults to immediately-resolved for sync effects.
wet: number
Wet (modulated) mix level, 0..1. The dry level is automatically 1 - wet. Default 0.5.
Source
packages/exojs-audio-fx/src/effects/ChorusEffect.ts