Back to Content

ChannelSplitterNode

files/en-us/web/api/channelsplitternode/index.md

latest2.4 KB
Original Source

{{APIRef("Web Audio API")}}

The ChannelSplitterNode interface, often used in conjunction with its opposite, {{domxref("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 {{domxref("BaseAudioContext/createChannelSplitter", "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.

{{InheritanceDiagram}}

<table class="properties"> <tbody> <tr> <th scope="row">Number of inputs</th> <td><code>1</code></td> </tr> <tr> <th scope="row">Number of outputs</th> <td>variable; defaults to <code>6</code>.</td> </tr> <tr> <th scope="row">Channel count mode</th> <td> <code>"explicit"</code>. Older implementations, as per earlier versions of the spec use <code>"max"</code>. </td> </tr> <tr> <th scope="row">Channel count</th> <td> Fixed to the number of outputs. Older implementations, as per earlier versions of the spec use <code>2</code> (not used in the default count mode). </td> </tr> <tr> <th scope="row">Channel interpretation</th> <td><code>"discrete"</code></td> </tr> </tbody> </table>

Constructor

  • {{domxref("ChannelSplitterNode.ChannelSplitterNode()","ChannelSplitterNode()")}}
    • : Creates a new ChannelSplitterNode object instance.

Instance properties

No specific property; inherits properties from its parent, {{domxref("AudioNode")}}.

Instance methods

No specific method; inherits methods from its parent, {{domxref("AudioNode")}}.

Example

See BaseAudioContext.createChannelSplitter() for example code.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also