AudioScheduledSourceNode.onended

The onended event handler for the AudioScheduledSourceNode interface specifies an EventHandler to be executed when the ended event occurs on the node. This event is sent to the node when the concrete interface (such as AudioBufferSourceNode, OscillatorNode, or ConstantSourceNode) determines that it has stopped playing.

The ended event is only sent to a node configured to loop automatically when the node is stopped using its stop() method. This is the case, for example, when using an AudioBufferSourceNode with its loop property set to true.

Syntax

AudioScheduledSourceNode.onended = EventHandler;

Value

A function which is called by the browser when the ended event occurs on the AudioScheduledSourceNode. The function receives as input a single parameter, which is an object of type Event describing the event that occurred.

Examples

In this simple example, an event listener for the ended event is set up to enable a "Start" button in the user interface when the node stops playing.

node.onended = function(event) {
  document.getElementById("startButton").disabled = false;
}

Specifications

Specification Status Comment
Web Audio API
The definition of 'onended' in that specification.
Working Draft Initial specification.

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
onendedChrome Full support 14Edge Full support ≤79Firefox Full support 53IE No support NoOpera Full support 15Safari ? WebView Android Full support YesChrome Android Full support 18Firefox Android Full support 25Opera Android Full support 14Safari iOS ? Samsung Internet Android Full support 1.0

Legend

Full support
Full support
No support
No support
Compatibility unknown
Compatibility unknown

See also