RTCPeerConnection: setConfiguration() 方法

语法

setConfiguration(configuration)

参数

configuration

提供要设置的选项的对象。更改不是累加的；而是，新值会完全替换现有值。有关允许的选项的信息，请参阅 RTCPeerConnection()。

返回值

无（undefined）。

异常

InvalidAccessError DOMException

如果在 configuration.iceServers 中指定的 URL 中有一个或多个是 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.restartIce();

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

首先，创建一个新对象 restartConfig，指定新的 ICE 服务器及其凭据。然后将其传递给 setConfiguration()。通过调用 restartIce() 来重启 ICE 协商，这会导致创建的下一个 offer 包含新的 ICE 服务器信息。从那里，我们按常规处理流程，将本地描述设置为返回的 offer，然后将该 offer 发送给另一方。

规范

浏览器兼容性

另见

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