RTCRtpReceiver: getParameters()-Methode

Baseline 2024 *
Newly available

Since July 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

* Some parts of this feature may have varying levels of support.

Die getParameters()-Methode des RTCRtpReceiver-Interfaces gibt ein Objekt zurück, das die aktuelle Konfiguration für die Dekodierung der track des Empfängers beschreibt.

Syntax

js
getParameters()

Parameter

Keine.

Rückgabewert

Ein Objekt, das die aktuelle Konfiguration des Empfängers angibt.

codecs

Ein Array von Objekten, das die Mediakodecs beschreibt, die der Empfänger verwenden kann. Dies ist die Teilmenge von Codecs, die der Empfänger bevorzugt und die der entfernte Endpunkt bereit ist zu senden. Dieser Parameter kann nach der ersten Einstellung nicht geändert werden.

Jedes Codec-Objekt im Array kann die folgenden Eigenschaften aufweisen:

channels Optional

Eine positive ganze Zahl, die die Anzahl der Kanäle angibt, die vom Codec unterstützt werden. Beispielsweise gibt für Audiocodecs ein Wert von 1 monauralen Ton an, während 2 Stereo bedeutet.

clockRate

Eine positive ganze Zahl, die die Clockrate des Codecs in Hertz (Hz) spezifiziert. Die Clockrate ist die Geschwindigkeit, mit der der RTP-Zeitstempel des Codecs voranschreitet. Die meisten Codecs haben spezifische Werte oder Wertbereiche, die sie zulassen. Die IANA führt eine Liste von Codecs und deren Parametern, einschließlich ihrer Clockraten.

mimeType

Ein String, der den MIME-Medientyp und Subtypen des Codecs angibt, spezifiziert als ein String der Form "type/subtype". Die von RTP verwendeten MIME-Type-Strings unterscheiden sich von denen, die anderswo verwendet werden. IANA hält ein Register der gültigen MIME-Typen. Auch siehe Codec's, die von WebRTC verwendet werden für Details zu möglichen Codecs, die hier referenziert werden könnten.

payloadType

Der RTP-Payloadtyp, der verwendet wird, um diesen Codec zu identifizieren.

sdpFmtpLine Optional

Ein String, der das Format-spezifische Parameterfeld aus der a=fmtp-Zeile in der SDP angibt, das dem Codec mit der SDP vom remote Peer entspricht, falls das Feld vorhanden ist. Wenn kein Parameterfeld vorhanden ist, bleibt diese Eigenschaft weggelassen. Siehe Abschnitt 5.8 der IETF-Spezifikation für JSEP für weitere Informationen.

headerExtensions

Ein Array von null oder mehr RTP-Header-Erweiterungen, die jeweils eine vom Sender oder Empfänger unterstützte Erweiterung identifizieren. Header-Erweiterungen werden in RFC 3550, Abschnitt 5.3.1 beschrieben. Dieser Parameter kann nach der ersten Einstellung nicht geändert werden.

rtcp

Ein RTCRtcpParameters-Objekt, das die Konfigurationsparameter für RTCP auf dem Sender oder Empfänger bereitstellt. Dieser Parameter kann nach der ersten Einstellung nicht geändert werden.

Beispiele

Dieses Beispiel erhält den kanonischen Namen (CNAME), der für RTCP auf einem RTCRtpReceiver verwendet wird.

js
function getRtcpCNAME(receiver) {
  let parameters = receiver.getParameters();

  return parameters.rtcp.cname;
}

Spezifikationen

Specification
WebRTC: Real-Time Communication in Browsers
# dom-rtcrtpreceiver-getparameters

Browser-Kompatibilität