This method has been deprecated; you should, compatibility allowing [2], switch to using the removeTrack()
method instead.
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.
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
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 Browser The definition of 'RTCPeerConnection.removeStream()' in that specification. |
Working Draft | Initial specification. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Microsoft Edge | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | (Yes) [1][2] | 18 (18)[3] | No support | ? | (Yes) | ? |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | ? | ? | 18 (18)[3] | No support | ? | ? |
[1] Though this property is not prefixed, the interface it belongs to is.
[2] Chrome does not yet support addTrack()
, 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.