RTCPeerConnection.currentLocalDescription

The read-only property RTCPeerConnection.currentLocalDescription returns an RTCSessionDescription object describing the local end of the connection as it was most recently successfully negotiated since the last time the  RTCPeerConnection finished negotiating and connecting to a remote peer. Also included is a list of any ICE candidates that may already have been generated by the ICE agent since the offer or answer represented by the description was first instantiated.

To change the currentLocalDescription, call RTCPeerConnection.setLocalDescription(), which triggers a series of events which leads to this value being set. For details on what exactly happens and why the change isn't necessarily instantaneous, see Pending and current descriptions in WebRTC connectivity.

Unlike RTCPeerConnection.localDescription, this value represents the actual current state of the local end of the connection; localDescription may specify a description which the connection is currently in the process of switching over to.

Syntax

sessionDescription = RTCPeerConnection.currentLocalDescription;

Return value

The current description of the local end of the connection, if one has been set. If none has been successfully set, this value is null.

Example

This example looks at the currentLocalDescription and displays an alert containing the RTCSessionDescription object's type and sdp fields.

var pc = new RTCPeerConnection();
…
var sd = pc.currentLocalDescription;
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.currentLocalDescription' in that specification.
Candidate Recommendation Initial specification.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support56 Yes22 ?

431

37 — 43

?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support5656 Yes44

431

37 — 43

?6.0

1. Promise based version.

The addition of currentLocalDescription and pendingLocalDescription to the WebRTC spec is relatively recent. In browsers which don't support them, just use localDescription.

See also

Document Tags and Contributors

Contributors to this page: fscholz, Sheppy, jpmedley
Last updated by: fscholz,