RTCPeerConnection.removeStream()

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);

Browser compatibility

See also

• WebRTC
• RTCPeerConnection.removeTrack()
• RTCPeerConnection.addTrack()
• RTCPeerConnection.addStream()