This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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.
Syntax
var 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 WebRTC connectivity 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.
var pc = new RTCPeerConnection(); … var sd = pc.localDescription; if (sd) { alert("Local session: type='" + sd.type + "'; sdp description='" + sd.sdp + "'"); } else { alert("No local session yet."); }
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCPeerConnection.localDescription' in that specification. |
Candidate Recommendation | Initial specification. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
localDescription | Chrome Full support 24 | Edge Full support 15 | Firefox Full support 22 | IE No support No | Opera
Full support
43
| Safari Full support 11 | WebView Android Full support Yes | Chrome Android Full support 25 | Firefox Android Full support 44 | Opera Android
Full support
43
| Safari iOS Full support Yes | Samsung Internet Android Full support 6.0 |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
- See implementation notes.