MediaStreamTrack.onended

The MediaStreamTrack.onended event handler is used to specify a function which serves as an event handler to be called when the ended event occurs on the track. This event occurs when the track will no longer provide data to the stream for any reason, including the end of the media input being reached, the user revoking needed permissions, the source device being removed, or the remote peer ending a connection.

Syntax

MediaStreamTrack.onended = function;

Value

A function to serve as an event handler for the ended event. The event handler function receives a single parameter: the event object, which is a simple Event object.

Examples

This example sets up an event handler for the ended event which changes an on-screen icon to indicate that the track is no longer active.

track.onended = function(event) {
  let statusElem = document.getElementById("status-icon");

  statusElem.src = "/images/stopped-icon.png";
}

Specifications

Specification
Media Capture and Streams
# dom-mediastreamtrack-onended

Browser compatibility

BCD tables only load in the browser

See also