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

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 14 webkit (Yes) 23 No support 15 webkit
22 (unprefixed)
6 webkit
Unprefixed (Yes) (Yes)        
Feature Android Android Webview Edge Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support No support ? (Yes) 25 1.2 No support No support webkit 28 webkit
Unprefixed ? (Yes) (Yes)           (Yes)

See also

Document Tags and Contributors

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