RTCPeerConnection: currentLocalDescription-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 Eigenschaft currentLocalDescription der Schnittstelle RTCPeerConnection gibt ein RTCSessionDescription-Objekt zurück, das das lokale Ende der Verbindung beschreibt, wie es zuletzt erfolgreich ausgehandelt wurde, seit das letzte Mal die RTCPeerConnection mit einem entfernten Peer ausgehandelt und verbunden wurde. Ebenfalls enthalten ist eine Liste von ICE-Kandidaten, die möglicherweise bereits vom ICE-Agenten generiert wurden, seit das Angebot oder die Antwort, die durch die Beschreibung dargestellt wird, erstmals instanziiert wurde.

Um die currentLocalDescription zu ändern, rufen Sie RTCPeerConnection.setLocalDescription() auf, was eine Reihe von Ereignissen auslöst, die dazu führen, dass dieser Wert gesetzt wird. Für Details darüber, was genau passiert und warum die Änderung nicht unbedingt sofort erfolgt, siehe Ausstehende und aktuelle Beschreibungen auf der WebRTC-Konnektivitätsseite.

Hinweis: Im Gegensatz zu RTCPeerConnection.localDescription stellt dieser Wert den tatsächlichen aktuellen Zustand des lokalen Endes der Verbindung dar; localDescription kann eine Beschreibung angeben, zu der die Verbindung gerade wechselt.

Wert

Die aktuelle Beschreibung des lokalen Endes der Verbindung, falls eine gesetzt wurde. Falls keine erfolgreich gesetzt wurde, ist dieser Wert null.

Beispiele

Dieses Beispiel betrachtet die currentLocalDescription und zeigt einen Alarm an, der die type- und sdp-Felder des RTCSessionDescription-Objekts enthält.

js
const pc = new RTCPeerConnection();
// ...
const sd = pc.currentLocalDescription;
if (sd) {
  alert(`Local session: type='${sd.type}'; sdp description='${sd.sdp}'`);
} else {
  alert("No local session yet.");
}

Spezifikationen

Specification
WebRTC: Real-Time Communication in Browsers
# dom-peerconnection-currentlocaldesc

Browser-Kompatibilität

BCD tables only load in the browser

Hinweis: Die Hinzufügung von currentLocalDescription und pendingLocalDescription zur WebRTC-Spezifikation ist relativ neu. In Browsern, die sie nicht unterstützen, verwenden Sie einfach localDescription.

Siehe auch