We're looking for a user researcher to understand the needs of developers and designers. Is this you or someone you know? Check out the post: https://mzl.la/2IGzdXS

RTCPeerConnection.addStream()

Note: This method has been deprecated; you should, compatibility allowing [2], switch to using the addTrack() method instead.

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.

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The RTCPeerConnection.addStream() method adds a MediaStream as a local source of audio or video. If the negotiation already happened, a new one will be needed for the remote peer to be able to use it.

If the signalingState is set to "closed", an InvalidStateError is raised. If the signalingState is set to "stable", the event negotiationneeded is sent on the RTCPeerConnection.

Syntax

pc.addStream(mediaStream);

Parameters

mediaStream
A MediaStream object indicating the stream to add to the WebRTC peer connection.

Return value

None.

Example

navigator.getUserMedia({video:true, audio:true}, function(stream) {
  var pc = new RTCPeerConnection();
  pc.addStream(stream);
});

Migration

Compatibility allowing [2], consider switching to using the addTrack() method instead:

navigator.getUserMedia({video:true, audio:true}, function(stream) {
  var pc = new RTCPeerConnection();
  stream.getTracks().forEach(function(track) {
    pc.addTrack(track, stream);
  });
});

The newer addTrack() 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, where addStream does make the peer connection sensitive to later stream changes (though such changes do not fire the negotiationneeded 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')));
}

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCPeerConnection.addStream()' in that specification.
Candidate Recommendation Initial specification.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support561522 ?

431

37 — 43

?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support5656 Yes44

431

37 — 43

?6.0

1. Promise based version.

See also

Document Tags and Contributors

Contributors to this page: mmckenziedev, fscholz, Jib, jpmedley, abbycar, Sheppy, teoli
Last updated by: mmckenziedev,