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 non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.
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
js
removeStream(mediaStream)
Parameters
mediaStream
-
A
MediaStream
specifying the stream to remove from the connection.
Return value
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();
},
false
);
Browser compatibility
BCD tables only load in the browser