RTCIceCandidateStats
The WebRTC API's RTCIceCandidateStats
dictionary provides statistics related to an RTCIceCandidate
.
Properties
RTCIceCandidateStats
is based upon the RTCStats
dictionary, so it includes those properties in addition to the ones below.
address
Optional-
A string containing the address of the candidate. This value may be an IPv4 address, an IPv6 address, or a fully-qualified domain name. This property was previously named
ip
and only accepted IP addresses. candidateType
Optional-
A string matching one of the values in
RTCIceCandidate.type
, indicating what kind of candidate the object provides statistics for. deleted
Optional-
A Boolean value indicating whether or not the candidate has been released or deleted; the default value is
false
. For local candidates, it's value istrue
if the candidate has been deleted or released. For host candidates,true
means that any network resources (usually a network socket) associated with the candidate have already been released. For TURN candidates, the TURN allocation is no longer active for deleted candidates. This property is not present for remote candidates. networkType
Optional-
A string which indicates the type of interface used for a local candidate. This property is only present for local candidates.
port
Optional-
The network port number used by the candidate.
priority
Optional-
The candidate's priority, corresponding to
RTCIceCandidate.priority
. protocol
Optional-
A string specifying the protocol (
tcp
orudp
) used to transmit data on theport
. relayProtocol
Optional-
A string identifying the protocol used by the endpoint for communicating with the TURN server; valid values are
tcp
,udp
, andtls
. Only present for local candidates. transportId
Optional-
A string uniquely identifying the transport object that was inspected in order to obtain the
RTCTransportStats
associated with the candidate corresponding to these statistics. url
Optional-
For local candidates, the
url
property is the URL of the ICE server from which the candidate was received. This URL matches the one included in theRTCPeerConnectionIceEvent
object representing theicecandidate
event that delivered the candidate to the local peer.
Example
This example features a function, isUsableNetworkType()
, whose job it is to look at an RTCIceCandidateStats
object's networkType
and determine whether or not the type of network is acceptable for use.
This function is then called for RTCStats
objects whose type is local-candidate
, indicating that the object is in fact an RTCIceCandidateStats
with information about a local ICE candidate.
const isUsableNetworkType = stats => {
switch(stats.networkType) {
case "ethernet":
case "vpn":
return true;
case "bluetooth":
case "cellular":
case "wimax":
case "unknown":
default:
return false;
}
}
if (rtcStats && rtcStats.type === "local-candidate") {
if (!isUsableNetworkType(rtcStats)) {
abortConnection();
return;
}
}
This code calls a function called abortConnection()
if the RTCStats
object represents information about a local candidate is which would be using a network connection other than Ethernet or a VPN.
Specifications
Specification |
---|
Identifiers for WebRTC's Statistics API # icecandidate-dict* |
Browser compatibility
BCD tables only load in the browser