RTCStatsReport

RTCStatsReport.size

返回 RTCStatsReport 对象中的项目数量。

RTCStatsReport.entries()

返回一个新的 迭代器 对象，该对象包含 RTCStatsReport 对象中每个元素的 [id, statistic-dictionary] 的两个成员数组，按插入顺序排列。

RTCStatsReport.forEach()

为 RTCStatsReport 对象中存在的每个键值对调用 callbackFn 一次，按插入顺序排列。如果向 forEach 提供 thisArg 参数，它将用作每个回调的 this 值。

RTCStatsReport.get()

返回与传入的 id 关联的统计信息字典，如果没有则返回 undefined。

RTCStatsReport.has()

返回一个布尔值，指示 RTCStatsReport 是否包含与指定 id 关联的统计信息字典。

RTCStatsReport.keys()

返回一个新的 迭代器 对象，该对象包含 RTCStatsReport 对象中每个元素的键（ID），按插入顺序排列。

RTCStatsReport.values()

返回一个新的 迭代器 对象，该对象包含 RTCStatsReport 对象中每个元素的值（统计信息对象），按插入顺序排列。

RTCStatsReport[Symbol.iterator]()

返回一个新的 迭代器 对象，该对象包含 RTCStatsReport 对象中每个元素的 [id, statistic-dictionary] 的两个成员数组，按插入顺序排列。

一个 Promise，它解析为 RTCStatsReport，从 RTCRtpReceiver.getStats()、RTCRtpSender.getStats() 和 RTCPeerConnection.getStats() 方法返回。在 RTCPeerConnection 上调用 getStats() 允许你指定是否希望获取出站统计信息、入站统计信息或整个连接的统计信息。RTCRtpReceiver 和 RTCRtpSender 版本的 getStats() 仅分别返回入站和出站统计信息。

统计报告是一个只读的 Map 类 对象：一个有序字典，其中属性是唯一标识用于生成特定统计信息集的 WebRTC 对象的 id 字符串，而值是一个包含这些统计信息的字典对象。RTCStatsReport 可以像只读 Map 一样进行迭代和使用。

报告可能包含许多不同类别的统计信息，包括对等连接的当前端和远程端的入站和出站统计信息，有关编解码器、证书和使用的媒体的信息，等等。每类统计信息都以不同的统计信息字典对象类型提供，可以通过其 type 属性识别。

所有字典类型都具有以下属性

id

一个字符串，唯一标识用于生成统计信息集的对象。此值在（至少）连接的生命周期内跨报告持续存在。但是请注意，对于某些统计信息，ID 可能在浏览器之间以及后续连接之间有所不同，即使连接到相同的对等方也是如此。

timestamp

一个高分辨率时间戳对象 (DOMHighResTimeStamp) 对象，指示采样时间。许多报告的统计信息是累积值；时间戳允许在任何两个报告之间以任何所需的报告速率计算速率和平均值。

type

一个字符串，其值指示对象包含的统计信息类型，例如 candidate-pair、inbound-rtp、certificate 等等。 统计信息类型及其对应的对象 列在下面。

用户通常使用 forEach() 或 for...of 循环迭代 RTCStatsReport，使用 type 属性选择感兴趣的统计信息。一旦使用 type 属性识别了特定的统计信息对象，就可以随后使用 id 属性与 get() 一起获取不同时间点的相同统计信息报告。

时间戳可用于计算在连接生命周期内累积的统计信息的平均值。

下面列出了统计信息 type 值及其对应的字典。

此示例显示了如何记录本地 RTCRtpReceiver 的视频相关统计信息，该接收器负责接收流式传输的媒体。

给定一个变量 myPeerConnection，它是 RTCPeerConnection 的一个实例，代码使用 await 等待统计信息报告，然后使用 RTCStatsReport.forEach() 进行迭代。然后，它过滤字典，仅保留 type 为 inbound-rtp 且 kind 为 video 的报告。

const stats = await myPeerConnection.getStats();

stats.forEach((report) => {
  if (report.type === "inbound-rtp" && report.kind === "video") {
    // Log the frame rate
    console.log(report.framesPerSecond);
  }
});

此示例显示了如何迭代来自 RTCRtpSender 的出站统计信息。

代码遵循与上一个示例类似的模式，但在 RTCStatsReport.values() 上使用 for...of 循环进行迭代，并根据 type 为 outbound-rtp 进行过滤。它假设你已经拥有一个名为“sender”的 RTCRtpSender 对象。

const stats = await sender.getStats();

for (const stat of stats.values()) {
  if (stat.type != "outbound-rtp") continue;
  Object.keys(stat).forEach((statName) => {
    console.log(`${statName}: ${report[statName]}`);
  });
}

• WebRTC API
• RTCPeerConnection
• RTCPeerConnection.getStats()、RTCRtpReceiver.getStats() 和 RTCRtpSender.getStats()