ChannelMergerNode()

The ChannelMergerNode() constructor creates a new ChannelMergerNode object instance.

Syntax

var myNode = new ChannelMergerNode(context, options);

Parameters

context

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

options Optional

A ChannelMergerOptions dictionary object defining the properties you want the ChannelMergerNode to have:

  • numberOfInputs: A number defining the number of inputs the ChannelMergerNode 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 ChannelMergerNode object instance.

Exceptions

InvalidStateError

An option such as channelCount or channelCountMode has been given an invalid value.

Example

var ac = new AudioContext();

var options = {
  numberOfInputs : 2
}

var myMerger = new ChannelMergerNode(ac, options);

Specifications

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

Browser compatibility

BCD tables only load in the browser