在此页

• 句法
• 范例
• 规范
• 浏览器兼容性
• 另请参阅
• 相关话题

这是 实验性技术
检查 浏览器兼容性表格 要小心谨慎在生产中使用这之前。

RTCPeerConnection.setConfiguration() method sets the current configuration of the RTCPeerConnection based on the values included in the specified RTCConfiguration object. This lets you change the ICE servers used by the connection and which transport policies to use.

The most common use case for this method (and even then, probably not a very common use case) is to replace the set of ICE servers to be used. Two potential scenarios in which this might be done:

• RTCPeerConnection was instantiated without specifying any ICE servers. If, for example, the RTCPeerConnection() constructor was called with no parameters, you would have to then call setConfiguration() to add ICE servers before ICE negotiation could begin.
• Renegotiation of the connection is needed, and a different set of ICE servers needs to be used for some reason. Perhaps the user has moved into a new region, so using new regional ICE servers is necessary, for example. In this situation, one might call setConfiguration() to switch to new regional ICE servers, then initiate an ICE restart .

You cannot change the identity information for a connection once it's already been set.

句法

RTCPeerConnection.setConfiguration(configuration);
					

参数

configuration

RTCConfiguration object which provides the options to be set. The changes are not additive; instead, the new values completely replace the existing ones.

异常

InvalidAccessError

One or more of the URLs specified in configuration.iceServers 是 TURN server, but complete login information is not provided (that is, either the RTCIceServer.username or RTCIceServer.credentials is missing). This prevents successful login to the server.

InvalidModificationError

configuration includes changed identity information, but the connection already has identity information specified. This happens if configuration.peerIdentity or configuration.certificates is set and their values differ from the current configuration.

InvalidStateError

RTCPeerConnection is closed.

SyntaxError

One or more of the URLs provided in the configuration.iceServers list is invalid.

范例

In this example, it has already been determined that ICE restart is needed, and that negotiation needs to be done using a different ICE server.

var restartConfig = { iceServers: [{
                          urls: "turn:asia.myturnserver.net",
                          username: "allie@oopcode.com",
                          credential: "topsecretpassword"
                      }]
};
myPeerConnection.setConfiguration(restartConfig);
myPeerConnection.createOffer({"iceRestart": true}).then(function(offer) {
  return myPeerConnection.setLocalDescription(offer);
})
.then(function() {
  // send the offer to the other peer using the signaling server
})
.catch(reportError);
					

First, a new RTCConfiguration is created, restartConfig , specifying the new ICE server and its credentials. This is then passed into setConfiguration() . ICE negotiation is restarted by calling createOffer() , specifying true as the value of the iceRestart option. From there, we handle the process as usual, by setting the local description to the returned offer and then sending that offer to the other peer.

规范

规范	状态	注释
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'setConfiguration()' in that specification.	候选推荐	初始定义。

浏览器兼容性

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request. 更新 GitHub 上的兼容性数据

	桌面						移动
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
setConfiguration	Chrome 48	Edge ≤18	Firefox 不支持 No 注意事项 No 注意事项 见 bug 1253706 .	IE 不支持 No	Opera 43 注意事项 43 注意事项 Promise-based version. 37 — 43	Safari 11	WebView Android 48	Chrome Android 48	Firefox Android 不支持 No 注意事项 No 注意事项 见 bug 1253706 .	Opera Android 43 注意事项 43 注意事项 Promise-based version. 37 — 43	Safari iOS Yes	Samsung Internet Android 6.0

图例

完整支持

完整支持

不支持

不支持

见实现注意事项。

另请参阅

• RTCPeerConnection.getConfiguration()
• RTCConfiguration
• RTCPeerConnection

元数据

• 最后修改： 2020 年 1 月 22 日

相关话题

1. WebRTC API
2. RTCPeerConnection
3. 构造函数

   1. RTCPeerConnection()
4. 特性

   1. canTrickleIceCandidates
   2. connectionState
   3. currentLocalDescription
   4. currentRemoteDescription
   5. getDefaultIceServers()
   6. iceConnectionState
   7. iceGatheringState
   8. localDescription
   9. onaddstream
   10. onconnectionstatechange
   11. ondatachannel
   12. onicecandidate
   13. oniceconnectionstatechange
   14. onicegatheringstatechange
   15. onidentityresult
   16. onidpassertionerror
   17. onidpvalidationerror
   18. onnegotiationneeded
   19. onpeeridentity
   20. onremovestream
   21. onsignalingstatechange
   22. ontrack
   23. peerIdentity
   24. pendingLocalDescription
   25. pendingRemoteDescription
   26. remoteDescription
   27. sctp
   28. signalingState
5. 方法

   1. addIceCandidate()
   2. addStream()
   3. addTrack()
   4. close()
   5. createAnswer()
   6. createDataChannel()
   7. createOffer()
   8. generateCertificate()
   9. getConfiguration()
   10. getIdentityAssertion()
   11. getReceivers()
   12. getSenders()
   13. getStats()
   14. getStreamById()
   15. getTransceivers()
   16. removeStream()
   17. removeTrack()
   18. restartIce()
   19. setConfiguration()
   20. setIdentityProvider()
   21. setLocalDescription()
   22. setRemoteDescription()
6. 事件

   1. addstream
   2. identityresult
   3. negotiationneeded
   4. removestream
   5. signalingstatechange
7. 继承：

   1. EventTarget
8. Related pages for WebRTC

   1. MediaDevices.getUserMedia()
   2. Navigator.mediaDevices
   3. RTCCertificate
   4. RTCDTMFSender
   5. RTCDTMFToneChangeEvent
   6. RTCDataChannel
   7. RTCDataChannelEvent
   8. RTCDtlsTransport
   9. RTCErrorEvent
   10. RTCIceCandidate
   11. RTCIceTransport
   12. RTCPeerConnectionIceErrorEvent
   13. RTCPeerConnectionIceEvent
   14. RTCRtpReceiver
   15. RTCRtpSender
   16. RTCRtpTransceiver
   17. RTCSctpTransport
   18. RTCSessionDescription
   19. RTCStatsEvent
   20. RTCStatsReport
   21. RTCTrackEvent