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 MediaStreamTrack
s is not in the MediaStreamTrack.ended
state. Once every track has ended, the stream's active
property becomes false
.
Syntax
var 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.
var promise = navigator.mediaDevices.getUserMedia({ audio: true, video: true }); promise.then(function(stream) { var startBtn = document.querySelector('#startBtn'); startBtn.disabled = stream.active; };)
Specifications
Specification | Status | Comment |
---|---|---|
Media Capture and Streams The 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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
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