ContextQMD
Back to Content

DynamicsCompressorNode

files/en-us/web/api/dynamicscompressornode/index.md

latest3.0 KB
Original Source

{{ APIRef("Web Audio API") }}

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 {{domxref("AudioNode")}} that has exactly one input and one output.

{{InheritanceDiagram}}

<table class="properties"> <tbody> <tr> <th scope="row">Number of inputs</th> <td><code>1</code></td> </tr> <tr> <th scope="row">Number of outputs</th> <td><code>1</code></td> </tr> <tr> <th scope="row">Channel count mode</th> <td><code>"clamped-max"</code></td> </tr> <tr> <th scope="row">Channel count</th> <td><code>2</code></td> </tr> <tr> <th scope="row">Channel interpretation</th> <td><code>"speakers"</code></td> </tr> </tbody> </table>

Constructor

  • {{domxref("DynamicsCompressorNode.DynamicsCompressorNode", "DynamicsCompressorNode()")}}
    • : Creates a new instance of a DynamicsCompressorNode object.

Instance properties

Inherits properties from its parent, {{domxref("AudioNode")}}.

  • {{domxref("DynamicsCompressorNode.threshold")}} {{ReadOnlyInline}}
    • : A k-rate {{domxref("AudioParam")}} representing the decibel value above which the compression will start taking effect.
  • {{domxref("DynamicsCompressorNode.knee")}} {{ReadOnlyInline}}
    • : A k-rate {{domxref("AudioParam")}} containing a decibel value representing the range above the threshold where the curve smoothly transitions to the compressed portion.
  • {{domxref("DynamicsCompressorNode.ratio")}} {{ReadOnlyInline}}
    • : A k-rate {{domxref("AudioParam")}} representing the amount of change, in dB, needed in the input for a 1 dB change in the output.
  • {{domxref("DynamicsCompressorNode.reduction")}} {{ReadOnlyInline}}
    • : A float representing the amount of gain reduction currently applied by the compressor to the signal.
  • {{domxref("DynamicsCompressorNode.attack")}} {{ReadOnlyInline}}
    • : A k-rate {{domxref("AudioParam")}} representing the amount of time, in seconds, required to reduce the gain by 10 dB.
  • {{domxref("DynamicsCompressorNode.release")}} {{ReadOnlyInline}}
    • : A k-rate {{domxref("AudioParam")}} representing the amount of time, in seconds, required to increase the gain by 10 dB.

Instance methods

No specific methods; inherits methods from its parent, {{domxref("AudioNode")}}.

Example

See BaseAudioContext.createDynamicsCompressor() example code.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also