RTCPeerConnection.onicecandidate

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for the proper prefixes to use 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 spec changes.

The RTCPeerConnection.onicecandidate event handler is a property containing the code to execute when the icecandidate event, of type RTCPeerConnectionIceEvent, is received by this RTCPeerConnection. Such an event is sent when a RTCIceCandidate object is added to the script.

SyntaxEdit

peerconnection.onicecandidate = function;

Values

  • function is the name of a user-defined function, without the () suffix or any parameters, or an anonymous function declaration, such as function(event) {...}. An event handler always has one single parameter, containing the event, here of type RTCPeerConnectionIceEvent. Note: the RTCPeerConnection.onicecandidate will be called once with an empty candidate property to signal the end of trickle ICE event.

ExampleEdit

pc.onicecandidate = function(ev) { alert("onicecandidate event detected: " + JSON.stringify(ev.candidate)); };

SpecificationsEdit

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

Browser compatibilityEdit

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support (Yes) [1] (Yes) [1] Not supported (Yes) ?

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

See alsoEdit

Document Tags and Contributors

 Contributors to this page: nils, teoli, Sheppy, rmnguleria
 Last updated by: nils,