API reference

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

C

classAudioEffect

@codexo/exojs / audio / stable

Abstract base for all insertable audio effects in ExoJS. Each effect exposes stable inputNode and outputNode AudioNodes that an AudioBus or Voice connects into the Web Audio graph. Async effects (e.g., worklet-based) expose a ready promise that resolves once the effect is fully initialized.

3
props
1
methods
0
events
Import
import { AudioEffect } from '@codexo/exojs'

Abstract base for all insertable audio effects in ExoJS. Each effect exposes stable inputNode and outputNode AudioNodes that an AudioBus or Voice connects into the Web Audio graph. Async effects (e.g., worklet-based) expose a ready promise that resolves once the effect is fully initialized.

Constructors1
new(): AudioEffect
Methods1
destroy(): void
Disconnects all audio nodes and releases resources. Must be called when the effect is no longer needed.
Properties3
inputNode: AudioNode
The node where audio enters this effect.
outputNode: AudioNode
The node where audio exits this effect.
ready: Promise<void>
Resolves when the effect is fully initialized. Defaults to immediately-resolved for sync effects.
Source