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 Status Comment
Web Audio API
The definition of 'cancelScheduledValues' in that specification.
Working Draft  

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic Support14 (Yes)25 No156
FeatureAndroidChrome for AndroidEdge mobileFirefox for AndroidIE mobileOpera AndroidiOS Safari
Basic Support (Yes)14 (Yes)26 No15 ?

See also

Document Tags and Contributors

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