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
var senders = rtcPeerConnection.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
s is not defined by the specification, and may change from one call to getSenders()
to the next.
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
.
function setMuting(pc, muting) { let senderList = pc.getSenders(); senderList.forEach(sender) { sender.track.enabled = !muting; } }
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCPeerConnection.getSenders()' in that specification. |
Candidate Recommendation | Initial specification. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
getSenders | Chrome Full support 64 | Edge Full support ≤18 | Firefox Full support 22 | IE No support No | Opera Full support 51 | Safari Full support 11 | WebView Android Full support 64 | Chrome Android Full support 64 | Firefox Android Full support 44 | Opera Android Full support 47 | Safari iOS Full support Yes | Samsung Internet Android Full support 6.0 |
Legend
- Full support
- Full support
- No support
- No support