Skip to main content

Class: RTCIceGatherer

Constructors#

constructor#

• new RTCIceGatherer(options?)

Parameters#

NameType
optionsPartial<IceOptions>

Defined in#

packages/webrtc/src/transport/ice.ts:103

Properties#

connection#

• Readonly connection: Connection

Defined in#

packages/webrtc/src/transport/ice.ts:103


gatheringState#

• gatheringState: "new" | "gathering" | "complete" = "new"

Defined in#

packages/webrtc/src/transport/ice.ts:100


onGatheringStateChange#

• Readonly onGatheringStateChange: default<["new" | "gathering" | "complete"]>

Defined in#

packages/webrtc/src/transport/ice.ts:102


onIceCandidate#

• onIceCandidate: (candidate: IceCandidate) => void

Type declaration#

▸ (candidate): void

Parameters#
NameType
candidateIceCandidate
Returns#

void

Defined in#

packages/webrtc/src/transport/ice.ts:99

Accessors#

localCandidates#

• get localCandidates(): IceCandidate[]

Returns#

IceCandidate[]

Defined in#

packages/webrtc/src/transport/ice.ts:117


localParameters#

• get localParameters(): RTCIceParameters

Returns#

RTCIceParameters

Defined in#

packages/webrtc/src/transport/ice.ts:121

Methods#

gather#

▸ gather(): Promise<void>

Returns#

Promise<void>

Defined in#

packages/webrtc/src/transport/ice.ts:107


setState#

▸ Private setState(state): void

Parameters#

NameType
state"new" | "gathering" | "complete"

Returns#

void

Defined in#

packages/webrtc/src/transport/ice.ts:130