The local
property of the
RTCIceCandidatePair
dictionary specifies the
RTCIceCandidate
which describes the configuration of the local end of a
viable WebRTC connection.
Syntax
localCandidate = RTCIceCandidatePair.local;
Value
An RTCIceCandidate
which describes the configuration of the local end of
a viable pair of ICE candidates. The RTCIceCandidatePair
is returned by the
RTCIceTransport
method
getSelectedCandidatePair()
.
Example
This one-line example obtains the current candidate pair and then from that gets the local candidate.
var candidatePair = pc.getSenders()[0].transport.transport.getSelectedCandidatePair();
var 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
.
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCIceCandidatePair.local' in that specification. |
Candidate Recommendation | Initial specification. |