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.

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

TypeError

The value specified for when is negative.

Example

ac = new AudioContext();
os = ac.createOscillator();
os.connect(ac.destination);
/* Let's play a sine wave for one second. */
os.start();
os.stop(ac.currentTime + 1);

Specifications

Browser compatibility

See also

• Using the Web Audio API
• AudioScheduledSourceNode
• AudioBufferSourceNode
• ConstantSourceNode
• OscillatorNode