RTCPeerConnection.onicecandidateerror

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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 Browsers
The definition of 'RTCPeerConnection.onicecandidateerror' in that specification.
Candidate Recommendation Initial specification.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic supportChrome ? Edge ? Firefox ? IE ? Opera ? Safari ? WebView Android ? Chrome Android ? Edge Mobile ? Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?

Legend

Compatibility unknown  
Compatibility unknown

See also

Document Tags and Contributors

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