RTCSessionDescription: RTCSessionDescription() constructor

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. 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 RTCSessionDescription() constructor creates a new RTCSessionDescription with its properties initialized as described in the specified object.

Note: This constructor has been deprecated because RTCPeerConnection.setLocalDescription() and other methods which take SDP as input now directly accept an object containing the type and sdp properties, so you don't have to instantiate an RTCSessionDescription yourself.

Syntax

new RTCSessionDescription(options)

Values

options

An object providing the default values for the session description. It should contain the following properties:

type: Required. A string which is used to set the type property of the new RTCSessionDescription object. Must be one of the valid RTCSessionDescription.type values.
sdp Optional: A string containing a SDP message describing the session. This value is an empty string ("") by default and may not be null.

Example

This example uses the constructor to convert an SDP offer into an RTCSessionDescription object.

Note: This is no longer necessary, however; RTCPeerConnection.setLocalDescription() and other methods which take SDP as input now directly accept plain objects, so you don't have to instantiate an RTCSessionDescription yourself.

navigator.getUserMedia({ video: true }, (stream) => {
  pc.onaddstream({ stream });
  // Adding a local stream won't trigger the onaddstream callback
  pc.addStream(stream);

  pc.createOffer((offer) => {
    pc.setLocalDescription(
      new RTCSessionDescription(offer),
      () => {
        // send the offer to a server to be forwarded to the friend you're calling.
      },
      error,
    );
  }, error);
});

Specifications

This feature does not appear to be defined in any specification.

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`RTCSessionDescription()` constructor Deprecated	Chrome – Full support Chrome 23 (Release date: 2012-11-06) footnote Full support	Edge – Full support Edge 15 (Release date: 2017-04-05) footnote Full support	Firefox – Full support Firefox 22 (Release date: 2013-06-25) prefix prefix Implemented with the vendor prefix: moz Firefox – Full support Firefox 44 (Release date: 2016-01-26) footnote Full support	Opera – Full support Opera 15 (Release date: 2013-07-02) footnote Full support	Safari – Full support Safari 11 (Release date: 2017-09-19) footnote Full support	Chrome Android – Full support Chrome Android 25 (Release date: 2013-02-27) footnote Full support	Firefox for Android – Full support Firefox for Android 24 (Release date: 2013-09-17) prefix prefix Implemented with the vendor prefix: moz Firefox for Android – Full support Firefox for Android 44 (Release date: 2016-01-26) footnote Full support	Opera Android – Full support Opera Android 14 (Release date: 2013-05-21) footnote Full support	Safari on iOS – Full support Safari on iOS 11 (Release date: 2017-09-19) footnote Full support	Samsung Internet – Full support Samsung Internet 1.5 (Release date: 2013-09-25) footnote Full support	WebView Android – Full support WebView Android 4.4 (Release date: 2013-12-09) footnote Full support	WebView on iOS – Full support WebView on iOS 11 (Release date: 2017-09-19) footnote Full support

Tip: you can click/tap on a cell for more information.

Full support: Full support
: Deprecated. Not for use in new websites.
: Requires a vendor prefix or different name for use.
: Has more compatibility info.