RTCPeerConnectionIceEvent.candidate

The read-only candidate property of the RTCPeerConnectionIceEvent interface returns the RTCIceCandidate associated with the event.

Syntax

 var candidate = event.candidate;

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

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.candidate' in that specification.
Candidate Recommendation Initial specification.

Browser compatibility

BCD tables only load in the browser

See also