AudioNode: disconnect() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2021.

AudioNode インターフェイスの disconnect() メソッドは、このメソッドが呼ばれたノードから 1 個または複数のノードを切断します。

構文

js
disconnect()

引数

disconnect() メソッドには、切断するノードを決めるための引数の異なる組み合わせを受け付けるいくつかのバージョンがあります。引数が渡されない場合は、すべての出力の接続が切断されます。

destination 省略可

切断する 1 個または複数のノードを表す AudioNode または AudioParam です。値が AudioNode の場合は、切断する対象の 1 個のノードを表し、他の任意の引数 (output および input) によって切断する入力や出力を絞り込むことができます。値が AudioParam の場合は、この AudioParam への接続が終了し、変更が反映されるとこのパラメーターの計算におけるこのノードの担当部分は 0 になります。

output 省略可

この AudioNode のどの出力を切断するかを表すインデックスです。インデックス番号は出力のチャンネル数に基づいて決められます。(オーディオチャンネルを参照してください)

input 省略可

指定の出力先 AudioNode へのどの入力を切断するかを表すインデックスです。インデックス番号は入力のチャンネル数に基づいて決められます。(オーディオチャンネルを参照してください)

返値

なし (undefined)

例外

IndexSizeError DOMException

input または output として指定された値が無効な (存在しないノードを指しているか、許される範囲の外である) とき投げられます。

InvalidAccessError DOMException

disconnect() が呼ばれたノードが指定された destination ノードに接続されていないとき投げられます。

例

js
const AudioContext = window.AudioContext || window.webkitAudioContext;

const audioCtx = new AudioContext();

const oscillator = audioCtx.createOscillator();
const gainNode = audioCtx.createGain();

oscillator.connect(gainNode);
gainNode.connect(audioCtx.destination);

gainNode.disconnect();

仕様書

Specification
Web Audio API
# dom-audionode-disconnect

ブラウザーの互換性

BCD tables only load in the browser

関連情報