RTCPeerConnection:iceGatheringState 属性

Baseline 已广泛支持

此功能已成熟,可跨多种设备和浏览器版本使用。自 2017 年 9 月以来,它已在浏览器中提供。

RTCPeerConnection 接口的只读属性 iceGatheringState 返回一个字符串,该字符串描述此连接的整体 ICE 收集状态。这使您能够检测,例如,ICE 候选集的收集何时完成。

您可以通过监听类型为 icegatheringstatechange 的事件来检测此属性值的变化。

请注意,iceGatheringState 代表连接的整体收集状态,包括连接中每个 RTCRtpSender 和每个 RTCRtpReceiver 使用的每个 RTCIceTransport。这与 RTCIceTransport.gatheringState 不同,后者代表单个传输的收集状态。

可能的值为

new

对等连接刚刚创建,尚未进行任何网络活动。

gathering

ICE 代理正在为连接收集候选集。

完成

ICE 代理已完成候选集的收集。如果发生需要收集新候选集的情况(例如,添加新接口或添加新的 ICE 服务器),状态将恢复为 gathering 以收集这些候选集。

示例

js
const pc = new RTCPeerConnection();
const state = pc.iceGatheringState;

规范

规范
WebRTC:浏览器中的实时通信
# dom-peerconnection-ice-gathering-state

浏览器兼容性

另见