ChannelSplitterNode()

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

var splitter = new ChannelSpitterNode(context, options);

Parameters

context

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

options Optional

A ChannelSplitterOptions dictionary object defining the properties you want the ChannelSplitterNode to have:

  • numberOfOutputs: A number defining the number of inputs the ChannelSplitterNode should have. If not specified, the default value used is 6.
  • channelCount: Represents 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: Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs. (See AudioNode.channelCountMode for more information including default values.)
  • channelInterpretation: Represents an enumerated value 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.

Example

var ac = new AudioContext();

var options = {
  numberOfOutputs : 2
}

var mySplitter = new ChannelSplitterNode(ac, options);

Specifications

Specification
Web Audio API
# dom-channelsplitternode-constructor-channelsplitternode

Browser compatibility

BCD tables only load in the browser