RTCSessionDescription()

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.

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. Do not use it in old or new projects. Pages or Web apps using it may break at any time.

The RTCSessionDescription() constructor creates a new RTCSessionDescription.

Syntax

JavaScript
sessionDescription = new RTCSessionDescription(rtcSessionDescriptionInit);

Values

rtcSessionDescriptionInit Optional
Is a RTCSessionDescriptionInit dictionary, having the following fields:
  • "type", optional and defaulting to null, of type RTCSdpType, that is "offer", "answer" or "pranswer".
  • "sdp", optional and defaulting to null, of type DOMString and containing a SDP message describing the session.

Example

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

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

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browser
The definition of 'RTCSessionDescription()' in that specification.		 Working Draft Initial specification.

[1] Though this property is not prefixed, the interface it belongs to is.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support (Yes) (Yes) [1] No support (Yes) ?
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support ? ? ? No support ? ?

See also

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

Constructor Deprecated Experimental Reference RTCSessionDescription WebRTC