RTCIceCandidate: foundation property

The RTCIceCandidate interface's read-only foundation property is a string which uniquely identifies the candidate across multiple transports.

The foundation can therefore be used to correlate candidates that are present on multiple RTCIceTransport objects

Value

A string which uniquely identifies the candidate across all RTCIceTransports on which it is available.

Note: If port is null — and port is supported by the user agent — passing the candidate to addIceCandidate() will fail, throwing an OperationError exception.

Usage notes

Consider this SDP attribute line (a-line) which describes an ICE candidate: 

a=candidate:4234997325 1 udp 2043278322 192.0.2.172 44323 typ host

The field "4234997325" is the foundation.

Examples

This code snippet uses the foundation of two candidates to determine if they're actually the same candidate.

js
if (candidate1.foundation === candidate2.foundation) {
  /* the two candidates are the same, even if they're on
     different transports */
}

Specifications

Specification
WebRTC: Real-Time Communication in Browsers
# dom-rtcicecandidate-foundation

Browser compatibility

BCD tables only load in the browser