AudioNode.disconnect()
The disconnect()
method of the AudioNode
interface lets you disconnect one or more nodes from the node on which the method is called.
Syntax
JavaScript
Copy Code
AudioNode.disconnect(); AudioNode.disconnect(output); AudioNode.disconnect(destination); AudioNode.disconnect(destination, output); AudioNode.disconnect(destination, output, input);
Return value
Parameters
There are several versions of the disconnect()
method, which accept different combinations of parameters to control which nodes to disconnect from.
destination
Optional- An
AudioNode
orAudioParam
specifying the node or nodes to disconnect from. If this value is anAudioNode
, a single node is disconnected from, with any other, optional, parameters (output
and/orinput
) further limiting which inputs and/or outputs should be disconnected. If this value is anAudioParam
, then the connection to thatAudioParam
is terminated, and the node's contributions to that computed parameter become 0 going forward once the change takes effect. If no matching connection is found, anInvalidAccessError
exception is thrown. output
Optional- An index describing which output from the current
AudioNode
is to be disconnected. The index numbers are defined according to the number of output channels (see Audio channels). If this parameter is out-of-bound, anIndexSizeError
exception is thrown. input
Optional- An index describing which input into the specified destination
AudioNode
is to be disconnected. The index numbers are defined according to the number of input channels (see Audio channels). If this parameter is out-of-bound, anIndexSizeError
exception is thrown.
Exceptions
IndexSizeError
- A value specified for
input
oroutput
is invalid, referring to a node which doesn't exist or outside the permitted range. InvalidAccessError
- The node on which
disconnect()
was called isn't connected to the specifieddestination
node.
Example
JavaScript
Copy Code
var AudioContext = window.AudioContext || window.webkitAudioContext; var audioCtx = new AudioContext(); var oscillator = audioCtx.createOscillator(); var gainNode = audioCtx.createGain(); oscillator.connect(gainNode); gainNode.connect(audioCtx.destination); gainNode.disconnect();
Specifications
Specification | Status | Comment |
---|---|---|
Web Audio API The definition of 'disconnect' in that specification. |
Working Draft |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | 10.0webkit | 25 (25) | No support | 15.0webkit 22 (unprefixed) |
(Yes) |
destination and input parameters |
43.0 | No support | ? | ? | ? |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | Firefox OS (Gecko) | IE Phone | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|---|
Basic support | ? | ? | 25.0 (25) | 1.2 | ? | ? | ? | ? |
destination and input parameters | No support | No support | No support | No support | ? | ? | ? | 43.0 |
See also
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/audionode/disconnect