API reference

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

I

interfaceDistortionEffectOptions

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

Construction options for DistortionEffect.

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

Construction options for DistortionEffect.

Properties4
drive?: number
Drive amount: controls the intensity of the tanh soft-clip curve. Range 0..1, default 0.4. Higher values produce heavier, more saturated distortion; lower values produce a milder soft-clip. Note that even at drive=0 the curve is not perfectly linear - the formula tanh(x) / tanh(1) has a gain of 1/tanh(1) ≈ 1.31 at the origin.
oversample?: OverSampleType
Oversampling mode applied by the WaveShaperNode. Higher oversampling reduces aliasing artifacts at the cost of extra CPU. One of 'none', '2x', or '4x'. Default '2x'.
tone?: number
Tone control: cutoff of a post-distortion low-pass filter on the wet path. Mapped logarithmically from 100 Hz (tone=0, fully dark) to 20 kHz (tone=1, fully open). Range 0..1, default 1.
wet?: number
Dry/wet mix, 0..1. The dry level is automatically 1 - wet. Default 1.0.
Source
packages/exojs-audio-fx/src/effects/DistortionEffect.ts