RTCPeerConnection:iceGatheringState 属性

iceGatheringStateRTCPeerConnection 接口的只读属性,它返回一个字符串,描述此连接的总体 ICE 收集状态。这使您可以检测到例如 ICE 候选者收集何时完成。

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

请注意,iceGatheringState 表示连接的总体收集状态,包括每个 RTCIceTransport(由整个连接上的每个 RTCRtpSender 和每个 RTCRtpReceiver 使用)。这与 RTCIceTransport.gatheringState 相反,后者表示单个传输的收集状态。

可能的值为

new

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

gathering

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

complete

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

示例

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

规范

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

浏览器兼容性

BCD 表仅在启用 JavaScript 的浏览器中加载。

另请参阅