relatedAddress property

String? get relatedAddress

The 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 RTCIceCandidate.address is in fact the real IP address of the remote peer), relatedAddress is null.

The relatedAddress field's value is set from the candidateInfo options object passed to the RTCIceCandidate.RTCIceCandidate constructor. You can't specify the value of relatedAddress directly in the options object, but its value is automatically extracted from the object's candidate a-line if it's formatted properly(the rel-address field).

The related address and port (RTCIceCandidate.relatedPort) are not used at all by 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 values.

Implementation

external String? get relatedAddress;