RTCIceCandidate

Интерфейс RTCIceCandidate — часть API WebRTC — представляет собой конфигурацию кандидата для установления связи (ICE) для установления RTCPeerConnection.

Кандидат ICE описывает протоколы и маршрутизацию, необходимые для WebRTC для связи с удалённым устройством. При запуске соединения WebRTC, обычно каждая сторона предлагает несколько кандидатов, пока не согласятся на одного, который, по их мнению, будет наилучшим. Затем WebRTC использует данные этого кандидата для инициализации соединения.

Подробную информацию о работе процесса ICE см. в статье Жизненный цикл сессии WebRTC. Дополнительные полезные сведения содержатся в статье Подключение WebRTC.

RTCIceCandidate()

Создаёт объект RTCIceCandidate для представления одного кандидата ICE, при необходимости с конфигурацией, заданной в объекте.

Примечание: Для обратной совместимости конструктор также принимает строку со значением свойства candidate, вместо объекта конфигурации.

address Только для чтения

Строка, содержащая IP-адрес кандидата.

candidate Только для чтения

Строка, представляющая адрес транспорта для кандидата, который может быть использован для проверок подключения. Формат этого адреса — candidate-attribute, как определено в RFC 5245. Эта строка пуста ("") если RTCIceCandidate — индикатор «конец кандидатов».

component Только для чтения

Строка, указывающая, является ли кандидат кандидатом RTP или RTCP; её значение равно rtp или rtcp, и получено из поля "component-id" в строке a-line candidate.

foundation Только для чтения

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

port Только для чтения

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

priority Только для чтения

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

protocol Только для чтения

Строка, указывающая, является ли протокол кандидата "tcp" или "udp".

relatedAddress Только для чтения

Если кандидат получен из другого кандидата, то relatedAddress — строка, содержащая IP-адрес кандидата-хоста. Для кандидатов-хостов это значение равно null.

relatedPort Только для чтения

Для кандидата, полученного из другого, такого как релейный или рефлексивный кандидат, relatedPort — число, указывающее номер порта кандидата, из которого получен этот кандидат. Для кандидатов-хостов свойство relatedPort равно null.

sdpMid Только для чтения

Строка, указывающая идентификатор потока медиа кандидата, который однозначно идентифицирует поток медиа внутри компонента, с которым связан кандидат, или null если такой связи нет.

sdpMLineIndex Только для чтения

Если не null, sdpMLineIndex указывает нулевой индекс описания медиа (как определено в RFC 4566) в SDP с которым связан кандидат.

tcpType Только для чтения

Если protocol равно "tcp", tcpType представляет тип TCP-кандидата. В противном случае tcpType равно null.

type Только для чтения

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

usernameFragment Только для чтения

Строка, содержащая случайный фрагмент имени пользователя ("ice-ufrag"), который ICE использует для целостности сообщений вместе со случайным паролем ("ice-pwd"). Вы можете использовать эту строку для проверки генерации ICE; каждая генерация одного и того же процесса ICE будет использовать тот же usernameFragment, даже при перезапуске ICE.

toJSON()

Возвращает представление в формате JSON текущей конфигурации RTCIceCandidate. Формат представления совпадает с объектом candidateInfo, который можно передать в конструктор RTCIceCandidate() для конфигурации кандидата.

Примеры см. в статье Сигнальная связь и видеозвонки, которая демонстрирует весь процесс.