The read-only property RTCPeerConnection.localDescription
returns an RTCSessionDescription
describing the session for the local end of the connection. If it has not yet been set, this is null
.
On this page
RTCPeerConnection: localDescription property
Syntax
js
const sessionDescription = peerConnection.localDescription
On a more fundamental level, the returned value is the value of RTCPeerConnection.pendingLocalDescription
if that property isn't null
; otherwise, the value of RTCPeerConnection.currentLocalDescription
is returned. See Pending and current descriptions in the WebRTC Connectivity page for details on this algorithm and why it's used.
Example
This example looks at the localDescription
and displays an alert containing the RTCSessionDescription
object's type
and sdp
fields.
js
const pc = new RTCPeerConnection();
// ...
const sd = pc.localDescription;
if (sd) {
alert(`Local session: type='${sd.type}'; sdp description='${sd.sdp}'`);
} else {
alert("No local session yet.");
}
Specifications
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
localDescription |
24 | 15 | 22 | No | 15 | 11 | 4.4 | 25 | 24 | 14 | 11 | 1.5 |
See also
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/localDescription