This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The RTCPeerConnection.oniceconnectionstatechange
property is an event handler which specifies a function to be called when the iceconnectionstatechange
event is fired on an RTCPeerConnection
instance. This happens when the state of the connection's ICE agent, as represented by the iceConnectionState
property, changes.
Syntax
RTCPeerConnection.oniceconnectionstatechange = eventHandler;
Value
This event handler can be set to function which is passed a single input parameter: an Event
object describing the iceconnectionstatechange
event which occurred. Your code can look at the value of RTCPeerConnection.iceConnectionState
to determine what the new state is.
Example
The example below watches the state of the ICE agent for a failure or unexpected closure and takes appropriate action, such as presenting an error message or attempting to restart the ICE agent.
pc.oniceconnectionstatechange = function(event) { if (pc.iceConnectionState === "failed" || pc.iceConnectionState === "disconnected" || pc.iceConnectionState === "closed") { // Handle the failure } };
Of course, "disconnected" and "closed" don't necessarily indicate errors; these can be the result of normal ICE negotiation, so be sure to handle these properly (if at all).
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCPeerConnection.oniceconnectionstatechange' in that specification. |
Candidate Recommendation | Initial specification. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
oniceconnectionstatechange | Chrome Full support 28 | Edge Full support 15 | Firefox Full support 22 | IE No support No | Opera
Full support
43
| Safari Full support 11 | WebView Android Full support Yes | Chrome Android Full support 28 | Firefox Android Full support 44 | Opera Android
Full support
43
| Safari iOS Full support Yes | Samsung Internet Android Full support 6.0 |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
- See implementation notes.
See also
- The
iceconnectionstatechange
event and its type,Event
.