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