RTCPeerConnectionIceEvent

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

The RTCPeerConnectionIceEvent interface represents events that occurs in relation to ICE candidates with the target, usually an RTCPeerConnection. Only one event is of this type: icecandidate.

Properties

A RTCPeerConnectionIceEvent being an Event, this event also implements these properties.

RTCPeerConnectionIceEvent.candidate Read only
Contains the RTCIceCandidate containing the candidate associated with the event.

Constructors

RTCPeerConnectionIceEvent()
Returns a new RTCPeerConnectionIceEvent. It takes two parameters, the first being a DOMString representing the type of the event; the second a dictionary containing the RTCIceCandidate it refers to.

Methods

A RTCPeerConnectionIceEvent being an Event, this event also implements these propertiesThere is no specific RTCDataChannelEvent method.

Examples

pc.onicecandidate = function( ev ) {
  alert("The ICE candidate (transport address: '" + 
    ev.candidate.candidate + 
    "') has been added to this connection.");
}

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCPeerConnectionIceEvent' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
Basic support
Experimental
Chrome No support ? — 56
Alternate Name
No support ? — 56
Alternate Name
Alternate Name Uses the non-standard name: RTCIceCandidateEvent
Full support 56
Edge Full support YesFirefox Full support YesIE ? Opera Full support YesSafari ? WebView Android No support ? — 56
Alternate Name
No support ? — 56
Alternate Name
Alternate Name Uses the non-standard name: RTCIceCandidateEvent
Full support 56
Chrome Android No support ? — 56
Alternate Name
No support ? — 56
Alternate Name
Alternate Name Uses the non-standard name: RTCIceCandidateEvent
Full support 56
Edge Mobile ? Firefox Android Full support YesOpera Android Full support YesSafari iOS ? Samsung Internet Android Full support 6.0
candidate
Experimental
Chrome Full support 56Edge Full support 15Firefox Full support YesIE ? Opera Full support YesSafari ? WebView Android Full support 56Chrome Android Full support 56Edge Mobile ? Firefox Android Full support YesOpera Android Full support YesSafari iOS ? Samsung Internet Android Full support 6.0
RTCPeerConnectionIceEvent() constructor.
Experimental
Chrome Full support 56Edge Full support YesFirefox Full support YesIE ? Opera Full support YesSafari ? WebView Android Full support 56Chrome Android Full support 56Edge Mobile ? Firefox Android Full support YesOpera Android Full support YesSafari iOS ? Samsung Internet Android Full support 6.0
urlChrome ? Edge ? Firefox ? IE ? Opera ? Safari ? WebView Android ? Chrome Android ? Edge Mobile ? Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
Uses a non-standard name.
Uses a non-standard name.

See also

Document Tags and Contributors

Contributors to this page: fscholz, jpmedley, abbycar, teoli
Last updated by: fscholz,