RTCPeerConnection: метод setConfiguration()

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

Наиболее распространённый случай использования этого метода (и даже тогда, вероятно, не очень распространённый) — замена набора серверов ICE. Два возможных сценария, в которых это может потребоваться:

• Объект RTCPeerConnection был создан без указания серверов ICE. Если, например, конструктор RTCPeerConnection() был вызван без параметров, вам необходимо будет вызвать setConfiguration() для добавления серверов ICE перед началом переговоров ICE.
• Необходима повторная установка соединения, и по какой-то причине требуется использовать другой набор серверов ICE. Возможно, пользователь переместился в новый регион, поэтому для использования новых региональных серверов ICE необходимо вызвать setConfiguration(), затем инициировать перезапуск ICE.

configuration

Объект, предоставляющий параметры для установки. Изменения не добавляются; вместо этого новые значения полностью заменяют существующие. Более подробную информацию о допустимых параметрах см. в RTCPeerConnection().

InvalidAccessError DOMException

Выбрасывается, если один или несколько URL-адресов, указанных в configuration.iceServers, являются сервером TURN, но полная информация для входа не предоставлена (т. е., отсутствует либо username, либо credential, или если credentialType является "password", а credential не является строкой). Это препятствует успешному входу в систему на сервер.

InvalidModificationError DOMException

Выбрасывается, если configuration содержит изменённую информацию об идентификации, но соединение уже имеет заданную информацию об идентификации. Это происходит, если configuration.peerIdentity или configuration.certificates установлены и их значения отличаются от текущей конфигурации. Это также может быть вызвано изменениями в configuration.bundlePolicy или configuration.rtcpMuxPolicy, или в configuration.iceCandidatePoolSize после вызова RTCPeerConnection.setLocalDescription().

InvalidStateError DOMException

Выбрасывается, если соединение RTCPeerConnection закрыто.

SyntaxError DOMException

Выбрасывается, если configuration.iceServers не содержит URL-адресов или одно из значений в списке является недопустимым.

NotSupportedError DOMException

Выбрасывается, если configuration.iceServers содержит URL-адрес со схемой, которая не поддерживается.

В этом примере уже определено, что необходим перезапуск ICE и переговоры должны быть выполнены с использованием другого сервера ICE.

const restartConfig = {
  iceServers: [
    {
      urls: "turn:asia.turn-server.net",
      username: "allie@oopcode.com",
      credential: "topsecretpassword",
    },
  ],
};

myPeerConnection.setConfiguration(restartConfig);

myPeerConnection
  .createOffer({ iceRestart: true })
  .then((offer) => myPeerConnection.setLocalDescription(offer))
  .then(() => {
    // send the offer to the other peer using the signaling server
  })
  .catch(window.reportError);

Сначала создаётся новый объект restartConfig, указывающий на новый сервер ICE и его учётные данные. Затем он передаётся в setConfiguration(). Переговоры ICE перезапускаются вызовом createOffer(), задавая true в качестве значения параметра iceRestart. Далее процесс обрабатывается обычным способом, устанавливая локальное описание на полученное предложение и отправляя это предложение другому участнику.

• RTCPeerConnection.getConfiguration()
• RTCPeerConnection()
• RTCPeerConnection