Firefox Tomorrow

web api interface

GainNode

View on MDN ↗

The GainNode interface represents a change in volume. It is an AudioNode audio-processing module that causes a given gain to be applied to the input data before its propagation to the output. A GainNode always has exactly one input and one output, both with the same number of channels.

The gain is a unitless value, changing with time, that is multiplied to each corresponding sample of all input channels. If modified, the new gain is instantly applied, causing unaesthetic ‘clicks’ in the resulting audio. To prevent this from happening, never change the value directly but use the exponential interpolation methods on the AudioParam interface.

The GainNode is increasing the gain of the output.

Number of inputs 1
Number of outputs 1
Channel count mode "max"
Channel count 2 (not used in the default count mode)
Channel interpretation "speakers"

Constructor

Instance properties

Inherits properties from its parent, AudioNode.

  • gain Read only
    • : An a-rate AudioParam representing the amount of gain to apply. You have to set value or use the methods of AudioParam to change the effect of gain.

Instance methods

No specific method; inherits methods from its parent, AudioNode.

Example

See BaseAudioContext.createGain() for example code showing how to use an AudioContext to create a GainNode.

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also