Class: SoundboardDataReceiver<Prepared>

Defined in: soundboardData.ts:51

Owns cancellation across downloads, replacement clips, permission changes and leaving a call.

Type Parameters

Type Parameter
Prepared

Constructors

Constructor

new SoundboardDataReceiver<Prepared>(options): SoundboardDataReceiver<Prepared>;

Defined in: soundboardData.ts:59

Parameters

Parameter	Type	Description
options	{ allowed: (identity) => boolean; entranceSound?: (identity) => number | null; muted?: (identity) => boolean; play: (identity, sound, prepared, entrance) => () => void; prepare: (sound) => Promise<Prepared>; serverGuid?: string; serverId: number; sounds: () => Promise<ISoundboardSound[]>; }	-
options.allowed	(identity) => boolean	-
options.entranceSound?	(identity) => number | null	Read from the participant's server-issued ENTRANCE_SOUND_ATTRIBUTE.
options.muted?	(identity) => boolean	-
options.play	(identity, sound, prepared, entrance) => () => void	-
options.prepare	(sound) => Promise<Prepared>	-
options.serverGuid?	string	-
options.serverId	number	-
options.sounds	() => Promise<ISoundboardSound[]>	-

Returns

SoundboardDataReceiver<Prepared>

Methods

dispose()

dispose(): void;

Defined in: soundboardData.ts:138

Returns

void

---

forget()

forget(identity): void;

Defined in: soundboardData.ts:125

A new connection with the same identity starts its own sequence at one.

Parameters

Parameter	Type
identity	string

Returns

void

---

receive()

receive(payload, identity): Promise<void>;

Defined in: soundboardData.ts:73

Parameters

Parameter	Type
payload	Uint8Array
identity	string

Returns

Promise<void>

---

refresh()

refresh(): void;

Defined in: soundboardData.ts:131

Returns

void

---

stop()

stop(identity): void;

Defined in: soundboardData.ts:117

Parameters

Parameter	Type
identity	string

Returns

void