Skip to content

five-on-it / apps/server/src/rtc-peers / RtcPeers

Class: RtcPeers ​

Defined in: apps/server/src/rtc-peers.ts:102

The worker's peers (see the module documentation).

Constructors ​

Constructor ​

new RtcPeers(options): RtcPeers

Defined in: apps/server/src/rtc-peers.ts:113

Parameters ​

options ​

RtcPeersOptions

Returns ​

RtcPeers

Accessors ​

stats ​

Get Signature ​

get stats(): RtcPeersStats

Defined in: apps/server/src/rtc-peers.ts:170

What the peers hold now.

Returns ​

RtcPeersStats

Methods ​

candidate() ​

candidate(id, candidate): void

Defined in: apps/server/src/rtc-peers.ts:143

One of a client's candidates: added, or kept until its answer is made.

Parameters ​

id ​

number

candidate ​
candidate ​

string = ...

sdpMid? ​

string | null = ...

sdpMLineIndex? ​

number | null = ...

usernameFragment? ​

string | null = ...

Returns ​

void


close() ​

close(id): void

Defined in: apps/server/src/rtc-peers.ts:164

Closes a peer the game thread is done with (no word back).

Parameters ​

id ​

number

Returns ​

void


offer() ​

offer(id, sdp): void

Defined in: apps/server/src/rtc-peers.ts:121

A client's offer: a new peer (an older one of the same id closed first), or full.

Parameters ​

id ​

number

sdp ​

string

Returns ​

void


send() ​

send(id, data): void

Defined in: apps/server/src/rtc-peers.ts:154

Sends a frame on a peer's channel: dropped when it is not open or holds too much.

Parameters ​

id ​

number

data ​

Uint8Array

Returns ​

void