API reference

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

classWorkletFilter

@codexo/exojs / audio / stable

Base class for filters implemented as AudioWorkletProcessors. Subclasses declare the worklet's name, source code, and node options; this class handles the async lifecycle. Stable input/output nodes (GainNodes) are created immediately on setup. While the worklet loads asynchronously, audio passes through directly (effectively bypassing the filter for ~10-50ms during initial load). Once the worklet loads, it's inserted into the chain and audio routes through it. Subclasses can override `_onWorkletReady` to perform additional wiring (e.g., sidechain inputs).

props

methods

events

Import

import { WorkletFilter } from '@codexo/exojs'

Base class for filters implemented as AudioWorkletProcessors. Subclasses declare the worklet's name, source code, and node options; this class handles the async lifecycle.

Stable input/output nodes (GainNodes) are created immediately on setup. While the worklet loads asynchronously, audio passes through directly (effectively bypassing the filter for ~10-50ms during initial load). Once the worklet loads, it's inserted into the chain and audio routes through it.

Subclasses can override `_onWorkletReady` to perform additional wiring (e.g., sidechain inputs).

Constructors 1

new(): WorkletFilter

Methods 2

_onWorkletReady(audioContext: AudioContext): void

destroy(): void

Properties 3

inputNode: AudioNode

outputNode: AudioNode

ready: Promise<void>

Source

src/audio/filters/WorkletFilter.ts