API reference

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

I

interfaceTremoloEffectOptions

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

Construction options for TremoloEffect.

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

Construction options for TremoloEffect.

Properties4
autoPan?: boolean
When true the same LFO also drives a StereoPannerNode.pan (amplitude = depth), sweeping the signal left and right in synchrony with the tremolo pulsing. This option is read-only after construction. Default false.
depth?: number
Modulation depth, 0..1. Determines the amplitude of the LFO that modulates tremoloGain.gain. The base gain is 1 - depth; adding the LFO (peak = depth) makes the gain oscillate between 1 - 2 * depth and 1. At depth=0 the effect is transparent; at depth=0.5 the gain briefly reaches zero at the trough; at depth>0.5 the gain goes negative (phase inversion at the trough). Default 0.7.
rateHz?: number
LFO oscillation rate in Hz controlling the speed of the tremolo pulse. Range 0..20, default 5.
wet?: number
Dry/wet mix, 0..1. The dry level is automatically 1 - wet. Default 1.
Source
packages/exojs-audio-fx/src/effects/TremoloEffect.ts