API reference

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

I

interfaceConvolutionEffectOptions

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

Construction options for ConvolutionEffect.

4
props
0
methods
0
events
Import
import { ConvolutionEffectOptions } from '@codexo/exojs-audio-fx'

Construction options for ConvolutionEffect.

Properties4
gain?: number
Optional makeup gain multiplier applied to the wet path. Useful when the IR is very quiet or very loud and normalize is off. Range 0..4, default 1.
impulse?: AudioBuffer | SoundPre-decoded short audio clip backed by an `AudioBuffer`. Sound is a **data descriptor** - it holds the decoded audio buffer, sprite definitions, and default pl…
Impulse response. Accepts a decoded AudioBuffer or a Sound (its audioBuffer is used). If omitted the effect runs dry (passthrough) until ConvolutionEffect.setImpulse is called.
normalize?: boolean
Maps to ConvolverNode.normalize. When true the browser applies an equal-power normalization pass on the IR so different IRs play at a consistent perceived loudness. Default true (the Web Audio spec default). **Note:** the Web Audio spec only respects normalize if it is set *before* buffer is assigned. This class always writes normalize first. Changing normalize at runtime while an IR is loaded re-assigns the buffer so the new value takes effect.
wet?: number
Dry/wet mix, 0..1. The dry level is automatically 1 - wet. Default 1.0.
Source
packages/exojs-audio-fx/src/effects/ConvolutionEffect.ts