在此页

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

RTCIceCandidate () constructor creates and returns a new RTCIceCandidate object, which can be configured to represent a single ICE candidate.

句法

candidate = new RTCIceCandidate([candidateInfo]);
					

参数

candidateInfo 可选

An optional RTCIceCandidateInit object providing information about the candidate; if this is provided, the candidate is initialized configured to represent the described candidate.

返回值

A newly-created RTCIceCandidate object, optionally configured based on the specified object based on the RTCIceCandidateInit 字典。

若 candidateInfo is provided, the new RTCIceCandidate is initialized as follows:

• Each member of the RTCIceCandidateInit object is initialized to the value of the property by the same name from RTCIceCandidateInit . This includes the candidate , sdpMid , sdpMLineIndex ，和 usernameFragment 特性。
• candidate string (which is SDP text) is parsed; each property found is stored in the corresponding field in the RTCIceCandidate . If any of the fields is invalid, parsing of the string silently aborts without throwing an exception. The default value of candidate is the empty string, which indicates that the candidate is an "end-of-candidates" message.
• The following fields are initialized to null if they are not included in the RTCIceCandidate.candidate 特性： foundation , component , priority , ip , 协议 , port , type , tcpType , relatedAddress ，和 relatedPort .

注意： Parsing of the candidate string is performed using the candidate-attribute grammar from the WebRTC Specification.

异常

TypeError

指定 RTCIceCandidateInit has values of null in both the sdpMid and sdpMLineIndex 特性。

用法注意事项

This constructor does not do complete validation of the specified candidateInfo object or string.

规范

规范	状态	注释
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCIceCandidate()' 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
RTCIceCandidate() 构造函数	Chrome Yes	Edge ≤18	Firefox 22 22 Before Firefox 68, the constructor's 选项 parameter was required.	IE No	Opera Yes	Safari ?	WebView Android Yes	Chrome Android Yes	Firefox Android Yes Yes Before Firefox 68, the constructor's 选项 parameter was required.	Opera Android Yes	Safari iOS ?	Samsung Internet Android Yes

图例

完整支持

完整支持

不支持

不支持

兼容性未知 ?

兼容性未知

见实现注意事项。

另请参阅

• ICE in Introduction to WebRTC protocols
• WebRTC connectivity
• Lifetime of a WebRTC session
• Signaling and video calling

元数据

• 最后修改： Jun 18, 2019

相关话题

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

   1. RTCIceCandidate()
4. 特性

   1. address
   2. candidate
   3. component
   4. foundation
   5. port
   6. priority
   7. 协议
   8. relatedAddress
   9. relatedPort
   10. sdpMid
   11. sdpMLineIndex
   12. usernameFragment
5. 方法

   1. toJSON()
6. 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. RTCIceTransport
   11. RTCPeerConnection
   12. RTCPeerConnectionIceErrorEvent
   13. RTCPeerConnectionIceEvent
   14. RTCRtpReceiver
   15. RTCRtpSender
   16. RTCRtpTransceiver
   17. RTCSctpTransport
   18. RTCSessionDescription
   19. RTCStatsEvent
   20. RTCStatsReport
   21. RTCTrackEvent