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 September 2018.

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

See also