DynamicsCompressorNode
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
The DynamicsCompressorNode interface provides a compression effect, which lowers the volume of the loudest parts of the signal in order to help prevent clipping and distortion that can occur when multiple sounds are played and multiplexed together at once. This is often used in musical production and game audio. DynamicsCompressorNode is an AudioNode that has exactly one input and one output.
| Number of inputs | 1 |
|---|---|
| Number of outputs | 1 |
| Channel count mode | "clamped-max" |
| Channel count | 2 |
| Channel interpretation | "speakers" |
Constructor
DynamicsCompressorNode()-
Creates a new instance of a
DynamicsCompressorNodeobject.
Instance properties
Inherits properties from its parent, AudioNode.
DynamicsCompressorNode.thresholdRead only-
A k-rate
AudioParamrepresenting the decibel value above which the compression will start taking effect. DynamicsCompressorNode.kneeRead only-
A k-rate
AudioParamcontaining a decibel value representing the range above the threshold where the curve smoothly transitions to the compressed portion. DynamicsCompressorNode.ratioRead only-
A k-rate
AudioParamrepresenting the amount of change, in dB, needed in the input for a 1 dB change in the output. DynamicsCompressorNode.reductionRead only-
A
floatrepresenting the amount of gain reduction currently applied by the compressor to the signal. DynamicsCompressorNode.attackRead only-
A k-rate
AudioParamrepresenting the amount of time, in seconds, required to reduce the gain by 10 dB. DynamicsCompressorNode.releaseRead only-
A k-rate
AudioParamrepresenting the amount of time, in seconds, required to increase the gain by 10 dB.
Instance methods
No specific methods; inherits methods from its parent, AudioNode.
Example
See BaseAudioContext.createDynamicsCompressor() example code.
Specifications
| Specification |
|---|
| Web Audio API # DynamicsCompressorNode |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
DynamicsCompressorNode
|
|
|
|
|
|
|
|
|
|
|
|
|
DynamicsCompressorNode() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
attack
|
|
|
|
|
|
|
|
|
|
|
|
|
knee
|
|
|
|
|
|
|
|
|
|
|
|
|
ratio
|
|
|
|
|
|
|
|
|
|
|
|
|
reduction
|
|
|
|
|
|
|
|
|
|
|
|
|
release
|
|
|
|
|
|
|
|
|
|
|
|
|
threshold
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- See implementation notes.