RTCPeerConnection: icecandidateerror-Event

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder legen Sie eine Ereignis-Handler-Eigenschaft fest.

addEventListener("icecandidateerror", (event) => {});

onicecandidateerror = (event) => {};

Ein RTCPeerConnectionIceErrorEvent. Erbt von Event.

Die RTCPeerConnectionIceErrorEvent-Schnittstelle umfasst die Eigenschaften, die auf der Event-Schnittstelle zu finden sind, sowie die folgenden Eigenschaften:

address Schreibgeschützt

Ein String, der die lokale IP-Adresse angibt, die zur Kommunikation mit dem STUN- oder TURN-Server verwendet wird, der zur Aushandlung der Verbindung verwendet wird, oder null, wenn die lokale IP-Adresse noch nicht als Teil eines lokalen ICE-Kandidaten offengelegt wurde.

errorCode Schreibgeschützt

Ein nicht vorzeichenbehafteter Ganzzahlwert, der den numerischen STUN-Fehlercode angibt, der vom STUN- oder TURN-Server zurückgegeben wird. Wenn kein Host-Kandidat den Server erreichen kann, wird diese Eigenschaft auf die Zahl 701 gesetzt, die außerhalb des Bereichs gültiger STUN-Fehlercodes liegt. Der 701-Fehler wird nur einmal pro Server-URL ausgelöst und nur während der iceGatheringState gathering.

errorText Schreibgeschützt

Ein String, der den STUN-Grundtext enthält, der vom STUN- oder TURN-Server zurückgegeben wird. Wenn die Kommunikation mit dem STUN- oder TURN-Server überhaupt nicht hergestellt werden konnte, enthält dieser String eine browserspezifische Zeichenfolge, die den Fehler erklärt.

port Schreibgeschützt

Ein nicht vorzeichenbehafteter Ganzzahlwert, der die Portnummer angibt, über die die Kommunikation mit dem STUN- oder TURN-Server erfolgt, unter Verwendung der in address angegebenen IP-Adresse. null, wenn die Verbindung nicht hergestellt wurde (d. h. wenn address null ist).

url Schreibgeschützt

Ein String, der die URL des STUN- oder TURN-Servers angibt, mit dem der Fehler aufgetreten ist.

Die Eigenschaft errorCode des Fehlerobjekts ist einer der numerischen STUN-Fehlercodes. Es gibt einen zusätzlichen, WebRTC-spezifischen Fehler, der außerhalb des gültigen STUN-Fehlercodes-Bereichs liegt: 701. Fehler 701 zeigt an, dass keiner der ICE-Kandidaten erfolgreich Kontakt mit dem STUN- oder TURN-Server aufnehmen konnte.

Der 701-Fehler wird nur einmal pro Server-URL aus der Liste der verfügbaren STUN- oder TURN-Server ausgelöst, die beim Erstellen der RTCPeerConnection bereitgestellt wurden. Diese Fehler treten nur auf, wenn sich der ICE-Gathering-State der Verbindung im Zustand gathering befindet.

Das folgende Beispiel legt einen Handler für icecandidateerrors fest, die bei der RTCPeerConnection pc auftreten. Dieser Handler sucht speziell nach 701-Fehlern, die darauf hinweisen, dass Kandidaten den STUN- oder TURN-Server nicht erreichen konnten.

Wenn dies passiert, werden die Server-URL und die Fehlermeldung an eine Funktion namens reportConnectFail() übergeben, um das Verbindungsfehlerprotokoll zu führen oder auszugeben.

pc.addEventListener("icecandidateerror", (event) => {
  if (event.errorCode === 701) {
    reportConnectFail(event.url, event.errorText);
  }
});

Beachten Sie, dass dieser Fehler, wenn mehrere STUN- und/oder TURN-Server beim Erstellen der Verbindung bereitgestellt werden, mehrmals auftreten kann, wenn mehr als einer dieser Server ausfällt. Jeder bereitgestellte Server wird ausprobiert, bis eine Verbindung hergestellt ist.