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.
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 itscurrentTime
attribute. Omitting this parameter, specifying a value of 0, or passing a negative value causes the sound to stop playback immediately.
Return value
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
Specification | Status | Comment |
---|---|---|
Web Audio API The definition of 'stop()' in that specification. |
Working Draft |
Browser compatibility
Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|---|
Basic support | 56.0[1] | ? | 53 (53) | No support | 43[1] | ? |
Feature | Android Webview | Edge | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|---|
Basic support | 56.0[1] | ? | 53.0 (53) | ? | ? | 43[1] | ? | 56.0[1] |
[1] Chrome and Opera implement this method on the ConstantSourceNode
interface.