RTCIceCandidate: toJSON() Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2017.

Die Methode toJSON() des RTCIceCandidate konvertiert das RTCIceCandidate, auf dem sie aufgerufen wird, in JSON.

Eine zeichenkettencodierte Version des Objekts kann dann durch Aufrufen von stringify() auf dem zurückgegebenen Objekt erhalten werden.

Syntax

js
toJSON()

Parameter

Keine.

Rückgabewert

Ein JSON-Objekt mit den folgenden Eigenschaften, die auf die entsprechenden Werte im RTCIceCandidate-Objekt gesetzt wurden:

candidate Optional

Ein String, der die Netzwerkverbindungsinformationen für den Kandidaten beschreibt. Weitere Informationen finden Sie unter RTCIceCandidate.candidate.

sdpMid Optional

Ein String, der das Identifikations-Tag des Medienstroms enthält, mit dem der Kandidat verbunden ist, oder null, wenn kein zugeordneter Medienstrom vorhanden ist. Weitere Informationen finden Sie unter RTCIceCandidate.sdpMid.

sdpMLineIndex Optional

Eine Zahlen-Eigenschaft, die den nullbasierten Index der m-line enthält, mit der der Kandidat innerhalb der SDP der Medienbeschreibung verbunden ist, oder null, wenn keine solche Zuordnung besteht. Weitere Informationen finden Sie unter RTCIceCandidate.sdpMLineIndex.

usernameFragment Optional

Ein String, der das Benutzername-Fragment enthält (normalerweise in Kurzform als "ufrag" oder "ice-ufrag" bezeichnet). Dieses Fragment identifiziert zusammen mit dem ICE-Passwort ("ice-pwd") eine einzelne laufende ICE-Interaktion eindeutig (einschließlich jeder Kommunikation mit dem STUN-Server). Weitere Informationen finden Sie unter RTCIceCandidate.usernameFragment.

Hinweis: Das zurückgegebene JSON-Objekt hat die gleiche Form/Eigenschaften wie das candidateInfo-Objekt, das optional an den RTCIceCandidate()-Konstruktor übergeben werden kann, um den Kandidaten zu konfigurieren.

Beispiele

Dieses einfache Beispiel erhält einen JSON-String, der ein RTCIceCandidate darstellt, das in der Variablen candidate gefunden wurde.

js
let jsonString = candidate.toJSON().stringify();

Spezifikationen

Specification
WebRTC: Real-Time Communication in Browsers
# dom-rtcicecandidate-tojson

Browser-Kompatibilität