Web/API/MediaSource/endOfStream

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The endOfStream() method of the MediaSource interface signals the end of the stream.

Syntax

mediaSource.endOfStream(endOfStreamError);

Parameters

endOfStreamError Optional: A DOMString representing an error to throw when the end of the stream is reached. The possible values are:

network

Terminates playback and signals that a network error has occured. This can be used create a custom error handler related to media streams. For example, you might have a function that handles media chunk requests, separate from other network requests. When you make an XMLHttpRequest call for a media chunk, and onabort or onerror triggers, you might want to call endOfStream('network'), display a descriptive message in the UI, and maybe retry the network request immediately or wait until the network is back up (via some kind of polling.)
decode: Terminates playback and signals that a decoding error has occured. This can be used to indicate that a parsing error has occured while fetching media data; maybe the data is corrupt, or is encoded using a codec that the browser doesn't know how to decode.

Return value

undefined

Exceptions

Exception	Explanation
`InvalidStateError`	`MediaSource.readyState` is not equal to `open`, or one or more of the `SourceBuffer` objects in `MediaSource.sourceBuffers` are being updated (i.e. their `SourceBuffer.updating` property is `true`.)

Example

The following snippet is from a simple example written by Nick Desaulniers (view the full demo live, or download the source for further investigation.)

var assetURL = 'frag_bunny.mp4';
// Need to be specific for Blink regarding codecs
// ./mp4info frag_bunny.mp4 | grep Codec
var mimeCodec = 'video/mp4; codecs="avc1.42E01E, mp4a.40.2"';

if ('MediaSource' in window && MediaSource.isTypeSupported(mimeCodec)) {
  var mediaSource = new MediaSource;
  //console.log(mediaSource.readyState); // closed
  video.src = URL.createObjectURL(mediaSource);
  mediaSource.addEventListener('sourceopen', sourceOpen);
} else {
  console.error('Unsupported MIME type or codec: ', mimeCodec);
}

function sourceOpen (_) {
  //console.log(this.readyState); // open
  var mediaSource = this;
  var sourceBuffer = mediaSource.addSourceBuffer(mimeCodec);
  fetchAB(assetURL, function (buf) {
    sourceBuffer.addEventListener('updateend', function (_) {
      mediaSource.endOfStream();
      video.play();
      //console.log(mediaSource.readyState); // ended
    });
    sourceBuffer.appendBuffer(buf);
  });
};

Specifications

Specification	Status	Comment
Media Source ExtensionsThe definition of 'endOfStream()' in that specification.	Recommendation	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`endOfStream` Experimental'	Chrome Full support 23	Edge Full support 12	Firefox Full support 42 Full support 42 No support 25 — 42 Notes' Disabled' Notes' Limited support to an allowed list of sites, for example YouTube, Netflix, and other popular streaming sites. The limitation was removed when Media Source Extensions was enabled by default in Firefox 42. Disabled' From version 25 until version 42 (exclusive): this feature is behind the `media.mediasource.enabled` preference. To change preferences in Firefox, visit about:config.	IE Full support 11 Notes' Full support 11 Notes' Notes' Only works on Windows 8+.	Opera Full support 15	Safari Full support 8	WebView Android Full support 4.4.3	Chrome Android Full support 25	Firefox Android Full support 41	Opera Android Full support 14	Safari iOS No support No	Samsung Internet Android Full support 1.5

Legend

Full support: Full support
No support: No support
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.
See implementation notes.': See implementation notes.
User must explicitly enable this feature.': User must explicitly enable this feature.