API reference
Every public class, method, and event in @codexo/exojs. Generated from source.
classCompressorEffect
@codexo/exojs-audio-fx / audio / stable
Dynamic-range compressor backed by a Web Audio `DynamicsCompressorNode`. Reduces the volume of loud signals above a threshold, evening out the perceived loudness of a mix. All parameter changes are applied with a short smoothing ramp so they are artifact-free during playback.
9
props
1
methods
0
events
Import
import { CompressorEffect } from '@codexo/exojs-audio-fx'Dynamic-range compressor backed by a Web Audio `DynamicsCompressorNode`. Reduces the volume of loud signals above a threshold, evening out the perceived loudness of a mix. All parameter changes are applied with a short smoothing ramp so they are artifact-free during playback.
Constructors1
new(options: CompressorEffectOptionsConstruction options for CompressorEffect. All values are clamped to their valid ranges on assignment.): CompressorEffectMethods1
destroy(): voidDisconnects all audio nodes and releases resources. Must be called when the effect is no longer needed.
Properties9
attack: numberTime in seconds for the compressor to engage after the signal exceeds the threshold. Range 0..1, default 0.003.
inputNode: AudioNodeThe node where audio enters this effect.
knee: numberWidth in dB of the transition region around the threshold (soft knee). Range 0..40, default 30.
outputNode: AudioNodeThe node where audio exits this effect.
ratio: numberInput-to-output dB ratio above the threshold. Range 1..20, default 12.
ready: Promise<void>Resolves when the effect is fully initialized. Defaults to immediately-resolved for sync effects.
reduction: numberLive gain reduction in dB applied by the compressor right now. Always <= 0 (or 0 when the compressor isn't engaging). Read-only - drive input level meters / sidechain visualisations off this value. Returns 0 until the underlying node has been created (before the audio context is ready).
release: numberTime in seconds for the compressor to disengage after the signal drops below the threshold. Range 0..1, default 0.25.
threshold: numberLevel above which compression begins, in dBFS. Range −100..0, default −24.
Source