RTCPeerConnection.onicecandidateerror

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.onicecandidateerror property is an EventHandler which specifies a function which is called to handle the icecandidateerror event when it occurs on an RTCPeerConnection instance. This event is fired when an error occurs during the ICE candidate gathering process.

Syntax

RTCPeerConnection.onicecandidateerror = eventHandler;

Value

This should be set to a function you provide which is passed a single parameter: an RTCPeerConnectionIceErrorEvent object describing the icecandidateerror event. The event offers properties describing the error to help you handle it appropriately.

Example

pc.onicecandidateerror = function(event) {
  if (event.errorCode >= 300 && event.errorCode <= 699) {
    // STUN errors are in the range 300-699. See RFC 5389, section 15.6
    // for a list of codes. TURN adds a few more error codes; see
    // RFC 5766, section 15 for details.
  } else if (event.errorCode >= 700 && event.errorCode <= 799) {
    // Server could not be reached; a specific error number is
    // provided but these are not yet specified.
}

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browser
The definition of 'RTCPeerConnection.onicecandidateerror' in that specification.
Working Draft Initial specification.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support No support No support No support No support No support
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support No support No support No support No support No support No support

See also

Document Tags and Contributors

 Contributors to this page: Sheppy
 Last updated by: Sheppy,