W3cubDocs

/DOM

RTCPeerConnection.oniceconnectionstatechange

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

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 Browser
The definition of 'RTCPeerConnection.oniceconnectionstatechange' in that specification.
Working Draft Initial specification.

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari
Basic support (Yes) [1] (Yes) 24 (24) [2] No support (Yes) ?
Feature Android Chrome for Android Edge Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support ? ? (Yes) 24 (24) [2] No support ? ?

[1] Though this property is not prefixed, the interface it belongs to is.

[2] Although this property isn't prefixed, the RTCPeerConnection interface is prefixed as MozRTCPeerConnection until Firefox 44.

See also

© 2005–2017 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/oniceconnectionstatechange