AudioScheduledSourceNode: stop() method
The stop()
method on AudioScheduledSourceNode
schedules a sound to cease playback at the specified time. If no time is specified, then the sound stops playing immediately.
Each time you call stop()
on the same node, the specified time replaces any previously-scheduled stop time that hasn't occurred yet. If the node has already stopped, this method has no effect.
Note: If a scheduled stop time occurs before the node's scheduled start time, the node never starts to play.
Syntax
Parameters
when
Optional
-
The time, in seconds, at which the sound should stop playing. This value is specified in the same time coordinate system as the AudioContext
is using for its currentTime
attribute. Omitting this parameter, specifying a value of 0, or passing a negative value causes the sound to stop playback immediately.
Return value
Exceptions
InvalidStateNode
DOMException
-
Thrown if the node has not been started by calling start()
.
-
RangeError
-
Thrown if the value specified for when
is negative.
Examples
This example demonstrates starting an oscillator node, scheduled to begin playing at once and to stop playing in one second. The stop time is determined by taking the audio context's current time from AudioContext.currentTime
and adding 1 second.
context = new AudioContext();
osc = context.createOscillator();
osc.connect(context.destination);
osc.start();
osc.stop(context.currentTime + 1);
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
stop |
24 |
12 |
25 |
No |
15 |
7 |
4.4 |
25 |
25 |
14 |
7 |
1.5 |
See also