RTCPeerConnection.localDescription

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

Browser compatibilityUpdate compatibility data on GitHub

See also

• RTCPeerConnection.setLocalDescription(), RTCPeerConnection.pendingLocalDescription, RTCPeerConnection.currentLocalDescription
• RTCPeerConnection.setRemoteDescription(), RTCPeerConnection.remoteDescription, RTCPeerConnection.pendingRemoteDescription, RTCPeerConnection.currentRemoteDescription
• WebRTC