GainNode()

The GainNode() constructor of the Web Audio API creates a new GainNode object which an AudioNode that represents a change in volume.

Note: You should typically call BaseAudioContext.createGain to create a gain node.

Syntax

var gainNode = new GainNode(context, options)

Parameters

Inherits parameters from the AudioNodeOptions dictionary.

context
A reference to an AudioContext.
options Optional
Options are as follows:
  • gain: The amount of gain to apply. This parameter is a-rate and it's nominal range is (-∞,+∞). The default is 1.

Return value

A new GainNode object instance.

Specifications

Specification Status Comment
Web Audio API
The definition of 'GainNode()' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser