W3cubDocs

/DOM

ChannelSplitterNode

The ChannelSplitterNode interface, often used in conjunction with its opposite, ChannelMergerNode, separates the different channels of an audio source into a set of mono outputs. This is useful for accessing each channel separately, e.g. for performing channel mixing where gain must be separately controlled on each channel.

If your ChannelSplitterNode always has one single input, the amount of outputs is defined by a parameter on its constructor and the call to AudioContext.createChannelSplitter(). In the case that no value is given, it will default to 6. If there are fewer channels in the input than there are outputs, supernumerary outputs are silent.

Number of inputs 1
Number of outputs variable; default to 6.
Channel count mode "explicit" Older implementations, as per earlier versions of the spec use "max".
Channel count Fixed to the number of outputs. Older implementations, as per earlier versions of the spec use 2 (not used in the default count mode).
Channel interpretation "speakers"

Constructor

ChannelSplitterNode()
Creates a new ChannelSplitterNode object instance.

Properties

No specific property; inherits properties from its parent, AudioNode.

Methods

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

Example

The following simple example shows how you could separate a stereo track (say, a piece of music), and process the left and right channel differently. To use them, you need to use the second and third parameters of the AudioNode.connect(AudioNode) method, which allow you to specify the index of the channel to connect from and the index of the channel to connect to.

var ac = new AudioContext();
ac.decodeAudioData(someStereoBuffer, function(data) {
 var source = ac.createBufferSource();
 source.buffer = data;
 var splitter = ac.createChannelSplitter(2);
 source.connect(splitter);
 var merger = ac.createChannelMerger(2);

 // Reduce the volume of the left channel only
 var gainNode = ac.createGain();
 gainNode.gain.value = 0.5;
 splitter.connect(gainNode, 0);

 // Connect the splitter back to the second input of the merger: we
 // effectively swap the channels, here, reversing the stereo image.
 gainNode.connect(merger, 0, 1);
 splitter.connect(merger, 1, 0);

 var dest = ac.createMediaStreamDestination();

 // Because we have used a ChannelMergerNode, we now have a stereo
 // MediaStream we can use to pipe the Web Audio graph to WebRTC,
 // MediaRecorder, etc.
 merger.connect(dest);
});

Specifications

Browser compatibility

Feature Chrome Edge Firefox Internet Explorer Opera Safari
Basic support 141 Yes 25 No 152 6
ChannelSplitterNode() constructor 55 ? 53 No 42 ?
Feature Android webview Chrome for Android Edge mobile Firefox for Android IE mobile Opera Android iOS Safari
Basic support 141 141 Yes 26 No 152 ?
ChannelSplitterNode() constructor 55 55 ? 53 No 42 ?

1. Starting in Chrome 56, channelCountMode is set to explicit and channelCount is fixed to the number of outputs, as per the latest spec.

2. Starting in Opera 43, channelCountMode is set to explicit and channelCount is fixed to the number of outputs, as per the latest spec.

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ChannelSplitterNode