API reference

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

I

interfaceLimiterEffectOptions

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

Construction options for LimiterEffect.

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

Construction options for LimiterEffect.

Properties6
attack?: number
Time in seconds for the limiter to engage after the signal exceeds the threshold. Range 0..1, default 0.003.
knee?: number
Width in dB of the transition region around the threshold (soft knee). Range 0..40, default 0 (hard knee). Raise it for a gentler transition into limiting.
ratio?: number
Input-to-output dB ratio above the threshold. Range 1..20, default 20 (brick-wall). Lower it for a softer, more compressor-like limiter.
release?: number
Time in seconds for the limiter to release after the signal drops below the threshold. Range 0..1, default 0.25.
threshold?: number
Threshold in dBFS above which limiting is applied. Range −60..0, default −3.
wet?: number
Dry/wet mix, 0..1. The dry level is automatically 1 - wet. Default 1.0. A limiter is typically used fully wet, but exposing this allows parallel processing workflows.
Source
packages/exojs-audio-fx/src/effects/LimiterEffect.ts