AudioParam: cancelScheduledValues() メソッド

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.

cancelScheduledValues() は AudioParam インターフェイスのメソッドで、 AudioParam に予定されている将来の変更をすべて取り消します。

構文

js
cancelScheduledValues(startTime)

引数

startTime

AudioContext が最初に作成されてから、スケジュールされた変更がすべて取り消されるまでの時間（秒単位）を表します。

返値

この AudioParam オブジェクトへの参照です。古い実装では、このメソッドは undefined を返します。

例

js
const gainNode = audioCtx.createGain();
gainNode.gain.setValueCurveAtTime(waveArray, audioCtx.currentTime, 2); // 'gain' は AudioParam
gainNode.gain.cancelScheduledValues(audioCtx.currentTime);

仕様書

Specification
Web Audio API
# dom-audioparam-cancelscheduledvalues

ブラウザーの互換性

BCD tables only load in the browser

関連情報