AudioParam: cancelScheduledValues() method
The cancelScheduledValues()
method of the AudioParam
Interface cancels all scheduled future changes to the AudioParam
.
Syntax
js
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.
Return value
A reference to this AudioParam
object. In some older implementations this
method returns undefined
.
Examples
js
const 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