Share via


gatherPolicy property

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Determines the policy relating to the gathering of ICE candidates.

Syntax

gatherOptions.gatherPolicy = RTCIceGatherPolicy.relay;

Property values

Type: RTCIceGatherPolicy

Use one of the following:

Value Condition
all

The ICE gatherer gathers all types of candidates when this value is specified.

nohost

The ICE gatherer gathers all ICE candidate types except for host candidates.

relay

The ICE gatherer must only gather media relay candidates such as candidates passing through a TURN server. This can be used to reduce leakage of IP addresses in certain use cases.

 

Standards information

See also

RTCIceGatherer

RTCIceGatherOptions