Interface IceGatheringOptionsExperimental

The fal.realtime.open() extension API is experimental and may change in a minor release.

interface IceGatheringOptions {
    iceServers?: RTCIceServer[];
    iceTransportPolicy?: RTCIceTransportPolicy;
    quietPeriodMs?: number;
    signal?: AbortSignal;
    timeoutMs?: number;
}

Properties

iceServers? iceTransportPolicy? quietPeriodMs? signal? timeoutMs?

Properties

Optional ExperimentaliceServers

iceServers?: RTCIceServer[]

The servers handed to the peer connection. Used to decide what "sufficient" means: when TURN is configured, a relay candidate is required before the set counts as usable, because that is the entire reason TURN was configured.

Optional ExperimentaliceTransportPolicy

iceTransportPolicy?: RTCIceTransportPolicy

The candidate policy used by the peer connection. Relay-only gathering is sufficient as soon as a relay candidate settles; it intentionally cannot produce a server-reflexive candidate.

Optional ExperimentalquietPeriodMs

quietPeriodMs?: number

How long the candidate set must stop changing before it is considered settled.

Optional Experimentalsignal

signal?: AbortSignal

Cancel gathering immediately and remove its listeners and timers.

Optional ExperimentaltimeoutMs

timeoutMs?: number

Hard bound. Reached only when gathering neither completes nor becomes sufficient.

Settings

Member Visibility

On This Page

Properties