RTCPeerConnection.getStreamById()

Experimental

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

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.getStreamById() method returns the MediaStream with the given id that is associated with local or remote end of the connection. If no stream matches, it returns null.

This property has been replaced with the RTCPeerConnection.getLocalStreams and RTCPeerConnection.getRemoteStreams properties. If you have code that uses stream, you will need to update, since browsers have begun to remove support for stream.

Syntax

var mediaStream = pc.getStream(id);

Parameters

id
Is a DOMString corresponding to the stream to return.

Example

var stream = pc.getStreamById(myTrackId);
if (stream) {
  console.log("Found stream: " + stream.id);
}

Polyfill

Running the following code before any other code will create RTCPeerConnection.prototype.getStreamById() if it's not natively available.

// from: https://bugs.chromium.org/p/chromium/issues/detail?id=698163&desc=5#c10
RTCPeerConnection.prototype.getStreamById = function(id) {
  try {
    var localStreams = this.getLocalStreams();
    var remoteStreams = this.getRemoteStreams();
    var i;
    for (i = 0; i < localStreams.length; i++) {
     if (localStreams[i].id == id)
       return localStreams[i];
    }
    for (i = 0; i < remoteStreams.length; i++) {
     if (remoteStreams[i].id == id)
       return remoteStreams[i];
    }
  } catch(e) {}
  return null;
}

Browser compatibility

BCD tables only load in the browser

See also