Web/API/AudioScheduledSourceNode/stop

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

AudioScheduledSourceNode.stop([when]);

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

undefined

Exceptions

InvalidStateNode: The node has not been started by calling start().
RangeError: The value specified for when is negative.

Example

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);

/* Let's play a sine wave for one second. */

osc.start();
osc.stop(context.currentTime + 1);

Specifications

Specification	Status	Comment
Web Audio APIThe definition of 'stop()' in that specification.	Working Draft

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`stop`	Chrome Full support 14	Edge Full support 79	Firefox Full support 53	IE No support No	Opera Full support 15	Safari Full support 14	WebView Android Full support Yes	Chrome Android Full support 18	Firefox Android Full support 25	Opera Android Full support 14	Safari iOS Full support 14	Samsung Internet Android Full support 1.0

Legend

Full support: Full support
No support: No support