API reference

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

C

classDuckingEffect

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

Sidechain compressor (ducker) implemented as an WorkletEffect. Attenuates the main audio signal whenever the `sidechain` AudioBus exceeds the threshold, then releases when it drops back down. Commonly used to duck background music under dialogue or sound effects. Attack and release times are expressed in milliseconds and converted internally to one-pole filter coefficients.

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

Sidechain compressor (ducker) implemented as an WorkletEffect. Attenuates the main audio signal whenever the `sidechain` AudioBus exceeds the threshold, then releases when it drops back down. Commonly used to duck background music under dialogue or sound effects. Attack and release times are expressed in milliseconds and converted internally to one-pole filter coefficients.

Constructors 1
new(options: DuckingEffectOptions): DuckingEffect
Methods 2
_onWorkletReady(audioContext: AudioContext): void
destroy(): void
Properties 8
attackMs: number
inputNode: AudioNode
outputNode: AudioNode
ratio: number
ready: Promise<void>
releaseMs: number
threshold: number
wet: number
Source
packages/exojs-audio-fx/src/effects/DuckingEffect.ts