RTCPeerConnection: addStream() method
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 thecompatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.
TheaddStream() method of theRTCPeerConnection interface adds aMediaStream as a local source of audio or video.Instead of using this obsolete method, you should instead useaddTrack() once for each track you wish to send to the remote peer.
If thesignalingState is set toclosed, anInvalidStateError is raised.If thesignalingState is set tostable, the eventnegotiationneeded is sent on theRTCPeerConnection to indicate thatICE negotiation must be repeated to consider the new stream.
In this article
Syntax
addStream(mediaStream)Parameters
mediaStreamA
MediaStreamobject indicating the stream to add to the WebRTC peer connection.
Return value
None.
Example
This simple example adds the audio and video stream coming from the user's camera to the connection.
navigator.mediaDevices.getUserMedia({ video: true, audio: true }, (stream) => { const pc = new RTCPeerConnection(); pc.addStream(stream);});Migrating to addTrack()
Compatibility allowing, you should update your code to instead use theaddTrack() method:
navigator.getUserMedia({ video: true, audio: true }, (stream) => { const pc = new RTCPeerConnection(); stream.getTracks().forEach((track) => { pc.addTrack(track, stream); });});The neweraddTrack() API avoids confusion over whether later changes to the track-makeup of a stream affects a peer connection (they do not).
The exception is in Chrome, whereaddStream()does make the peer connection sensitive to later stream changes (though such changes do not fire thenegotiationneeded event).If you are relying on the Chrome behavior, note that other browsers do not have it.You can write web compatible code using feature detection instead:
// Add a track to a stream and the peer connection said stream was added to:stream.addTrack(track);if (pc.addTrack) { pc.addTrack(track, stream);} else { // If you have code listening for negotiationneeded events: setTimeout(() => pc.dispatchEvent(new Event("negotiationneeded")));}// Remove a track from a stream and the peer connection said stream was added to:stream.removeTrack(track);if (pc.removeTrack) { pc.removeTrack(pc.getSenders().find((sender) => sender.track === track));} else { // If you have code listening for negotiationneeded events: setTimeout(() => pc.dispatchEvent(new Event("negotiationneeded")));}