The RTCIceCandidatePair
dictionary describes a pair of ICE candidates which together comprise a description of a viable connection between two WebRTC endpoints. It is used as the return value from RTCIceTransport.getSelectedCandidatePair()
to identify the currently-selected candidate pair identified by the ICE agent.
Properties
local
- An
RTCIceCandidate
describing the configuration of the local end of the connection. remote
- The
RTCIceCandidate
describing the configuration of the remote end of the connection.
Example
In this example, an event handler for selectedcandidatepairchange
is set up to update an on-screen display showing the protocol used by the currently selected candidate pair.
var iceTransport = pc.getSenders()[0].transport.iceTransport;
var localProto = document.getElementById("local-protocol");
var remoteProto = document.getElementById("remote-protocol");
iceTransport.onselectedcandidatepairchange = function(event) {
var pair = iceTransport.getSelectedCandidatePair();
localProtocol.innerText = pair.local.protocol.toUpperCase();
remoteProtocol.innerText = pair.remote.protocol.toUpperCase();
}
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between BrowsersThe definition of 'RTCIceCandidatePair' 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" (depth: 1) to the MDN compatibility data repository.
RTCIceCandidatePair by Mozilla Contributors is licensed under CC-BY-SA 2.5.