RTCStatsReport

Интерфейс RTCStatsReport API WebRTC предоставляет отчёт о статистике для RTCPeerConnection, RTCRtpSender или RTCRtpReceiver.

Экземпляр RTCStatsReport — это только для чтения Map-подобный объект, в котором каждый ключ — идентификатор объекта, для которого предоставляется статистика, а соответствующее значение — объект словаря со статистикой.

RTCStatsReport.size

Возвращает количество элементов в объекте RTCStatsReport.

RTCStatsReport.entries()

Возвращает новый объект итератора, который содержит массив из двух элементов — [id, statistic-dictionary] — для каждого элемента в объекте RTCStatsReport, в порядке добавления.

RTCStatsReport.forEach()

Вызывает callbackFn один раз для каждой пары «ключ-значение» в объекте RTCStatsReport, в порядке добавления. Если в forEach передан параметр thisArg, он будет использоваться в качестве this значения для каждого обратного вызова.

RTCStatsReport.get()

Возвращает словарь статистики, связанный с переданным id, или undefined если такого нет.

RTCStatsReport.has()

Возвращает булево значение, указывающее, содержит ли RTCStatsReport словарь статистики, связанный с указанным id.

RTCStatsReport.keys()

Возвращает новый объект итератора, который содержит ключи (идентификаторы) для каждого элемента в объекте RTCStatsReport, в порядке добавления.

RTCStatsReport.values()

Возвращает новый объект итератора, который содержит значения (объекты статистики) для каждого элемента в объекте RTCStatsReport, в порядке добавления.

RTCStatsReport[Symbol.iterator]()

Возвращает новый объект итератора, который содержит массив из двух элементов — [id, statistic-dictionary] — для каждого элемента в объекте RTCStatsReport, в порядке добавления.

Promise, разрешающий в RTCStatsReport, возвращается методами RTCRtpReceiver.getStats(), RTCRtpSender.getStats() и RTCPeerConnection.getStats(). Вызов getStats() на RTCPeerConnection позволяет указать, хотите ли вы получить статистику исходящих, входящих данных или статистику для всего соединения. Версии getStats() для RTCRtpReceiver и RTCRtpSender возвращают только входящую и исходящую статистику соответственно.

Отчёт о статистике — это только для чтения Map-подобный объект: упорядоченный словарь, где свойства — id строки, уникально идентифицирующие объект WebRTC, который был проанализирован для получения определённого набора статистики, а значение — объект словаря, содержащий эту статистику. RTCStatsReport можно перебирать и использовать аналогично только для чтения Map.

Отчёт может содержать множество разных категорий статистики, включая входящую и исходящую статистику для текущего и удалённого концов соединения, информацию о кодеках, сертификатах и используемой медиа и т. д. Каждая категория статистики предоставляется в виде разного типа объекта словаря, который можно определить по свойству type.

Все типы словарей имеют следующие свойства:

id

Строка, которая уникально идентифицирует объект, который отслеживался для получения набора статистики. Это значение сохраняется в отчётах (по крайней мере) в течение всего времени жизни соединения. Однако обратите внимание, что для некоторых статистик идентификатор может отличаться между браузерами и для последующих соединений, даже с тем же участником.

timestamp

Объект отметки времени высокой точности (DOMHighResTimeStamp), указывающий время, в которое был получен образец. Многие отчитываемые значения статистики — кумулятивные; отметка времени позволяет рассчитывать скорости и средние значения между любыми двумя отчётами с любой желаемой скоростью отчётов.

type

Строка со значением, которое указывает тип статистики, содержащейся в объекте, например, candidate-pair, inbound-rtp, certificate, и так далее. Типы статистики и соответствующие им объекты перечислены ниже.

Пользователи обычно перебирают RTCStatsReport, используя цикл forEach() или for...of, выбирая нужную статистику с помощью свойства 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. Предполагается, что у вас уже есть объект RTCRtpSender с именем «sender».

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()