MediaStreamTrack.stop()

In short, the MediaStreamTrack method stop() method stops the track.

Syntax

MediaStreamTrack.stop();

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 track state is set to ended.

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) {
  let stream = videoElem.srcObject;
  let 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 Streams
The definition of 'MediaStreamTrack.stop()' in that specification.
Candidate Recommendation Initial specification.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic supportChrome Full support 61Edge Full support 12Firefox Full support 34IE No support NoOpera Full support 45Safari ? WebView Android Full support 61Chrome Android Full support 61Edge Mobile Full support YesFirefox Android Full support 34Opera Android Full support 45Safari iOS ? Samsung Internet Android No support No

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown

See also

Document Tags and Contributors

Contributors to this page: Sheppy, fscholz, rslhdyt, pehrsons, libbymc, jpmedley, teoli
Last updated by: Sheppy,