RTCRtpReceiver: getParameters()-Methode

Syntax

getParameters()

Parameter

Keine.

Rückgabewert

Ein Objekt, das die aktuelle Konfiguration des Receivers angibt.

codecs

Ein Array von Objekten, die die Medien-Codecs beschreiben, die der Receiver verwenden kann. Dies ist die Teilmenge der Codecs, die der Receiver als bevorzugt angegeben hat und zu deren Senden der Remote-Endpunkt bereit ist. Dieser Parameter kann nach seiner anfänglichen Festlegung nicht 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. Bei Audio-Codecs gibt beispielsweise ein Wert von 1 monauralen Klang an, während 2 Stereo angibt.

clockRate

Eine positive ganze Zahl, die die Clock-Rate des Codecs in Hertz (Hz) angibt. Die Clock-Rate ist die Rate, mit der der RTP-Zeitstempel des Codecs fortschreitet. Die meisten Codecs haben spezifische Werte oder Wertebereiche, die sie zulassen. Die IANA verwaltet eine Liste von Codecs und ihren Parametern, einschließlich ihrer Clock-Rates.

mimeType

Ein String, der den MIME-Medientyp und -Untertyp des Codecs angibt, als String im Format "type/subtype". Die von RTP verwendeten MIME-Type-Strings unterscheiden sich von den an anderer Stelle verwendeten. Die IANA verwaltet ein Register gültiger MIME-Typen. Siehe auch Von WebRTC verwendete Codecs für Details zu möglichen Codecs, auf die hier verwiesen werden könnte.

payloadType

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

sdpFmtpLine Optional

Ein String, der das Feld für formatspezifische Parameter aus der Zeile a=fmtp in der SDP angibt, die der Codec-SDP des Remote-Peers entspricht, sofern das Feld vorhanden ist. Wenn kein Parameterfeld vorhanden ist, wird diese Eigenschaft weggelassen. Weitere Informationen finden Sie in Abschnitt 5.8 der IETF-Spezifikation für JSEP.

headerExtensions

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

rtcp

Ein Objekt, das die Konfigurationsparameter bereitstellt, die für RTCP auf dem Sender oder Receiver verwendet werden. Dieser Parameter kann nach seiner anfänglichen Festlegung nicht geändert werden.

Das Objekt kann die folgenden Eigenschaften haben:

cname

Ein String, der den von RTCP verwendeten kanonischen Namen (CNAME) angibt, beispielsweise in SDES-Nachrichten.

reducedSize

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

Beispiele

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

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

  return parameters.rtcp.cname;
}

Spezifikationen

Browser-Kompatibilität