RTCStatsReport: keys() method

The keys() method of the RTCStatsReport interface returns a new iterator object that can be used to iterate through the keys for each element in the RTCStatsReport object, in insertion order.

The keys in the RTCStatsReport are unique string id values, which represent the monitored statistics objects from which the statistics are derived.

The method is otherwise the same as Map.prototype.keys().

Syntax

js
keys()

Return value

A new iterable iterator object.

Examples

This example shows how to iterate through a RTCStatsReport using the iterator returned by keys().

Given a variable myPeerConnection, which is an instance of RTCPeerConnection, the code calls getStats() with await to wait for the statistics report. It then uses a for...of loop, with the iterator returned by keys(), to iterate through the IDs. Each ID is used to get the corresponding statistics dictionary. The properties of statistics objects with the type of outbound-rtp are logged to the console (other objects are discarded).

js
const stats = await myPeerConnection.getStats();

for (const id of stats.keys()) {
  // Get dictionary associated with key (id)
  const stat = stats.get(id);
  if (stat.type != "outbound-rtp") continue;
  Object.keys(stat).forEach((statName) => {
    console.log(`${statName}: ${report[statName]}`);
  });
}

Note that this examples is somewhat contrived. You could more easily iterate with entries() or values() and not have to map the ID to a value. You can even iterate the RTCStatsReport itself, as it has the @@iterator method!

Specifications

Specification
WebRTC: Real-Time Communication in Browsers
# dom-rtcstatsreport

Browser compatibility

BCD tables only load in the browser

See also