RTCIceCandidatePair: local property

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The local property of the RTCIceCandidatePair interface specifies the RTCIceCandidate that describes the configuration of the local end of a viable WebRTC connection.

The RTCIceCandidatePair is returned by the getSelectedCandidatePair() method of RTCIceTransport.

Examples

Basic usage

This one-line example obtains the current candidate pair and then from that gets the local candidate.

const candidatePair = pc
  .getSenders()[0]
  .transport.iceTransport.getSelectedCandidatePair();
const localCandidate = candidatePair.local;

The RTCIceTransport is found by getting the list of RTCRtpSender objects for the RTCPeerConnection pc. In the first RTCRtpSender, we get the RTCDtlsTransport over which the media data is being transmitted and finally, from that, the RTCIceTransport.