RTCRtpReceiver: getParameters() 方法

Baseline 2024 *
新推出

自 ⁨2024 年 7 月⁩起,此功能可在最新的裝置和瀏覽器版本上使用。此功能可能無法在較舊的裝置或瀏覽器上使用。

* 此特性的某些部分可能存在不同級別的支援。

RTCRtpReceiver 介面的 getParameters() 方法返回一個物件,該物件描述了接收器 track 當前的解碼配置。

語法

js
getParameters()

引數

無。

返回值

一個指示接收器當前配置的物件。

codecs

一個描述接收器已準備好使用的 媒體編解碼器 的物件陣列。這是接收器已指示其偏好的編解碼器子集,並且遠端端點已指示其已準備好傳送的編解碼器。此引數在初始設定後無法更改。

陣列中的每個編解碼器物件可能具有以下屬性:

channels 可選

一個正整數,指示編解碼器支援的通道數。例如,對於音訊編解碼器,值為 1 表示單聲道,值為 2 表示立體聲。

clockRate

一個正整數,指定編解碼器的時鐘頻率(以赫茲 (Hz) 為單位)。時鐘頻率是編解碼器的 RTP 時間戳前進的速率。大多數編解碼器都有特定的允許值或允許值範圍。IANA 維護著一個編解碼器及其引數列表,包括其時鐘頻率。

mimeType

一個字串,指示編解碼器的 MIME 媒體型別和子型別,格式為 "type/subtype"。RTP 使用的 MIME 型別字串與別處使用的不同。IANA 維護著一個有效 MIME 型別登錄檔。另請參閱 WebRTC 使用的編解碼器,瞭解可能在此引用的潛在編解碼器的詳細資訊。

payloadType

用於標識此編解碼器的 RTP 有效載荷型別

sdpFmtpLine 可選

一個字串,表示與遠端端點對應的編解碼器 SDPa=fmtp 行中的格式特定引數欄位(如果該欄位存在)。如果沒有引數欄位,則此屬性將被省略。有關更多資訊,請參閱 JSEP 的 IETF 規範第 5.8 節

headerExtensions

一個零個或多個 RTP 報頭擴充套件的陣列,每個擴充套件都標識了傳送方或接收方支援的擴充套件。報頭擴充套件在 RFC 3550,第 5.3.1 節 中進行了描述。此引數在初始設定後無法更改。

rtcp

一個 RTCRtcpParameters 物件,提供用於傳送方或接收方 RTCP 的配置引數。此引數在初始設定後無法更改。

示例

此示例獲取在 RTCRtpReceiver 上用於 RTCP 的規範名稱 (CNAME)。

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

  return parameters.rtcp.cname;
}

規範

規範
WebRTC:瀏覽器中的即時通訊
# dom-rtcrtpreceiver-getparameters

瀏覽器相容性