Web/API/MediaStream/active

The active read-only property of the MediaStream interface returns a Boolean value which is true if the stream is currently active; otherwise, it returns false. A stream is considered active if at least one of its MediaStreamTracks is not in the MediaStreamTrack.ended state. Once every track has ended, the stream's active property becomes false.

Syntax

const isActive = MediaStream.active;

Value

A Boolean value which is true if the stream is currently active; otherwise, the value is false.

Example

In this example, a new stream whose source is the user's local camera and microphone is requested using getUserMedia(). When that stream becomes available (that is, when the returned Promise is fulfilled, a button on the page is updated based on whether or not the stream is currently active.

const promise = navigator.mediaDevices.getUserMedia({ 
  audio: true, 
  video: true 
});

promise.then((stream) => {
  const startBtn = document.querySelector('#startBtn');
  startBtn.disabled = stream.active; 
});

Specifications

Specification	Status	Comment
Media Capture and StreamsThe definition of 'active' in that specification.	Candidate Recommendation	Initial definition.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

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
active	Chrome Full support 45	Edge Full support 12	Firefox Full support 52	IE No support No	Opera No support No	Safari Full support Yes	WebView Android Full support 45	Chrome Android Full support 45	Firefox Android Full support 52	Opera Android No support No	Safari iOS Full support Yes	Samsung Internet Android Full support 5.0

Legend

Full support  

Full support

No support  

No support

active by Mozilla Contributors is licensed under CC-BY-SA 2.5.