The ' MediaStreamTrack.stop()
' method stops the track.
Syntax
track.stop()
Description
Calling stop()
tells the user agent that the track's source—whatever that source may be, including files, network streams, or a local camera or microphone—is no longer needed by the MediaStreamTrack
. Since multiple tracks may use the same source (for example, if two tabs are using the device's microphone), the source itself isn't necessarily immediately stopped. It is instead disassociated from the track and the track object is stopped. Once no media tracks are using the source, the source may actually be completely stopped.
Immediately after calling stop()
, the readyState
property is set to ended
.
Examples
Stopping a video stream
In this example, we see a function which stops a streamed video by calling stop()
on every track on a given <video>
.
function stopStreamedVideo(videoElem) {
const stream = videoElem.srcObject;
const tracks = stream.getTracks();
tracks.forEach(function(track) {
track.stop();
});
videoElem.srcObject = null;
}
This works by obtaining the video element's stream from its srcObject
property. Then the stream's track list is obtained by calling its getTracks()
method. From there, all that remains to do is to iterate over the track list using forEach()
and calling each track's stop()
method.
Finally, srcObject
is set to null
to sever the link to the MediaStream
object so it can be released.
Specifications
Specification | Status | Comment |
---|---|---|
Media Capture and StreamsThe definition of 'MediaStreamTrack.stop()' in that specification. | Candidate Recommendation | Initial specification. |
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
stop
|
Chrome
Full support 61 |
Edge
Full support 12 |
Firefox
Full support 34 |
IE
No support No |
Opera
Full support 45 |
Safari
Full support Yes |
WebView Android
Full support 61 |
Chrome Android
Full support 61 |
Firefox Android
Full support 34 |
Opera Android
Full support 43 |
Safari iOS
Full support Yes |
Samsung Internet Android
Full support 8.0 |
Legend
- Full support
- Full support
- No support
- No support
See also
MediaStreamTrack
, the interface it belongs to.MediaStreamTrack.readyState
ended
MediaStreamTrack.stop() by Mozilla Contributors is licensed under CC-BY-SA 2.5.