DynamicsCompressorNode: DynamicsCompressorNode() constructor
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2021.
TheDynamicsCompressorNode()constructor creates a newDynamicsCompressorNode object which providesa compression effect, which lowers the volume of the loudest parts of thesignal, in order to help prevent clipping and distortion. That can occur whenmultiple sounds are played and multiplexed together at once.
In this article
Syntax
new DynamicsCompressorNode(context, options)Parameters
contextA reference to an
AudioContext.optionsOptionalOptions are as follows:
attackThe amount of time (in seconds) to reduce the gain by 10dB.Its default value is 0.003. This parameter is k-rate. Its nominal range is [0, 1].
kneeA decibel value representing the range above the thresholdwhere the curve smoothly transitions to the "ratio" portion. Its default value is30. This parameter is k-rate. Its nominal range is [0, 40].
ratioThe amount of dB change in input for a 1 dB change inoutput. Its default value is 12. This parameter is k-rate. Its nominal range is[1, 20].
releaseThe amount of time (in seconds) to increase the gain by 10dB. Itsdefault value is 0.250. This parameter is k-rate. Its nominal range is [0, 1].
thresholdThe decibel value above which the compression will start takingeffect. Its default value is -24. This parameter is k-rate. Its nominal range is[-100, 0].
Specifications
| Specification |
|---|
| Web Audio API> # dom-dynamicscompressornode-dynamicscompressornode> |