RTCPeerConnection: метод getStats()

Метод getStats() интерфейса RTCPeerConnection возвращает промис, который разрешается данными, предоставляющими статистику о соединении в целом или о заданном MediaStreamTrack.

selector Необязательно

MediaStreamTrack для которого собирается статистика. Если это null (значение по умолчанию), статистика будет собрана для всего RTCPeerConnection.

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

successCallback Устарело

Функция обратного вызова, вызываемая после успешного создания отчёта.

failureCallback Устарело

Функция обратного вызова, вызываемая после неудачи в создании отчёта.

A Promise, который разрешается объектом RTCStatsReport, предоставляющим статистику соединения. Содержание отчета зависит от selector и других деталей соединения.

Этот метод не вызывает исключений; вместо этого он отклоняет возвращаемый промис с одной из следующих ошибок:

InvalidAccessError DOMException

Выбрасывается, если нет RTCRtpSender или RTCRtpReceiver, чьё track соответствует заданному selector, или selector соответствует более чем одному отправителю или получателю.

В этом примере с помощью setInterval() создаётся периодическая функция, которая собирает статистику для RTCPeerConnection каждую секунду, генерируя отчёт в формате HTML и вставляя его в определённый элемент в DOM.

setInterval(() => {
  myPeerConnection.getStats(null).then((stats) => {
    let statsOutput = "";

    stats.forEach((report) => {
      statsOutput +=
        `<h2>Report: ${report.type}</h2>\n<strong>ID:</strong> ${report.id}<br>\n` +
        `<strong>Timestamp:</strong> ${report.timestamp}<br>\n`;

      // Now the statistics for this report; we intentionally drop the ones we
      // sorted to the top above

      Object.keys(report).forEach((statName) => {
        if (
          statName !== "id" &&
          statName !== "timestamp" &&
          statName !== "type"
        ) {
          statsOutput += `<strong>${statName}:</strong> ${report[statName]}<br>\n`;
        }
      });
    });

    document.querySelector(".stats-box").innerHTML = statsOutput;
  });
}, 1000);

Это работает, вызывая getStats(), а затем, когда промис разрешается, перебирая объекты RTCStatsReport в возвращённом RTCStatsReport. Для каждого отчёта создаётся раздел со заголовком и всей статистикой ниже, причём тип, ID и отметка времени обрабатываются особым образом, чтобы поместить их в начало списка.

После того, как HTML-код отчёта сгенерирован, он вставляется в элемент с классом "stats-box" путём установки его свойства innerHTML.