AudioParam.cancelScheduledValues()

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

SyntaxEdit

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 browsers older implementations of this interface return void.

ExamplesEdit

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

SpecificationsEdit

Specification Status Comment
Web Audio API
The definition of 'cancelScheduledValues' in that specification.
Working Draft  

Browser compatibilityEdit

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 14 webkit 23 Not supported 15 webkit
22 (unprefixed)
6 webkit
Unprefixed (Yes)        

See alsoEdit

Document Tags and Contributors

 Contributors to this page: jpmedley, fscholz, chrisdavidmills
 Last updated by: jpmedley,