RTCPeerConnection: icecandidateerror-Ereignis

Baseline 2026

Neu verfügbar

Seit April 2026 funktioniert diese Funktion auf aktuellen Geräten und in aktuellen Browserversionen. Auf älteren Geräten oder in älteren Browsern funktioniert sie möglicherweise nicht.

Das icecandidateerror-Ereignis wird an eine RTCPeerConnection gesendet, wenn ein Fehler bei der Durchführung der ICE-Verhandlung über einen STUN- oder TURN-Server auftritt.

Dieses Ereignis kann nicht abgebrochen werden und wird nicht weitergeleitet.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignishandler-Eigenschaft.

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

onicecandidateerror = (event) => { }

Ereignistyp

Ein RTCPeerConnectionIceErrorEvent. Erbt von Event.

Ereigniseigenschaften

Die RTCPeerConnectionIceErrorEvent-Schnittstelle enthält 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, um die Verbindung auszuhandeln, oder null, wenn die lokale IP-Adresse noch nicht als Teil eines lokalen ICE-Kandidaten offengelegt wurde.
errorCode Schreibgeschützt: Ein positiver ganzzahliger Wert, 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 Nummer 701 gesetzt, die außerhalb des gültigen Bereichs von STUN-Fehlercodes liegt. Dieser Wert wird nur einmal pro Server-URL gemeldet und nur, während der iceGatheringState gathering ist.
errorText Schreibgeschützt: Ein String, der den STUN-Reason-Text 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, wird dieser String ein browserspezifischer String sein, der den Fehler erklärt.
port Schreibgeschützt: Ein positiver ganzzahliger Wert, der die Portnummer angibt, über die die Kommunikation mit dem STUN- oder TURN-Server erfolgt, unter Verwendung der in address angegebenen IP-Adresse. Dies ist null, wenn die Verbindung nicht hergestellt wurde (das heißt, wenn address null ist).
url Schreibgeschützt: Ein String, der die URL des STUN- oder TURN-Servers angibt, mit dem der Fehler aufgetreten ist.

Das folgende Beispiel richtet einen Handler für icecandidateerror-Ereignisse ein, die auf der RTCPeerConnection pc auftreten. Dieser Handler sucht speziell nach Fehlern 701, die darauf hinweisen, dass Kandidaten den STUN- oder TURN-Server nicht erreichen konnten.

Wenn dies geschieht, werden die Server-URL und die Fehlermeldung an eine Funktion namens reportConnectFail() übergeben, um das Verbindungsproblem zu protokollieren oder auszugeben.

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

Beachten Sie, dass dieser Fehler möglicherweise mehr als einmal auftritt, wenn mehrere STUN- und/oder TURN-Server bei der Erstellung der Verbindung angegeben werden, falls mehr als einer dieser Server ausfällt. Jeder bereitgestellte Server wird ausprobiert, bis eine Verbindung hergestellt wird.