AudioNodeOptions

The AudioNodeOptions dictionary of the Web Audio API specifies options that can be used when creating new AudioNode objects.

AudioNodeOptions is inherited from by the option objects of the different types of audio node constructors. See for example AnalyserNode.AnalyserNode or GainNode.GainNode.

Syntax

var audioNodeOptions = {
  "channelCount" : 2,
  "channelCountMode" : "max",
  "chanelInterpretation" : "discrete"
}

Parameters

channelCount Optional
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 AudioNodeOptions.channelCountMode.
channelCountMode Optional
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 Optional
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.)

Specifications

Specification Status Comment
Web Audio API
The definition of 'AudioNodeOptions' in that specification.
Working Draft Initial definition.

Browser Compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 55.0 53 (53) ? 42 ?
Feature Android Android Webview Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support 55.0 53.0 (53) ? 42 ? 55.0

Document Tags and Contributors

 Contributors to this page: chrisdavidmills
 Last updated by: chrisdavidmills,