RTCIceCandidateStats
The RTCIceCandidateStats
dictionary of the WebRTC API is used to report statistics related to an RTCIceCandidate
.
The statistics can be obtained by iterating the RTCStatsReport
returned by RTCPeerConnection.getStats()
until you find a report with the type
of local-candidate
.
Instance properties
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
-
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, its 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. 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
-
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.
Common instance properties
The following properties are common to all WebRTC statistics objects.
id
-
A string that uniquely identifies the object that is being monitored to produce this set of statistics.
timestamp
-
A
DOMHighResTimeStamp
object indicating the time at which the sample was taken for this statistics object. type
-
A string with the value
"local-candidate"
, indicating the type of statistics that the object contains.
Examples
TBD
Specifications
Specification |
---|
Identifiers for WebRTC's Statistics API # dom-rtcstatstype-local-candidate |
Browser compatibility
BCD tables only load in the browser