AudioNode.channelCountMode

The channelCountMode property of the AudioNode interface represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

The possible values of channelCountMode and their meanings are:

Value Description The following AudioNode children default to this value
max The number of channels is equal to the maximum number of channels of all connections. In this case, channelCount is ignored and only up-mixing happens. GainNode, DelayNode, ScriptProcessorNode, ChannelMergerNode, BiquadFilterNode, WaveShaperNode
clamped-max The number of channels is equal to the maximum number of channels of all connections, clamped to the value of channelCount. PannerNode, ConvolverNode, DynamicsCompressorNode
explicit The number of channels is defined by the value of channelCount. AudioDestinationNode, AnalyserNode, ChannelSplitterNode

Note: In older versions of the spec, the default for a ChannelSplitterNode was max.

Syntax

var oscillator = audioCtx.createOscillator();
oscillator.channelCountMode = 'explicit';

Value

A enumerated value representing a channelCountMode.

Example

var AudioContext = window.AudioContext || window.webkitAudioContext;

var audioCtx = new AudioContext();

var oscillator = audioCtx.createOscillator();
var gainNode = audioCtx.createGain();

oscillator.connect(gainNode);
gainNode.connect(audioCtx.destination);

oscillator.channelCountMode = 'explicit';

Specifications

Specification
Web Audio API
# dom-audionode-channelcountmode

Browser compatibility

BCD tables only load in the browser

See also