RTCIceTransport.getSelectedCandidatePair()
The RTCIceTransport method
getSelectedCandidatePair() returns an
RTCIceCandidatePair object containing the current best-choice pair
of ICE candidates describing the configuration of the endpoints of the transport.
Syntax
candidatePair = RTCIceTransport.getSelectedCandidatePair();
Parameters
None.
Return value
A RTCIceCandidatePair object describing the configurations of the
currently-selected candidate pair's two endpoints.
local describes the configuration of the
local end of the connection, while remote
describes the remote peer's configuration.
The return value is null if no pair of candidates has been selected yet.
Usage notes
As the ICE agent performs negotiation of a RTCPeerConnection, it gathers
and analyzes candidate configurations from each the two peers. As soon as it finds an
acceptable matching pair of candidates, meeting the requirements for the connection, a
selectedcandidatepairchange event is fired at the
RTCIceTransport. From that time forward, the best matching pair of
candidates will always be available by calling
getSelectedCandidatePair().
As ICE negotiation continues, any time a pair of candidates is discovered that is
better than the currently-selected pair, the new pair is selected, replacing the
previous pairing, and the selectedcandidatepairchange event is fired again.
Note: It's possible for one of the configurations in the selected candidate pair to remain unchanged when a new pairing is chosen.
Examples
See RTCIceTransport.onselectedcandidatepairchange for example code.
Specifications
| Specification |
|---|
| WebRTC 1.0: Real-Time Communication Between Browsers # dom-rtcicetransport-getselectedcandidatepair |
Browser compatibility
BCD tables only load in the browser