RTCIceCandidate: priority 属性

Baseline 2024
新推出

自 2024 年 5 月以来,此功能已在最新设备和浏览器版本中可用。此功能可能不适用于较旧的设备或浏览器。

RTCIceCandidate 接口的只读 **priority** 属性根据远程对端指定了候选者的优先级;该值越高,远程对端认为候选者越好。

priority 字段的值是从传递给 RTCIceCandidate() 构造函数的 candidateInfo 选项对象设置的。你不能直接在选项对象中指定 priority 的值,但如果 candidate a-line 格式正确,它的值会自动从该对象的 candidate a-line 中提取。

一个长的无符号整数值,指示远程对端认为候选者的优先级。该值越大,远程对端认为该候选者越优先。

如果 priority 未在 candidate 中指定,或者 candidate 字符串无法正确解析,则 priority 被初始化为 null

注意:如果 prioritynull,将候选者传递给 addIceCandidate() 将会失败,并抛出一个 OperationError 异常。这仅适用于实现 priority 属性的候选者。

用法说明

考虑这个描述 ICE 候选的 SDP 属性行(a-line):

a=candidate:4234997325 1 udp 2043278322 192.0.2.172 44323 typ host

优先级是协议之后的数字,因此它是候选字符串中的第四个字段。在此示例中,优先级为 2043278322。

示例

此候选者会检查候选者的 priority,如果它大于先前看到的候选者的优先级,则会记住该候选者以备后用。

js
let bestCandidate = {
  candidate: "",
  sdpMid: null,
  sdpMLineIndex: null,
  priority: 0,
};

function handleCandidate(candidateString) {
  const candidate = new RTCIceCandidate(candidateString);

  if (candidate.priority > bestCandidate.priority) {
    bestCandidate = candidate;
  }
}

规范

规范
WebRTC:浏览器中的实时通信
# dom-rtcicecandidate-priority

浏览器兼容性