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
BCD tables only load in the browser
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.
See also
- WebRTC
- Its usual target:
RTCPeerConnection
.