RTCRtpReceiver: getParameters() Methode

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

Syntax

js
getParameters()

Parameter

Keine.

Rückgabewert

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

codecs

Ein Array von Objekten, das die Medien-Codecs beschreibt, die der Empfänger bereit ist zu nutzen. Dies ist der Satz von Codecs, den der Empfänger bevorzugt und den der entfernte Endpunkt bereit ist zu senden. Dieser Parameter kann nach anfänglicher Festlegung 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 bei Audio-Codecs Mono-Sound an, während 2 Stereo bedeutet.

clockRate

Eine positive ganze Zahl, die die Abtastrate des Codecs in Hertz (Hz) angibt. Die Abtastrate ist die Rate, mit der der RTP-Zeitstempel des Codecs fortschreitet. Die meisten Codecs haben spezifische Werte oder Wertebereiche, die sie zulassen. Die IANA führt eine Liste der Codecs und ihrer Parameter, einschließlich ihrer Abtastraten.

mimeType

Ein String, der den MIME-Medientyp und Subtyp des Codecs angibt, spezifiziert als ein String der Form "type/subtype". Die MIME-Typen, die von RTP verwendet werden, unterscheiden sich von denen, die anderswo benutzt werden. Die IANA führt ein Verzeichnis gültiger MIME-Typen. Auch sehen Sie Codecs verwendet von WebRTC für Details zu potenziellen Codecs, die hier referenziert sein könnten.

payloadType

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

sdpFmtpLine Optional

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

headerExtensions

Ein Array von null oder mehr RTP-Header-Erweiterungen, von denen jede eine vom Sender oder Empfänger unterstützte Erweiterung identifiziert. Header-Erweiterungen werden in RFC 3550, Abschnitt 5.3.1 beschrieben. Dieser Parameter kann nach anfänglicher Festlegung nicht mehr geändert werden.

rtcp

Ein RTCRtcpParameters Objekt, das die Konfigurationsparameter bereitstellt, die für RTCP auf dem Sender oder Empfänger verwendet werden. Dieser Parameter kann nach anfänglicher Festlegung 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

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
getParameters
codecs property in returned object
headerExtensions property in returned object
rtcp property in returned object

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support