MDN’s new design is in Beta! A sneak peek: https://blog.mozilla.org/opendesign/mdns-new-design-beta/

RTCPeerConnection.removeStream()

Deprecated
This feature has been removed from the Web standards. Though some browsers may still support it, it is in the process of being dropped. Avoid using it and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The RTCPeerConnection.removeStream() method removes a MediaStream as a local source of audio or video. If the negotiation already happened, a new one will be needed for the remote peer to be able to use it. Because this method has been deprecated, you should instead use removeTrack() if your target browser versions have implemented it.

If the signalingState is set to "closed", an InvalidStateError is raised. If the signalingState is set to "stable", the event negotiationneeded is sent on the RTCPeerConnection.

Syntax

RTCPeerConnection.removeStream(mediaStream);

Parameters

mediaStream
A MediaStream specifying the stream to remove from the connection.

Return value

undefined.

Example

var pc, videoStream;
navigator.getUserMedia({video: true}, function(stream) {
  pc = new RTCPeerConnection();
  videoStream = stream;
  pc.addStream(stream);
}
document.getElementById("closeButton").addEventListener("click", function(event) {
  pc.removeStream(videoStream);
  pc.close();
}, false);

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCPeerConnection.removeStream()' in that specification.
Working Draft Initial specification.

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Microsoft Edge Opera Safari
Basic support (Yes) [1][2] (Yes) 18 (18)[3] No support ? (Yes) ?
Feature Android Webview Chrome for Android Edge Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support (Yes) [1][2] (Yes) [1][2] (Yes) 18 (18)[3] No support ? ?

[1] Though this method is not prefixed, the interface it belongs to was until Chrome 56.

[2] Chrome does not yet support removeTrack(), this method's replacement.

[3] This method was introduced in Firefox 18, deprecated in Firefox 22 (at which point it started throwing a NotSupportedError exception). The removeStream() method was removed outright in Firefox 51. You need to use the removeTrack() method instead.

See also

Document Tags and Contributors

 Contributors to this page: Sheppy, jpmedley, abbycar, Jib, teoli
 Last updated by: Sheppy,