MediaStream
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2017.
The MediaStream interface of the Media Capture and Streams API represents a stream of media content. A stream consists of several tracks, such as video or audio tracks. Each track is specified as an instance of MediaStreamTrack.
You can obtain a MediaStream object either by using the constructor or by calling functions such as MediaDevices.getUserMedia(), MediaDevices.getDisplayMedia(), or HTMLCanvasElement.captureStream() and HTMLMediaElement.captureStream().
Constructor
MediaStream()-
Creates and returns a new
MediaStreamobject. You can create an empty stream, a stream which is based upon an existing stream, or a stream that contains a specified list of tracks (specified as an array ofMediaStreamTrackobjects).
Instance properties
This interface inherits properties from its parent, EventTarget.
MediaStream.activeRead only-
A Boolean value that returns
trueif theMediaStreamis active, orfalseotherwise. MediaStream.idRead only-
A string containing a 36-character universally unique identifier (UUID) for the object.
Instance methods
This interface inherits methods from its parent, EventTarget.
MediaStream.addTrack()-
Stores a copy of the
MediaStreamTrackgiven as argument. If the track has already been added to theMediaStreamobject, nothing happens. MediaStream.clone()-
Returns a clone of the
MediaStreamobject. The clone will, however, have a unique value forid. MediaStream.getAudioTracks()-
Returns a list of the
MediaStreamTrackobjects stored in theMediaStreamobject that have theirkindattribute set toaudio. The order is not defined, and may not only vary from one browser to another, but also from one call to another. MediaStream.getTrackById()-
Returns the track whose ID corresponds to the one given in parameters,
trackId. If no parameter is given, or if no track with that ID does exist, it returnsnull. If several tracks have the same ID, it returns the first one. MediaStream.getTracks()-
Returns a list of all
MediaStreamTrackobjects stored in theMediaStreamobject, regardless of the value of thekindattribute. The order is not defined, and may not only vary from one browser to another, but also from one call to another. MediaStream.getVideoTracks()-
Returns a list of the
MediaStreamTrackobjects stored in theMediaStreamobject that have theirkindattribute set to"video". The order is not defined, and may not only vary from one browser to another, but also from one call to another. MediaStream.removeTrack()-
Removes the
MediaStreamTrackgiven as argument. If the track is not part of theMediaStreamobject, nothing happens.
Events
addtrack-
Fired when a new
MediaStreamTrackobject is added. removetrack-
Fired when a
MediaStreamTrackobject has been removed. active-
Fired when the MediaStream is activated.
inactive-
Fired when the MediaStream is inactivated.
Specifications
| Specification |
|---|
| Media Capture and Streams # mediastream |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
MediaStream
|
|
|
|
|
|
|
|
|
|
|
|
|
MediaStream() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
active
|
|
|
|
|
|
|
|
|
|
|
|
|
active event
|
|
|
|
|
|
|
|
|
|
|
|
|
addTrack
|
|
|
|
|
|
|
|
|
|
|
|
|
addtrack event
|
|
|
|
|
|
|
|
|
|
|
|
|
clone
|
|
|
|
|
|
|
|
|
|
|
|
|
getAudioTracks
|
|
|
|
|
|
|
|
|
|
|
|
|
getTrackById
|
|
|
|
|
|
|
|
|
|
|
|
|
getTracks
|
|
|
|
|
|
|
|
|
|
|
|
|
getVideoTracks
|
|
|
|
|
|
|
|
|
|
|
|
|
id
|
|
|
|
|
|
|
|
|
|
|
|
|
inactive event
|
|
|
|
|
|
|
|
|
|
|
|
|
removeTrack
|
|
|
|
|
|
|
|
|
|
|
|
|
removetrack event
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- Partial support
- Partial support
- No support
- No support
- Non-standard. Check cross-browser support before using.
- See implementation notes.
- Requires a vendor prefix or different name for use.
- Has more compatibility info.