ChannelSplitterNode: ChannelSplitterNode() constructor

The ChannelSplitterNode() constructor of the Web Audio API creates a new ChannelSplitterNode object instance, representing a node that splits the input into a separate output for each of the source node's audio channels.

Syntax

new ChannelSplitterNode(context)
new ChannelSplitterNode(context, options)

Parameters

context

A BaseAudioContext representing the audio context you want the node to be associated with.

options Optional

An object defining the properties you want the ChannelSplitterNode to have:

numberOfOutputs Optional

A number defining the number of outputs the ChannelSplitterNode should have. If not specified, the default value used is 6.

channelCount Optional

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.channelCount for more information.) Its usage and precise definition depend on the value of channelCountMode.

channelCountMode Optional

A string describing the way channels must be matched between the node's inputs and outputs. (See AudioNode.channelCountMode for more information including default values.)

channelInterpretation Optional

A string 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". (See AudioNode.channelCountMode for more information including default values.)

Return value

A new ChannelSplitterNode object instance.

Examples

const ac = new AudioContext();

const options = {
  numberOfOutputs: 2,
};

const mySplitter = new ChannelSplitterNode(ac, options);

Specifications

Browser compatibility