RTCPeerConnection: Methode getSenders()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

Die getSenders()-Methode des RTCPeerConnection-Interfaces gibt ein Array von RTCRtpSender-Objekten zurück, von denen jedes den RTP-Sender repräsentiert, der für die Übertragung der Daten eines Tracks verantwortlich ist. Ein Sender-Objekt stellt Methoden und Eigenschaften zur Verfügung, um die Kodierung und Übertragung der Daten des Tracks zu untersuchen und zu steuern.

Syntax

js
getSenders()

Rückgabewert

Ein Array von RTCRtpSender-Objekten, eines für jeden Track in der Verbindung. Das Array ist leer, wenn keine RTP-Sender in der Verbindung vorhanden sind.

Die Reihenfolge der zurückgegebenen RTCRtpSender-Instanzen ist in der Spezifikation nicht definiert und kann sich von einem Aufruf von getSenders() zum nächsten ändern.

Das Array umfasst keine Sender, die mit Transceivern verbunden sind, die gestoppt wurden (im Anschluss an Angebot/Antwort).

Beispiel

In diesem Beispiel wird eine setMuting()-Funktion gezeigt. Diese Funktion nimmt als Eingabe eine RTCPeerConnection, pc, und einen Boolean, muting. Die Funktion erhält die Liste der Sender der Peer-Verbindung und iteriert über jeden Sender, um die entsprechende Medientrack-enabled-Eigenschaft auf das inverse der angegebenen muting einzustellen.

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

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

Spezifikationen

Specification
WebRTC: Real-Time Communication in Browsers
# dom-peerconnection-getsenders

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch