This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The RTCPeerConnection.close()
method closes the current peer connection.
Syntax
peerConnection.close();
This method has no parameters, and returns nothing.
Calling this method terminates the RTCPeerConnection's ICE agent, ending any ongoing ICE processing and any active streams. This also releases any resources in use by the ICE agent, including TURN permissions. All RTCRtpSender
objects are considered to be stopped once this returns (they may still be in the process of stopping, but for all intents and purposes, they're stopped).
Once this method returns, the signaling state as returned by RTCPeerConnection.signalingState
is closed
.
Make sure that you delete
all references to the previous RTCPeerConnection
before attempting to create a new one that connects to the same remote peer, as not doing so might result in some errors depending on the browser.
Example
var pc = new RTCPeerConnection(); var dc = pc.createDataChannel("my channel"); dc.onmessage = function (event) { console.log("received: " + event.data); pc.close(); // We decided to close after the first received message }; dc.onopen = function () { console.log("datachannel open"); }; dc.onclose = function () { console.log("datachannel close"); };
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCPeerConnection.close()' in that specification. |
Candidate Recommendation | Initial specification. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
close | Chrome Full support 23 | Edge Full support 15 | Firefox Full support Yes | IE No support No | Opera Full support Yes | Safari Full support 11 | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android Full support Yes |
Legend
- Full support
- Full support
- No support
- No support