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 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.
Important: 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
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; };
You can also use addEventListener()
to add a handler for addstream
events to an RTCPeerConnection
.
Browser compatibility
Important: 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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
onaddstream | Chrome Full support 24 | Edge Full support 15 | Firefox Full support 22 | IE No support No | Opera
Full support
43
| Safari No support No | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support 44 | Opera Android
Full support
43
| Safari iOS No support No | Samsung Internet Android Full support 6.0 |
Legend
- Full support
- Full support
- No support
- No support
- Non-standard. Expect poor cross-browser support.
- Non-standard. Expect poor cross-browser support.
- Deprecated. Not for use in new websites.
- Deprecated. Not for use in new websites.
- See implementation notes.
- See implementation notes.
See also
- Use the newer
track
event, its typeRTCTrackEvent
, and theRTCPeerConnection.ontrack
event handler property instead of this. - The
addstream
event and its type,MediaStreamEvent
.