RTCRtpReceiver: getParameters() Methode

Syntax

getParameters()

Parameter

Keine.

Rückgabewert

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

codecs

Ein Array von Objekten, die die Media Codecs beschreiben, die der Empfänger verwenden kann. Dies ist der Teil der Codecs, den der Empfänger bevorzugt und den die Gegenstelle senden kann. Dieser Parameter kann nach der ersten 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. Beispielsweise gibt ein Wert von 1 bei Audiocodecs Mono-Sound an, während 2 Stereo angibt.

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 voranschreitet. Die meisten Codecs haben spezifische Werte oder Wertbereiche, die sie zulassen. Die IANA führt eine Liste von Codecs und ihren Parametern, einschließlich ihrer Taktfrequenzen.

mimeType

Ein String, der den MIME Medientyp und Subtyp des Codecs angibt, als String in der Form "type/subtype". Die von RTP verwendeten MIME-Typen unterscheiden sich von denen, die anderswo verwendet werden. Die IANA führt ein Register gültiger MIME-Typen. Weitere Informationen zu potenziell hier referenzierten Codecs finden Sie unter Codecs verwendet von WebRTC.

payloadType

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

sdpFmtpLine Optional

Ein String, der das feldspezifische Parameterfeld von der a=fmtp-Zeile im SDP angibt, das dem Codec SDP von der entfernten Gegenstelle 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 mehr 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 sind in RFC 3550, Abschnitt 5.3.1 beschrieben. Dieser Parameter kann nach der ersten Festlegung nicht mehr geändert werden.

rtcp

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

Das Objekt kann die folgenden Eigenschaften haben:

cname

Ein String, der den kanonischen Namen (CNAME) angibt, der von RTCP (z. B. in SDES-Nachrichten) verwendet wird.

reducedSize

Ein Boolean, der true ist, wenn die reduzierte Größe von RTCP konfiguriert ist (RFC 5506), und false, wenn zusammengesetztes RTCP angegeben ist (RFC 3550).

Beispiele

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

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

  return parameters.rtcp.cname;
}

Spezifikationen

Browser-Kompatibilität