RTCSessionDescriptionCallback

Deprecated
This feature has been removed from the Web standards. Though some browsers may still support it, it is in the process of being dropped. Avoid using it and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The RTCSessionDescriptionCallback type is used to represent the callback function passed into the deprecated callback-based version of createOffer() or createAnswer() when using them to create offers or answers.

Because this function type is part of the legacy WebRTC API, you should avoid using it (and the callback-based forms of createOffer() and createAnswer() that make use of it).

Syntax

RTCSessionDescriptionCallback(description);

Parameters

description
An RTCSessionDescriptionInit (or RTCSessionDescription) object describing the session being offered or being accepted. This object contains the type and sdp properties which are part of RTCSessionDescription.

Return value

The callback doesn't need to return anything, so the return value is undefined.

Example

var pc = new RTCPeerConnection();
var descriptionCallback = function(offer) {
  pc.setLocalDescription(offer);
}
pc.createOffer(descriptionCallback);

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCSessionDescriptionCallback' in that specification.
Working Draft Initial definition.

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes) (Yes) 22 (22) ? ? ?
Deprecated in favor of Promise-based versions of createOffer() and createAnswer() 52.0 ? 37 (37) ? ? ?
Callback input is RTCSessionDescriptionInit ? ? 53 (53) ? ? ?
Feature Android Webview Chrome for Android Edge Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support (Yes) (Yes) (Yes) 24.0 (24) ? ? ?
Promise-based version 52.0 52.0 ? 37.0 (37) ? ? ?
Callback input is RTCSessionDescriptionInit ? ? ? 53.0 (53) ? ? ?

[1] This callback type was deprecated in Chrome 49.

See also

Document Tags and Contributors

 Contributors to this page: Sheppy, tocretpa, teoli, wesj
 Last updated by: Sheppy,