在此页

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

WebRTC API's RTCPeerConnection interface offers the restartIce() method to allow a web application to easily request that ICE candidate gathering be redone on both ends of the connection. This simplifies the process by allowing the same method to be used by either the caller or the receiver to trigger an ICE restart.

后于 restartIce() returns, the offer returned by the next call to createOffer() is automatically configured to trigger ICE restart on both the local peer (once the local peer has been set) and on the remote peer, once the offer is sent across your signaling mechanism and the remote peer has set its description as well.

restartIce() causes the negotiationneeded event to be fired on the RTCPeerConnection to inform the application that it should perform negotiation using its signaling channel.

If negotiation fails to complete—either due to rollback or because incoming offers are in the process of being negotiated—the RTCPeerConnection will remember that you requested ICE restart. The next time the connection's signalingState changes to stable , the connection will fire the negotiationneeded event. This process continues until an ICE restart has been successfully completed.

句法

rtcPeerConnection.restartIce();
					

参数

None.

返回值

undefined .

用法注意事项

After calling restartIce() , the next offer created using createOffer() will initiate ICE restart once sent to the remote peer over your signaling mechanism. Restarting ICE essentially resets ICE so that it creates all new candidates using new credentials. Existing media transmissions continue uninterrupted during this process.

For details about how ICE restart works, see ICE restart in Lifetime of a WebRTC session and RFC 5245, section 9.1.1.1: ICE specification .

范例

This example creates a handler for the iceconnectionstatechange event that handles a transition to the failed state by restarting ICE in order to try again.

pc.addEventListener("iceconnectionstatechange", event => {
  if (pc.iceConnectionState === "failed") {
    /* possibly reconfigure the connection in some way here */
    /* then request ICE restart */
    pc.restartIce();
  }
});
					

With this code in place, a transition to the failed state during ICE negotiation will cause a negotiationneeded event to be fired, in response to which your code should renegotiate as usual. However, because you have called restartIce() , your call to createOffer() which occurs in the handler for negotiationneeded will trigger an ICE restart rather than just a regular renegotiation.

规范

规范	状态	注释
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCPeerConnection.restartIce()' 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
restartIce() 方法	Chrome 77	Edge 79	Firefox 70	IE No	Opera No	Safari No	WebView Android 77	Chrome Android 77	Firefox Android No	Opera Android 55	Safari iOS No	Samsung Internet Android 12.0

图例

完整支持

完整支持

不支持

不支持

另请参阅

• WebRTC API
• Lifetime of a WebRTC session
• Signaling and video calling

元数据

• 最后修改： Oct 18, 2019

相关话题

1. RTCPeerConnection
2. 构造函数

   1. RTCPeerConnection()
3. 特性

   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
4. 方法

   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()
5. 事件

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

   1. EventTarget