RTCRtpReceiver: getParameters() Methode

Die getParameters() Methode der RTCRtpReceiver Schnittstelle gibt ein Objekt zurück, das die aktuelle Konfiguration beschreibt, wie die track des Empfängers dekodiert wird.

Syntax

js
getParameters()

Parameter

Keine.

Rückgabewert

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

codecs

Ein Array von Objekten, das die Medien-Codecs beschreibt, die der Empfänger verwenden kann. Dies ist die Untermenge der Codecs, die der Empfänger bevorzugt und die der entfernte Endpunkt senden kann. Dieser Parameter kann, einmal gesetzt, nicht mehr geändert werden.

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

channels Optional

Eine positive ganze Zahl, die die Anzahl der vom Codec unterstützten Kanäle angibt. Zum Beispiel gibt ein Wert von 1 für Audiocodecs Monosound an, während 2 Stereo anzeigt.

clockRate

Eine positive ganze Zahl, die die Taktfrequenz des Codecs in Hertz (Hz) angibt. Die Taktfrequenz ist die Rate, mit der der RTP-Zeitstempel des Codecs fortschreitet. 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 Taktfrequenzen.

mimeType

Ein String, der den MIME-Medientyp und -Untertyp des Codecs angibt, als String der Form "type/subtype" spezifiziert. Die MIME-Typ-Strings, die von RTP verwendet werden, unterscheiden sich von denen, die anderswo verwendet werden. IANA führt ein Register gültiger MIME-Typen. Siehe auch Codecs, die von WebRTC verwendet werden für Details zu potenziellen Codecs, die hier referenziert werden könnten.

payloadType

Der RTP-Nutzlasttyp, der zur Identifizierung dieses Codecs verwendet wird.

sdpFmtpLine Optional

Ein String, der die formatspezifischen Parameter aus der a=fmtp-Zeile in der SDP angibt, die dem Codec SDP des entfernten Peers entspricht, falls das Feld vorhanden ist. Wenn kein Parameterfeld vorhanden ist, wird diese Eigenschaft weggelassen. Siehe Abschnitt 5.8 der IETF-Spezifikation für JSEP für weitere Informationen.

headerExtensions

Ein Array mit null oder mehr RTP-Headererweiterungen, 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, einmal gesetzt, nicht mehr geändert werden.

rtcp

Ein RTCRtcpParameters Objekt, das die Konfigurationsparameter für RTCP auf dem Sender oder Empfänger bereitstellt. Dieser Parameter kann, einmal gesetzt, nicht mehr 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

BCD tables only load in the browser