RTCIceCandidateStats

{{APIRef("WebRTC")}}

The RTCIceCandidateStats dictionary of the WebRTC API is used to report statistics related to an {{domxref("RTCIceCandidate")}}.

The statistics can be obtained by iterating the {{domxref("RTCStatsReport")}} returned by {{domxref("RTCPeerConnection.getStats()")}} until you find a report with the type of local-candidate.

Instance properties

• {{domxref("RTCIceCandidateStats.address", "address")}} {{optional_inline}}
  • : 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. Corresponds to {{domxref("RTCIceCandidate.address")}}.
• {{domxref("RTCIceCandidateStats.candidateType", "candidateType")}}
  • : A string matching one of the values in RTCIceCandidate.type, indicating what kind of candidate the object provides statistics for.
• {{domxref("RTCIceCandidateStats.deleted", "deleted")}}
  • : A boolean indicating whether or not the candidate has been deleted or released.
• {{domxref("RTCIceCandidateStats.foundation", "foundation")}} {{optional_inline}} {{experimental_inline}}
  • : A string that uniquely identifies the candidate across multiple transports. Corresponds to {{domxref("RTCIceCandidate.foundation")}}.
• {{domxref("RTCIceCandidateStats.port", "port")}} {{optional_inline}}
  • : The network port number used by the candidate. Corresponds to {{domxref("RTCIceCandidate.port")}}.
• {{domxref("RTCIceCandidateStats.priority", "priority")}} {{optional_inline}}
  • : The candidate's priority. Corresponds to {{domxref("RTCIceCandidate.priority")}}.
• {{domxref("RTCIceCandidateStats.protocol", "protocol")}} {{optional_inline}}
  • : A string specifying the protocol (tcp or udp) used to transmit data on the port. Corresponds to {{domxref("RTCIceCandidate.protocol")}}.
• {{domxref("RTCIceCandidateStats.relayProtocol", "relayProtocol")}}
  • : A string specifying the protocol being used by a local {{Glossary("ICE")}} candidate to communicate with the {{Glossary("TURN")}} server.
• {{domxref("RTCIceCandidateStats.transportId", "transportId")}}
  • : A string uniquely identifying the transport object that was inspected in order to obtain the {{domxref("RTCTransportStats")}} associated with the candidate corresponding to these statistics.
• {{domxref("RTCIceCandidateStats.url", "url")}} {{optional_inline}}
  • : A string specifying the URL of the {{Glossary("ICE")}} server from which the described candidate was obtained. This property is only available for local candidates.
• {{domxref("RTCIceCandidateStats.usernameFragment", "usernameFragment")}} {{optional_inline}} {{experimental_inline}}
  • : A string containing the ICE username fragment ("ice-ufrag"). Corresponds to {{domxref("RTCIceCandidate.usernameFragment")}}.

Common instance properties

The following properties are common to all WebRTC statistics objects.

• {{domxref("RTCIceCandidateStats.id", "id")}}
  • : A string that uniquely identifies the object that is being monitored to produce this set of statistics.
• {{domxref("RTCIceCandidateStats.timestamp", "timestamp")}}
  • : A {{domxref("DOMHighResTimeStamp")}} object indicating the time at which the sample was taken for this statistics object.
• {{domxref("RTCIceCandidateStats.type", "type")}}
  • : A string with the value "local-candidate", indicating the type of statistics that the object contains.

Examples

Given a variable myPeerConnection, which is an instance of {{domxref("RTCPeerConnection")}}, the code below uses await to wait for the statistics report, and then iterates it using RTCStatsReport.forEach(). It then filters the dictionaries for just those reports that have the type of local-candidate and logs the result.

const stats = await myPeerConnection.getStats();

stats.forEach((report) => {
  if (report.type === "local-candidate") {
    // Log the ICE candidate information
    console.log(report);
  }
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}