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

瀏覽器相容性

另見