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 currentLocalDescription schreibgeschützte Eigenschaft des RTCPeerConnection-Interfaces gibt ein RTCSessionDescription-Objekt zurück, das das lokale Ende der Verbindung beschreibt, wie es zuletzt erfolgreich ausgehandelt wurde seit dem letzten Mal, als die RTCPeerConnection die Verhandlung und Verbindung zu einem entfernten Peer abgeschlossen hat. Auch enthalten ist eine Liste von ICE-Kandidaten, die möglicherweise bereits vom ICE-Agenten generiert wurden, seit das durch die Beschreibung repräsentierte Angebot oder die Antwort erstmals instanziiert wurde.

Um die currentLocalDescription zu ändern, rufen Sie RTCPeerConnection.setLocalDescription() auf. Dies löst eine Reihe von Ereignissen aus, die dazu führen, dass dieser Wert gesetzt wird. Einzelheiten dazu, was genau passiert und warum die Änderung nicht unbedingt sofort erfolgt, finden Sie unter Ausstehende und aktuelle Beschreibungen auf der WebRTC-Verbindungsseite.

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

Wert

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

Beispiele

Dieses Beispiel betrachtet die currentLocalDescription und zeigt einen Alarm, 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

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

Siehe auch