API reference

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

C

classVocoderEffect

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

Phase-vocoder-style effect implemented as a WorkletEffect. Analyzes the spectral envelope of a `modulator` AudioBus across a bank of log-spaced bandpass filters and applies that envelope to the carrier signal (the main input). The result is the classic "robot voice" or talking-synth effect. Band count, frequency range, and Q are compile-time parameters set at construction; only `wet` and `envelopeSmoothing` are adjustable at runtime.

5
props
3
methods
0
events
Import
import { VocoderEffect } from '@codexo/exojs-audio-fx'

Phase-vocoder-style effect implemented as a WorkletEffect. Analyzes the spectral envelope of a `modulator` AudioBus across a bank of log-spaced bandpass filters and applies that envelope to the carrier signal (the main input). The result is the classic "robot voice" or talking-synth effect. Band count, frequency range, and Q are compile-time parameters set at construction; only `wet` and `envelopeSmoothing` are adjustable at runtime.

Constructors1
new(options: VocoderEffectOptions): VocoderEffect
Methods3
_onWorkletReady(_audioContext: AudioContext): void
Subclass hook - called once the worklet is loaded and inserted into the wet path. Use for additional wiring (e.g. a sidechain input).
_setAudioParam(name: string, value: number): void
Ramps an AudioParam on the underlying AudioWorkletNode to value using a short exponential ramp. No-ops if the worklet is not yet loaded. Part of the effect SDK contract for extension audio effects.
destroy(): void
Disconnects all nodes, cancels any pending worklet load, and releases resources.
Properties5
envelopeSmoothing: number
One-pole envelope follower coefficient. Smaller values produce slower, smoother envelope tracking. Range 0.0001..0.1, default 0.005.
inputNode: AudioNode
The node where audio enters this effect.
outputNode: AudioNode
The node where audio exits this effect.
ready: Promise<void>
Resolves once the worklet is loaded and inserted into the wet path. Also resolves when the load fails - the effect then stays the clean passthrough it is until the worklet arrives, and the failure is reported through the engine log rather than by rejecting.
wet: number
Wet (processed) mix level, 0..1. The dry level is automatically 1 - wet. Ramped smoothly.
Source
packages/exojs-audio-fx/src/effects/VocoderEffect.ts