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

浏览器兼容性