GainNode: GainNode() 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.
The GainNode() constructor of the Web Audio API creates a new
GainNode object which is an AudioNode that represents a
change in volume.
Syntax
new GainNode(context, options)
Parameters
context-
A reference to a
BaseAudioContext, e.g., anAudioContext. optionsOptional-
Options are as follows:
gain-
The amount of gain to apply. This parameter is a-
rateand it's nominal range is (-∞,+∞). The default is1. channelCount-
Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. (See
AudioNode.channelCountfor more information.) Its usage and precise definition depend on the value ofchannelCountMode. channelCountMode-
Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs. (See
AudioNode.channelCountModefor more information including default values.) channelInterpretation-
Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen. The possible values are
"speakers"or"discrete". (SeeAudioNode.channelCountModefor more information including default values.)
Return value
A new GainNode object instance.
Specifications
| Specification |
|---|
| Web Audio API # dom-gainnode-gainnode |
Browser compatibility
Loading…