RTCPeerConnection: removeStream() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. 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.

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

The removeStream() method of the RTCPeerConnection interface 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

js
removeStream(mediaStream)

Parameters

mediaStream

A MediaStream specifying the stream to remove from the connection.

Return value

undefined.

Example

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

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
removeStream
Deprecated Non-standard
Chrome – Full support
Chrome 24 (Release date: 2013-01-10)
footnote
footnote See bug 40508568
Edge – Full support
Edge 15 (Release date: 2017-04-05)
footnote Full support
Firefox – No support
Firefox 22 – 50 (Release date: 2013-06-25)
footnote Removed in 51 and later
Opera – Full support
Opera 15 (Release date: 2013-07-02)
footnote Full support
Safari – No support
Safari 11 – 11.1 (Release date: 2017-09-19)
footnote Removed in 12 and later
Chrome Android – Full support
Chrome Android 25 (Release date: 2013-02-27)
footnote
footnote See bug 40508568
Firefox for Android – No support
Firefox for Android 24 – 50 (Release date: 2013-09-17)
footnote Removed in 51 and later
Opera Android – Full support
Opera Android 14 (Release date: 2013-05-21)
footnote Full support
Safari on iOS – No support
Safari on iOS 11 – 11.3 (Release date: 2017-09-19)
footnote Removed in 12 and later
Samsung Internet – Full support
Samsung Internet 1.5 (Release date: 2013-09-25)
footnote Full support
WebView Android – Full support
WebView Android 4.4 (Release date: 2013-12-09)
footnote
footnote See bug 40508568
WebView on iOS – No support
WebView on iOS 11 – 11.3 (Release date: 2017-09-19)
footnote Removed in 12 and later

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Non-standard. Check cross-browser support before using.
Deprecated. Not for use in new websites.
See implementation notes.

See also