RTCIceTransport
Die RTCIceTransport
Schnittstelle bietet Zugriff auf Informationen über die ICE-Transportschicht, über die Daten gesendet und empfangen werden. Dies ist besonders nützlich, wenn Sie Zustandsinformationen über die Verbindung abrufen müssen.
Instanz-Eigenschaften
Die RTCIceTransport
-Schnittstelle erbt Eigenschaften von ihrem Elternteil, EventTarget
. Sie bietet auch die folgenden Eigenschaften:
component
Schreibgeschützt-
Die von der Transportverbindung verwendete ICE-Komponente. Der Wert ist einer der Strings aus dem
RTCIceTransport
-Enumerationstyp:RTP
oder"RTSP"
. gatheringState
Schreibgeschützt-
Ein String, der den aktuellen Sammelzustand des ICE-Agenten angibt:
"new"
,"gathering"
oder"complete"
. role
Schreibgeschützt-
Gibt einen String zurück, dessen Wert entweder
"controlling"
oder"controlled"
ist; dies zeigt an, ob der ICE-Agent derjenige ist, der die endgültige Entscheidung über das zu verwendende Kandidatenpaar trifft oder nicht. state
Schreibgeschützt-
Ein String, der angibt, in welchem Zustand sich der ICE-Agent derzeit befindet. Der Wert von
state
kann verwendet werden, um festzustellen, ob der ICE-Agent eine erste Verbindung mit einem geeigneten Kandidatenpaar hergestellt hat ("connected"
), seine endgültige Auswahl von Kandidatenpaaren getroffen hat ("completed"
) oder sich in einem Fehlerzustand befindet ("failed"
), unter anderen Zuständen.
Instanz-Methoden
Beinhaltet auch Methoden von EventTarget
, der Elternschnittstelle.
getLocalCandidates()
-
Gibt ein Array von
RTCIceCandidate
-Objekten zurück, von denen jedes einen der ICE-Kandidaten beschreibt, die bisher für das lokale Gerät gesammelt wurden. Dies sind dieselben Kandidaten, die bereits an den entfernten Partner gesendet wurden, indem einicecandidate
-Ereignis an dieRTCPeerConnection
zur Übertragung gesendet wurde. getLocalParameters()
-
Gibt ein
RTCIceParameters
-Objekt zurück, das die ICE-Parameter beschreibt, die durch einen Aufruf der MethodeRTCPeerConnection.setLocalDescription()
festgelegt wurden. Gibtnull
zurück, wenn bisher keine Parameter empfangen wurden. getRemoteCandidates()
-
Gibt ein Array von
RTCIceCandidate
-Objekten zurück, jeweils eines für jeden ICE-Kandidaten des entfernten Geräts, der vom lokalen Ende derRTCPeerConnection
empfangen und an ICE übermittelt wurde, indemaddIceCandidate()
aufgerufen wird. getRemoteParameters()
-
Gibt ein
RTCIceParameters
-Objekt zurück, das die ICE-Parameter für das entfernte Gerät enthält, wie sie durch einen Aufruf vonRTCPeerConnection.setRemoteDescription()
festgelegt wurden. WennsetRemoteDescription()
noch nicht aufgerufen wurde, ist der Rückgabewertnull
. getSelectedCandidatePair()
-
Gibt ein
RTCIceCandidatePair
-Objekt zurück, das die beiden Kandidaten identifiziert - einen für jedes Ende der Verbindung -, die bisher ausgewählt wurden. Es ist möglich, dass später ein besseres Paar gefunden und ausgewählt wird; wenn Sie dies im Auge behalten möchten, beobachten Sie dasselectedcandidatepairchange
-Ereignis. Wenn noch kein Kandidatenpaar ausgewählt wurde, ist der Rückgabewertnull
.
Ereignisse
Diese Ereignisse können mit addEventListener()
überwacht werden oder indem ein Ereignislistener auf die oneventname
-Eigenschaft dieser Schnittstelle gesetzt wird.
gatheringstatechange
-
Wird an das
RTCIceTransport
-Objekt gesendet, um anzuzeigen, dass sich der Wert dergatheringState
-Eigenschaft geändert hat, was auf eine Änderung im ICE-Kandidaten-Aushandlungsprozess dieses Transports hinweist. Auch über dieongatheringstatechange
-Ereignislistener-Eigenschaft verfügbar. selectedcandidatepairchange
-
Wird an das
RTCIceTransport
gesendet, wenn ein neues, besseres Paar von Kandidaten ausgewählt wurde, um die Konnektivität zwischen den beiden Partnern zu beschreiben. Dies geschieht während der Aushandlung oder Neuaushandlung, auch nach einem ICE-Neustart, bei dem die bestehendenRTCIceTransport
-Objekte wiederverwendet werden. Das aktuelle Kandidatenpaar kann mitgetSelectedCandidatePair()
abgerufen werden. Auch über dieonselectedcandidatepairchange
-Ereignislistener-Eigenschaft verfügbar. statechange
-
Wird an die
RTCIceTransport
-Instanz gesendet, wenn sich der Wert derstate
-Eigenschaft geändert hat, was darauf hinweist, dass sich der Zustand des ICE-Sammelprozesses geändert hat. Auch über dieonstatechange
-Ereignislistener-Eigenschaft verfügbar.
Beispiele
tbd
Spezifikationen
Specification |
---|
WebRTC: Real-Time Communication in Browsers # dom-rtcicetransport |
Browser-Kompatibilität
BCD tables only load in the browser