RTCPeerConnection.pendingLocalDescription
This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
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 WebRTC connectivity.
Syntax
var sessionDescription = peerConnection.pendingLocalDescription;
Return value
If a local description change is in progress, this is an RTCSessionDescription
describing the proposed configuration. Otherwise, this returns null
.
Example
This example looks at the pendingLocalDescription
to determine whether or not there's a description change being processed.
var pc = new RTCPeerConnection(); … var sd = pc.pendingLocalDescription; if (sd) { // There's a description change underway! } else { // No description change pending }
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browser The definition of 'RTCPeerConnection.pendingLocalDescription' in that specification. |
Working Draft | Initial specification. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | No support | No support | No support | No support | No support |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | No support | No support | No support | No support | No support | No support |
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
RTCPeerConnection.setLocalDescription()
,RTCPeerConnection.currentLocalDescription
,RTCPeerConnection.localDescription
RTCPeerConnection.setRemoteDescription()
,RTCPeerConnection.remoteDescription
,RTCPeerConnection.pendingRemoteDescription
,RTCPeerConnection.currentRemoteDescription
- WebRTC
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/rtcpeerconnection/pendinglocaldescription