Web/API/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",
  "channelInterpretation" : "discrete"
}

Properties

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 APIThe definition of 'AudioNodeOptions' in that specification.	Working Draft	Initial definition.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
AudioNodeOptions	Chrome Full support 55	Edge Full support ≤79	Firefox Full support 53	IE No support No	Opera Full support 42	Safari ?	WebView Android Full support 55	Chrome Android Full support 55	Firefox Android Full support 53	Opera Android Full support 42	Safari iOS ?	Samsung Internet Android Full support 6.0

Legend

Full support  

Full support

No support  

No support

Compatibility unknown  

Compatibility unknown

AudioNodeOptions by Mozilla Contributors is licensed under CC-BY-SA 2.5.