RTCIceCandidatePairStats

Словарь RTCIceCandidatePairStats API WebRTC используется для отчётности о статистике, которая даёт представление о качестве и производительности RTCPeerConnection при подключении и конфигурации, как описано для указанной пары кандидатов ICE.

Статистику можно получить, перебирая RTCStatsReport, возвращаемый RTCPeerConnection.getStats(), пока не будет найдена запись с type "candidate-pair".

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

Число, представляющее доступную входящую пропускную способность сети. Оно сообщает общее количество бит в секунду, доступных для всех входящих RTP-потоков кандидатской пары. Оно не учитывает размер накладных расходов протокола Internet Protocol (IP), а также другие транспортные уровни, такие как TCP или UDP.

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

Число, представляющее приблизительную доступную исходящую пропускную способность сети. Оно сообщает общее количество бит в секунду, доступных для всех исходящих RTP-потоков кандидатской пары. Оно не учитывает размер накладных расходов IP, а также другие транспортные уровни, такие как TCP или UDP.

bytesDiscardedOnSend Необязательно Экспериментальное

Целое число, представляющее общее количество байтов, отброшенных из-за ошибок сокета для этой пары кандидатов.

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

Целое число, представляющее общее количество байтов полезной нагрузки, полученных для этой пары кандидатов.

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

Целое число, представляющее общее количество байтов полезной нагрузки, отправленных для этой пары кандидатов (общее количество отправленных байтов без учёта заголовков, заполнения или других накладных расходов протокола).

consentRequestsSent Необязательно Экспериментальное

Целое число, представляющее общее количество запросов согласия STUN для этой пары кандидатов.

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

Число, представляющее общее время в секундах, прошедшее между последним отправленным запросом STUN и получением ответа. Это может быть основано на запросах, которые участвовали в подтверждении разрешения на открытие соединения.

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

Значение DOMHighResTimeStamp, указывающее время получения последнего пакета локальным узлом от удалённого узла для данной пары кандидатов. Отметки времени не сохраняются для пакетов STUN.

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

Значение DOMHighResTimeStamp, указывающее время отправки последнего пакета локальным узлом удалённому узлу для данной пары кандидатов. Отметки времени не сохраняются для пакетов STUN.

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

Строка, представляющая уникальный идентификатор, соответствующий RTCIceCandidate из данных, включённых в объект RTCIceCandidateStats, предоставляющий статистику для локального кандидата пары кандидатов.

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

Логическое значение, которое, если true, указывает, что пара кандидатов, описанная этим объектом, была предложена для использования и будет (или была) использована, если её приоритет является самым высоким среди номинированных пар кандидатов. Подробнее см. RFC 5245, раздел 7.1.3.2.4.

packetsDiscardedOnSend Необязательно Экспериментальное

Целое число, представляющее общее количество пакетов, отброшенных из-за ошибок сокета для этой пары кандидатов.

packetsReceived Необязательно Экспериментальное

Целое число, представляющее общее количество полученных пакетов для этой пары кандидатов.

packetsSent Необязательно Экспериментальное

Целое число, представляющее общее количество отправленных пакетов для этой пары кандидатов.

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

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

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

Целое число, представляющее общее количество полученных запросов проверки подключения, включая повторные передачи. Это значение включает как запросы проверки подключения, так и запросы проверки согласия STUN.

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

Целое число, представляющее общее количество отправленных запросов проверки подключения, без учёта повторных передач.

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

Целое число, представляющее общее количество полученных ответов на запросы проверки подключения.

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

Целое число, представляющее общее количество отправленных ответов на запросы проверки подключения. Это включает как запросы проверки подключения, так и запросы проверки согласия STUN.

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

Строка, которая указывает состояние соединения между двумя кандидатами.

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

Число, обозначающее общее время в секундах, прошедшее между отправкой запросов STUN и получением ответов на них для всех таких запросов, отправленных для этой пары кандидатов. Это включает как запросы проверки подключения, так и запросы проверки согласия. Вы можете вычислить среднее время задержки (RTT), разделив это значение на responsesReceived.

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

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

Следующие свойства общие для всех объектов статистики WebRTC.

id

Строка, уникально идентифицирующая объект, за которым ведется мониторинг для получения этого набора статистики.

timestamp

Объект DOMHighResTimeStamp, указывающий время, в которое была взята выборка для этого объекта статистики.

type

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

Следующие свойства были удалены из спецификации и больше не должны использоваться. Необходимо обновить любой существующий код, чтобы избегать их использования как можно скорее. См. таблицу совместимости для получения информации о поддержке этих свойств в разных браузерах.

priority Устаревшее Необязательно Нестандартное

Целочисленное значение, указывающее приоритет кандидата пары.

readable Устаревшее Необязательно Нестандартное

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

writable Устаревшее Необязательно Нестандартное

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

selected Нестандартное Необязательно

Специфичное для Firefox булево значение, которое равно true, если пара кандидатов, описанных этим объектом, является текущей в использовании. Согласованный со спецификацией способ определения выбранной пары кандидатов — это поиск объекта статистики типа transport, который является объектом RTCTransportStats. Свойство selectedCandidatePairId этого объекта указывает, используется ли указанный транспорт.

Текущую активную пару ICE кандидатов (если есть) можно получить, вызвав метод RTCIceTransport getSelectedCandidatePair(), который возвращает объект RTCIceCandidatePair, или null, если пара не выбрана. Активная пара кандидатов описывает текущую конфигурацию двух сторон RTCPeerConnection.

Любая пара кандидатов, не являющаяся активной парой кандидатов для транспорта, удаляется, если RTCIceTransport выполняет перезапуск ICE, в результате чего состояние state ICE-транспорта возвращается к значению new, и переговорный процесс запускается заново. Дополнительная информация содержится в разделе Перезапуск ICE.

В этом примере вычисляется среднее время, прошедшее между проверками подключения.

if (rtcStats && rtcStats.type === "candidate-pair") {
  let elapsed =
    (rtcStats.lastRequestTimestamp - rtcStats.firstRequestTimestamp) /
    rtcStats.requestsSent;

  console.log(`Average time between ICE connectivity checks: ${elapsed} ms.`);
}

Код начинает с проверки rtcStats, чтобы определить, является ли его свойство type равным candidate-pair. Если это так, то мы знаем, что rtcStats фактически является объектом RTCIceCandidatePairStats. Тогда мы можем вычислить среднее время, прошедшее между проверками STUN подключения, и вывести эту информацию.