RTCIceCandidate.relatedAddress

在此页

句法
用法注意事项
范例
规范
浏览器兼容性
另请参阅
相关话题

RTCIceCandidate interface's read-only relatedAddress property is a string indicating the related address of a relay or reflexive candidate. If the candidate is a host candidate (that is, its ip is in fact the real IP address of the remote peer), relatedAddress is null .

relatedAddress field's value is set when the RTCIceCandidate() constructor is used. You can't specify the value of relatedAddress in the options object, but the address is automatically extracted from the candidate a-line, if it's formatted properly, being taken from its rel-address 字段。

The related address and port ( relatedPort ) are not used at all by ICE itself; they are provided for analysis and diagnostic purposes only, and their inclusion may be blocked by security systems, so do not rely on them having non- null 值。

句法

var relAddress = RTCIceCandidate.relatedAddress;

值

A DOMString which contains the candidate's related address. For both peer and server reflexive candidates, the related address (and related port) are the base for that server or peer reflexive candidate. For relay candidates, the related address and port are set to the mapped address selected by the TURN server.

For host candidates, relatedAddress is null , meaning the field is not included in the candidate's a-line.

用法注意事项

The related address is included in ICE candidates despite not being used by ICE itself. relatedAddress can be used for diagnostic purposes; by observing the relationships between the various types of candidates and their addresses and related addresses. relatedAddress can also be used by Quality-of-Service (QoS) mechanisms.

Here's an SDP attribute line (a-line) describing an ICE candidate discovered by the STUN server:

a=candidate:4234997325 1 udp 2043278322 192.168.0.56 6502 typ srflx raddr 192.168.2.77 rport 32768 generation 0

The remote address, relatedAddress , is the dotted quad (for IPv4) or colon-delineated 64-bit address (for IPv6) immediately following the text "raddr" ，或 "192.168.2.77" .

范例

In this example, the candidate's type is checked, and then debugging output is presented, based on the candidate type, including the candidate's ip and relatedAddress .

switch(candidate.type) {
  case "host":
    console.log("Host candidate's IP address is " + candidate.ip);
    break;
  case "srflx":
    console.log("Server reflexive candidate's base address is " +
        candidate.relatedAddress + "; reachable at " + candidate.ip);
    break;
  case "prflx":
    console.log("Peer reflexive candidate's base address is " +
        candidate.relatedAddress + "; reachable at " + candidate.ip);
    break;
  case "relay":
    console.log("Relay candidate's address assigned by the TURN server is " +
        candidate.relatedAddress + "; reachable at " + candidate.ip);
    break;
}

规范

规范	状态	注释
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCIceCandidate.relatedAddress' in that specification.	候选推荐	初始定义。

浏览器兼容性

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request. 更新 GitHub 上的兼容性数据

	桌面						移动
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`relatedAddress`	Chrome 74	Edge ≤18	Firefox 不支持 No	IE 不支持 No	Opera 不支持 No	Safari ?	WebView Android 74	Chrome Android 74	Firefox Android 不支持 No	Opera Android 不支持 No	Safari iOS ?	Samsung Internet Android 11.0

图例

完整支持
不支持
兼容性未知 ?

另请参阅

元数据

最后修改： 2020 年 1 月 22 日

WebRTC API
RTCIceCandidate
构造函数
1. RTCIceCandidate()
特性
1. address
2. candidate
3. component
4. foundation
5. port
6. priority
7. 协议
8. relatedAddress
9. relatedPort
10. sdpMid
11. sdpMLineIndex
12. usernameFragment
方法
1. toJSON()
Related pages for WebRTC

在此页

句法

值

用法注意事项

范例

规范

浏览器兼容性

图例

另请参阅

相关话题