AudioParam: cancelScheduledValues() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
cancelScheduledValues
Chrome – Partial support
Chrome 14 – 81 (Release date: 2011-09-16)
footnote Partial support
footnote Before Chrome 83, cancelScheduledValues() does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 40123334.
Chrome – Full support
Chrome 83 (Release date: 2020-05-19)
footnote Full support
Edge – Partial support
Edge 12 – 81 (Release date: 2015-07-29)
footnote Partial support
footnote Before Edge 83, cancelScheduledValues() does not cancel in-progress curve events created by setValueCurveAtTime().
Edge – Full support
Edge 83 (Release date: 2020-05-21)
footnote Full support
Firefox – Partial support
Firefox 25 (Release date: 2013-10-29)
footnote Partial support
footnote Does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 1752775.
Opera – Partial support
Opera 15 – 68 (Release date: 2013-07-02)
footnote Partial support
footnote Before Opera 69, cancelScheduledValues() does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 40123334.
Opera – Full support
Opera 69 (Release date: 2020-06-24)
footnote Full support
Safari – Partial support
Safari 6 – 14 (Release date: 2012-07-25)
footnote Partial support
footnote Before Safari 14.1, cancelScheduledValues() does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 216132.
Safari – Full support
Safari 14.1 (Release date: 2021-04-26)
footnote Full support
Chrome Android – Partial support
Chrome Android 18 – 81 (Release date: 2012-06-27)
footnote Partial support
footnote Before Chrome Android 83, cancelScheduledValues() does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 40123334.
Chrome Android – Full support
Chrome Android 83 (Release date: 2020-05-19)
footnote Full support
Firefox for Android – Partial support
Firefox for Android 25 (Release date: 2013-10-29)
footnote Partial support
footnote Does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 1752775.
Opera Android – Partial support
Opera Android 14 – 58 (Release date: 2013-05-21)
footnote Partial support
footnote Before Opera Android 59, cancelScheduledValues() does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 40123334.
Opera Android – Full support
Opera Android 59 (Release date: 2020-06-30)
footnote Full support
Safari on iOS – Partial support
Safari on iOS 6 – 14 (Release date: 2012-09-10)
footnote Partial support
footnote Before Safari on iOS 14.1, cancelScheduledValues() does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 216132.
Safari on iOS – Full support
Safari on iOS 14.5 (Release date: 2021-04-26)
footnote Full support
Samsung Internet – Partial support
Samsung Internet 1 – 12.1 (Release date: 2013-04-27)
footnote Partial support
footnote Before Samsung Internet 13.0, cancelScheduledValues() does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 40123334.
Samsung Internet – Full support
Samsung Internet 13 (Release date: 2020-12-02)
footnote Full support
WebView Android – Partial support
WebView Android 4.4 – 81 (Release date: 2013-12-09)
footnote Partial support
footnote Before WebView Android 83, cancelScheduledValues() does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 40123334.
WebView Android – Full support
WebView Android 83 (Release date: 2020-05-19)
footnote Full support
WebView on iOS – Partial support
WebView on iOS 6 – 14 (Release date: 2012-09-10)
footnote Partial support
footnote Before WebView on iOS 14.1, cancelScheduledValues() does not cancel in-progress curve events created by setValueCurveAtTime(). See bug 216132.
WebView on iOS – Full support
WebView on iOS 14.5 (Release date: 2021-04-26)
footnote Full support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Partial support
Partial support
Has more compatibility info.

See also