RTCPeerConnectionIceEvent: candidate property
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
The read-only candidate
property
of the RTCPeerConnectionIceEvent
interface returns the
RTCIceCandidate
associated with the event.
Value
An RTCIceCandidate
object representing the ICE candidate that has been
received, or null
to indicate that there are no further candidates for this
negotiation session.
Example
js
pc.onicecandidate = (ev) => {
alert(
`The ICE candidate (transport address: '${ev.candidate.candidate}') has been added to this connection.`,
);
};
Specifications
Specification |
---|
WebRTC: Real-Time Communication in Browsers # dom-rtcpeerconnectioniceevent-candidate |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
candidate |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
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.