RTCPeerConnection.onaddstream

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. 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 RTCPeerConnection.onaddstream event handler is a property containing the code to execute when the addstream event, of type MediaStreamEvent, is received by this RTCPeerConnection. Such an event is sent when a MediaStream is added to this connection by the remote peer. The event is sent immediately after the call setRemoteDescription() and doesn't wait for the result of the SDP negotiation.

This property has been removed from the specification; you should now use RTCPeerConnection.ontrack to watch for track events instead. It is included here in order to help you adapt existing code and understand existing samples, which may not be up-to-date yet.

Syntax

RTCPeerConnection.onaddstream = eventHandler;

Value

This property is a function which handles addstream events. These events, of type MediaStreamEvent, are sent when streams are added to the connection by the remote peer. The first time an event occurs may be nearly immediately after the remote end of the connection is set using RTCPeerConnection.setRemoteDescription(); it doesn't wait for a particular stream to be accepted or rejected using SDP negotiation.

Example

This code, based on an older version of our Signaling and video calling sample, responds to addstream events by setting the video source for a <video> element to the stream specified in the event, and then enabling a "hang up" button in the app's user interface.

pc.onaddstream = function(event) {
  document.getElementById("received_video").srcObject = event.stream;
  document.getElementById("hangup-button").disabled = false;
};

Specifications

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

Browser compatibility

This property has been removed from the specification; you should now use RTCPeerConnection.ontrack to watch for track events instead. It is included here in order to help you adapt existing code and understand existing samples, which may not be up-to-date yet.

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

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

[2] Although this property isn't prefixed, the RTCPeerConnection interface to which it belongs was until Firefox 44.

See also

Document Tags and Contributors

Tags: 
 Contributors to this page: jpmedley, abbycar, Sheppy, chrisjsimpson, teoli
 Last updated by: jpmedley,