RTCRtpReceiver:getCapabilities() 静态方法
静态方法 RTCRtpReceiver.getCapabilities()
返回一个对象,该对象描述了当前设备上 RTCRtpReceiver
对象支持的编解码器和头部扩展功能。
类似地,可以通过调用静态函数 RTCRtpSender.getCapabilities()
获取 RTCRtpSender
对象的功能。
语法
RTCRtpReceiver.getCapabilities(kind)
参数
kind
-
一个字符串,指示请求浏览器接收器功能的媒体类型。支持的媒体类型为:
audio
和video
。
返回值
一个新对象,指示浏览器通过 RTCPeerConnection
接收指定媒体类型时的功能。如果浏览器不支持给定的媒体 kind
,则返回值为 null
。
返回的对象具有以下属性
codecs
-
一个对象数组,每个对象描述
RTCRtpReceiver
支持的单个 媒体编解码器 的基本功能。注意:该数组包含表示传输底层组件的特殊条目 - 如果你只对用于媒体本身的实际编解码器感兴趣,可以忽略这些条目。这些将在下面的 编解码器数组 部分中进行描述。
每个编解码器对象都具有以下属性
channels
可选-
一个正整数,指示编解码器支持的最大通道数;例如,仅支持单声道声音的编解码器值为 1;立体声编解码器值为 2 等。
clockRate
-
一个正整数,以赫兹 (Hz) 为单位指定编解码器的时钟速率。IANA 维护着 编解码器及其参数列表,包括它们的时钟速率。
mimeType
-
一个字符串,指示编解码器的 MIME 媒体类型和子类型。RTP 使用的 MIME 类型字符串与其他地方使用的不同。有关这些类型的完整 IANA 注册表,请参阅 RFC 3555,第 4 节。另请参阅 WebRTC 使用的编解码器,了解此处可能引用的潜在编解码器的详细信息。
sdpFmtpLine
可选-
一个字符串,给出 SDP 中与编解码器对应的
a=fmtp
行中的格式特定参数字段,如果存在这样的行。如果没有参数字段,则省略此属性。
headerExtensions
-
一个对象数组,每个对象提供当前媒体
kind
支持的 头部扩展 的 URI。每个对象都具有以下属性
描述
作为静态函数,它始终以以下形式调用
capabilities = RTCRtpReceiver.getCapabilities("audio");
返回的功能集是最乐观的可能列表。在您实际尝试使用它们时,某些选项组合可能无法正常工作。
调用 RTCRtpReceiver.getCapabilities()
不会以任何方式为浏览器处理媒体做好准备。没有任何内容被加载、获取或以其他方式准备。这是一种在开始尝试访问媒体之前确定可能可用内容的方法。
由于可用功能集往往在一段时间内保持稳定(人们不会经常安装和卸载编解码器等),因此媒体功能可以全部或部分地提供一种跨源方法来识别用户。出于这个原因,在隐私敏感的上下文中,浏览器可能会选择模糊功能;例如,可以通过省略很少使用的编解码器配置来实现这一点。
编解码器数组
codecs
数组是一个对象数组,描述单个编解码器及其基本功能。浏览器只会分别报告不同的功能组合。如果两组功能可以描述为一组,则将它们合并。这意味着,例如,如果有两个 H.264 编解码器的条目(由 mimeType
为“video/H264”标识),则功能对象中的其他值指示它们在某些方面有所不同。
始终存在三个特殊的条目,它们表示传输的底层组件。这些组件是
- RED(冗余音频数据)
-
RED 条目的媒体类型可能有所不同,因为存在几个版本,但它将以
red
结尾,例如video/red
或video/fwdred
。基本 RED 标准可以在 RFC 2198 中找到。如果支持不同的形式,可能有多个 RED 条目;在这种情况下,每个条目都将具有唯一的媒体类型。 - FEC(前向纠错)
-
FEC 组件处理纠错数据;它的媒体类型也可能有所不同,因为存在标准的高级版本可用,但它将始终以
fec
结尾。一个可能的值是video/ulpfec
(一个通用的错误连接模型)。如果支持多种形式,也可能有多个 FEC 条目。 - RTX(重传)
-
此组件负责数据的重传;它的媒体类型应为
video/rtx
。RTX 只有一个条目,并且它没有sdpFmtpLine
属性。
如果只对与媒体相关的编解码器感兴趣,则应忽略这些条目。
示例
功能支持
可以使用 Object.hasOwn()
检查是否支持 RTCRtpReceiver.getCapabilities()
log.textContent = `RTCRtpReceiver.getCapabilities() supported: ${Object.hasOwn(
RTCRtpReceiver,
"getCapabilities",
)}`;
检查特定编解码器的支持
以下函数返回一个布尔值,指示设备是否支持在 WebRTC 连接上接收 H.264 视频。
注意:由于 RTCRtpReceiver.getCapabilities()
实际上只指示>可能的支持,因此即使从该函数获得肯定的响应,尝试接收 H.264 视频也可能仍然失败。
function canReceiveH264() {
let capabilities = RTCRtpReceiver.getCapabilities("video");
capabilities.codecs.forEach((codec) => {
if (codec.mimeType === "video/H264") {
return true;
}
});
return false;
}
获取所有功能
此代码示例演示了如何获取所有支持的编解码器和头部。HTML 为两种功能定义了一个选择列表和一个日志区域。
<select id="kind">
<option value="audio">audio</option>
<option value="video">video</option>
</select>
<textarea rows="40" cols="100" id="log"></textarea>
JavaScript 定义了一个函数来记录特定“kind”的功能。最初使用值 audio
调用此函数。当选择列表 kind
更改时,侦听器会更新该值。
const log = document.querySelector("#log");
const kindSelector = document.querySelector("#kind");
logMediaCapabilities("audio");
kindSelector.addEventListener("click", () => {
log.textContent = "";
logMediaCapabilities(kindSelector.value);
});
function logMediaCapabilities(kind) {
if (!Object.hasOwn(RTCRtpReceiver, "getCapabilities")) {
log.textContent = "RTCRtpReceiver.getCapabilities() not supported";
return;
}
const capabilities = RTCRtpReceiver.getCapabilities(`${kind}`);
log.textContent += "Headers\n";
capabilities.headerExtensions.forEach((header) => {
log.textContent += ` uri: ${header.uri}\n`;
});
log.textContent += "\nCodecs\n";
capabilities.codecs.forEach((codec) => {
log.textContent += ` mime type: ${codec.mimeType}\n`;
log.textContent += ` channels: ${codec.channels}\n`; //max channels - e.g. 2 is stereo
log.textContent += ` clockRate: ${codec.clockRate}\n`; // clock rate in Hz
log.textContent += ` sdpFmtpLine: ${codec.sdpFmtpLine}\n`; // mime media type and subtype
});
}
结果
规范
规范 |
---|
WebRTC:浏览器中的实时通信 # dom-rtcrtpreceiver-getcapabilities |
浏览器兼容性
BCD 表仅在启用 JavaScript 的浏览器中加载。