W3cubDocs

/Web APIs

RTCPeerConnection: getSenders() method

The RTCPeerConnection method getSenders() returns an array of RTCRtpSender objects, each of which represents the RTP sender responsible for transmitting one track's data. A sender object provides methods and properties for examining and controlling the encoding and transmission of the track's data.

Syntax

js

getSenders()

Return value

An array of RTCRtpSender objects, one for each track on the connection. The array is empty if there are no RTP senders on the connection.

The order of the returned RTCRtpSender instances is not defined by the specification, and may change from one call to getSenders() to the next.

The array does not include senders associated with transceivers that have been stopped (following offer/answer).

Example

In this example, a setMuting() function is shown. This function takes as input an RTCPeerConnection, pc, and a Boolean, muting. The function gets the list of the peer connection's senders and iterates over every sender, setting the corresponding media track's enabled to the inverse of the specified muting.

js

function setMuting(pc, muting) {
  let senderList = pc.getSenders();

  senderList.forEach((sender) => {
    sender.track.enabled = !muting;
  });
}

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getSenders 64 79 34 No 51 11 64 64 34 47 11 6.0
stopped_transceivers_removed 88 88 118 No 74 No 88 88 118 63 No 15.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getSenders