AudioParam.cancelScheduledValues()

The cancelScheduledValues() method of the AudioParam Interface cancels all scheduled future changes to the AudioParam.

Syntax

var AudioParam = AudioParam.cancelScheduledValues(startTime)

Parameters

startTime
A double representing the time (in seconds) after the AudioContext was first created after which all scheduled changes will be cancelled.

Returns

A reference to this AudioParam object. In some older implementations this method returns void.

Examples

var gainNode = audioCtx.createGain();
gainNode.gain.setValueCurveAtTime(waveArray, audioCtx.currentTime, 2); //'gain' is the AudioParam
gainNode.gain.cancelScheduledValues(audioCtx.currentTime);

Specifications

Specification
Web Audio API
# dom-audioparam-cancelscheduledvalues

Browser compatibility

BCD tables only load in the browser

See also