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 class (such as AudioBufferSourceNode, OscillatorNode, or ConstantSourceNode) determines that it has stopped playing.

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.

Example

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

[1] Chrome and Opera implement this event handler on the ConstantSourceNode interface.

See also

• The ended event and its type, Event.
• AudioScheduledSourceNode
• Web Audio API