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 simply 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 BrowsersThe definition of 'RTCIceCandidatePair.local' in that specification. | Candidate Recommendation | Initial specification. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
No compatibility data found. Please contribute data for "api.RTCIceCandidatePair.local" (depth: 1) to the MDN compatibility data repository.
RTCIceCandidatePair.local by Mozilla Contributors is licensed under CC-BY-SA 2.5.