RTCPeerConnection.iceGatheringState

Experimental

这是一个实验中的功能
此功能某些浏览器尚在开发中,请参考浏览器兼容性表格以得到在不同浏览器中适合使用的前缀。由于该功能对应的标准文档可能被重新修订,所以在未来版本的浏览器中该功能的语法和行为可能随之改变。

只读属性 RTCPeerConnection.iceGatheringState 返回一个描述连接的ICE收集状态的枚举值 RTCIceGatheringState。比如当ICE候选收集完成的时候,你可以通过该属性的变化侦测到。

通过监听 icegatheringstatechange 类型的事件,你可以侦测到该属性的变化。

语法

 var state = RTCPeerConnection.iceGatheringState;

可能的值是枚举类型 RTCIceGatheringState 的所有值。

RTCIceGatheringState enum

The RTCIceGatheringState enum defines string constants which reflect the current status of ICE gathering, as returned using the RTCPeerConnection.iceGatheringState property. You can detect when this value changes by watching for an event of type icegatheringstatechange.

Constant Description
"new" The peer connection was just created and hasn't done any networking yet.
"gathering" The ICE agent is in the process of gathering candidates for the connection.
"complete" The ICE agent has finished gathering candidates. If something happens that requires collecting new candidates, such as a new interface being added or the addition of a new ICE server, the state will revert to "gathering" to gather those candidates.

例子

var pc = new RTCPeerConnection();
var state = pc.iceGatheringState;

规格说明书

规格 状态 说明
WebRTC 1.0: Real-time Communication Between Browsers
RTCPeerConnection.iceGatheringState
Candidate Recommendation Initial specification.

浏览器兼容性说明

BCD tables only load in the browser

See also