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
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
onicecandidateerror | Chrome No support No | Edge No support No | Firefox ? | IE No support No | Opera ? | Safari ? | WebView Android No support No | Chrome Android No support No | Firefox Android ? | Opera Android ? | Safari iOS ? | Samsung Internet Android No support No |
Legend
- No support
- No support
- Compatibility unknown
- Compatibility unknown
See also
- The
icecandidateerror
event and its type,RTCPeerConnectionIceErrorEvent
.