RTCPeerConnectionIceEvent: candidate property

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

BCD tables only load in the browser

See also