このページはコミュニティーの尽力で英語から翻訳されました。MDN Web Docs コミュニティーについてもっと知り、仲間になるにはこちらから。

View in English Always switch to English

RTCPeerConnection: iceGatheringState プロパティ

Baseline
広く利用可能

この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2017年9月以降、すべてのブラウザーで利用可能です。

iceGatheringState は RTCPeerConnection インターフェイスの読み取り専用プロパティで、この接続の ICE 集合状態全体を説明する文字列を返します。 これにより、例えば、ICE 候補の集合が完了したタイミングを検知することができます。

このプロパティの値が変更されたことを検知するには、icegatheringstatechange 型のイベントを監視します。

なお、iceGatheringState は、全接続におけるすべての RTCRtpSender と RTCRtpReceiver が使用する RTCIceTransport をすべて含む、接続全体の収集状態を表します。 この状態に対し、RTCIceTransport.gatheringState は、単一のトランスポートの収集状態を表します。

値

取りうる値は次の通りです。

new

このピア接続は作成されたばかりで、まだネットワーク通信をしていません。

gathering

ICE のエージェントは現在、そのつながりに関する候補を収集しています。

complete

ICE のエージェントは候補の選定を完了しています。 新しいインターフェースの追加や新しい ICE サーバーの追加など、新たな候補を収集要求される場合、その状態は gathering に戻り、それらの候補を収集します。

例

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

仕様書

仕様書
WebRTC: Real-Time Communication in Browsers
# dom-peerconnection-ice-gathering-state

ブラウザーの互換性

関連情報