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, ornull
if this event indicates that there are no further candidates to come.
Constructors
RTCPeerConnectionIceEvent()
- Returns a new
RTCPeerConnectionIceEvent
. It takes two parameters, the first being aDOMString
representing the type of the event; the second a dictionary containing theRTCIceCandidate
it refers to.
Methods
A RTCPeerConnectionIceEvent
being an Event
, this event also implements these properties. There 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
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
RTCPeerConnectionIceEvent | Chrome
No support
? — 56
| Edge Full support ≤18 | Firefox Full support Yes | IE No support No | Opera Full support Yes | Safari Full support Yes | WebView Android
No support
? — 56
| Chrome Android
No support
? — 56
| Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android
No support
? — 6.0
|
RTCPeerConnectionIceEvent() constructor | Chrome Full support 56 | Edge Full support ≤18 | Firefox Full support Yes | IE No support No | Opera Full support Yes | Safari ? | WebView Android Full support 56 | Chrome Android Full support 56 | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS ? | Samsung Internet Android Full support 6.0 |
candidate | Chrome Full support 56 | Edge Full support 15 | Firefox Full support Yes | IE No support No | Opera Full support Yes | Safari Full support Yes | WebView Android Full support 56 | Chrome Android Full support 56 | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android Full support 6.0 |
url | Chrome No support No | Edge No support No | Firefox ? | IE No support No | Opera ? | Safari Full support Yes | WebView Android No support No | Chrome Android No support No | Firefox Android ? | Opera Android ? | Safari iOS Full support Yes | Samsung Internet Android No support No |
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
- WebRTC
- Its usual target:
RTCPeerConnection
.