RTCIceCandidateStats dictionary of the WebRTC API is used to report statistics related to an
The statistics can be obtained by iterating the
RTCStatsReport returned by
RTCPeerConnection.getStats() until you find a report with the
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
ipand only accepted IP addresses.
A string matching one of the values in
RTCIceCandidate.type, indicating what kind of candidate the object provides statistics for.
A Boolean value indicating whether or not the candidate has been released or deleted; the default value is
false. For local candidates, its value is
trueif the candidate has been deleted or released. For host candidates,
truemeans 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.
The network port number used by the candidate.
The candidate's priority, corresponding to
A string specifying the protocol (
udp) used to transmit data on the
A string identifying the protocol used by the endpoint for communicating with the TURN server; valid values are
tls. Only present for local candidates.
A string uniquely identifying the transport object that was inspected in order to obtain the
RTCTransportStatsassociated with the candidate corresponding to these statistics.
For local candidates, the
urlproperty is the URL of the ICE server from which the candidate was received. This URL matches the one included in the
RTCPeerConnectionIceEventobject representing the
icecandidateevent that delivered the candidate to the local peer.
Common instance properties
The following properties are common to all WebRTC statistics objects.
A string that uniquely identifies the object that is being monitored to produce this set of statistics.
DOMHighResTimeStampobject indicating the time at which the sample was taken for this statistics object.
A string with the value
"local-candidate", indicating the type of statistics that the object contains.
|Identifiers for WebRTC's Statistics API |
BCD tables only load in the browser