W3cubDocs

/Web APIs

RTCPeerConnection: pendingLocalDescription property

The read-only property RTCPeerConnection.pendingLocalDescription returns an RTCSessionDescription object describing a pending configuration change for the local end of the connection. This does not describe the connection as it currently stands, but as it may exist in the near future. Use RTCPeerConnection.currentLocalDescription or RTCPeerConnection.localDescription to get the current state of the endpoint. For details on the difference, see Pending and current descriptions in the WebRTC Connectivity page.

Value

If a local description change is in progress, this is an RTCSessionDescription describing the proposed configuration. Otherwise, this returns null.

Examples

This example looks at the pendingLocalDescription to determine whether or not there's a description change being processed.

js

const pc = new RTCPeerConnection();
// ...
const sd = pc.pendingLocalDescription;
if (sd) {
  // There's a description change underway!
} else {
  // No description change pending
}

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
pendingLocalDescription 70 79 22 No 57 11 70 70 24 49 11 10.0

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

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/pendingLocalDescription