RTCPeerConnection: iceGatheringState-Eigenschaft
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
Die schreibgeschützte iceGatheringState-Eigenschaft der RTCPeerConnection-Schnittstelle gibt einen String zurück, der den allgemeinen ICE-Sammlungssstatus für diese Verbindung beschreibt. Dies ermöglicht Ihnen zum Beispiel zu erkennen, wann die Sammlung der ICE-Kandidaten abgeschlossen ist.
Sie können erkennen, wann sich der Wert dieser Eigenschaft ändert, indem Sie auf ein Ereignis des Typs icegatheringstatechange achten.
Beachten Sie, dass iceGatheringState den allgemeinen Sammlungssstatus der Verbindung darstellt, einschließlich jedes RTCIceTransport, das von jedem RTCRtpSender und jedem RTCRtpReceiver der gesamten Verbindung verwendet wird. Dies steht im Gegensatz zu RTCIceTransport.gatheringState, das den Sammlungssstatus für einen einzelnen Transport darstellt.
Wert
Die möglichen Werte sind:
new-
Die Peer-Verbindung wurde gerade erstellt und hat noch keine Netzwerkaktivitäten durchgeführt.
gathering-
Der ICE-Agent sammelt gerade Kandidaten für die Verbindung.
complete-
Der ICE-Agent hat die Kandidatensammlung abgeschlossen. Wenn etwas passiert, das das Sammeln neuer Kandidaten erfordert, wie das Hinzufügen einer neuen Schnittstelle oder eines neuen ICE-Servers, wird der Status auf
gatheringzurückgesetzt, um diese Kandidaten zu sammeln.
Beispiel
const pc = new RTCPeerConnection();
const state = pc.iceGatheringState;
Spezifikationen
| Specification |
|---|
| WebRTC: Real-Time Communication in Browsers # dom-peerconnection-ice-gathering-state |
Browser-Kompatibilität
BCD tables only load in the browser