Class: Room

Constructors

Constructor

new Room(ctx): Room;

Parameters

Parameter	Type
ctx	RoomContext

Returns

Room

Accessors

activeSpeakers

Get Signature

get activeSpeakers(): string[];

Returns

string[]

---

audioOnlyFallback

Get Signature

get audioOnlyFallback(): boolean;

Whether the media server is sending this client audio only: its connection stayed too slow for video, so the other participants' video is paused rather than frozen. The server tries video again on its own. Every change is an audioOnlyFallback event; the words are the host's. Only an sfu room falls back.

Returns

boolean

---

info

Get Signature

get info(): RoomInfo;

Returns

RoomInfo

---

localParticipant

Get Signature

get localParticipant(): LocalParticipant;

Returns

LocalParticipant

---

metadata

Get Signature

get metadata(): Record<string, unknown>;

Returns

Record<string, unknown>

---

mode

Get Signature

get mode(): RoomMode;

Returns

RoomMode

---

name

Get Signature

get name(): string;

Returns

string

---

participants

Get Signature

get participants(): RemoteParticipant[];

Everyone but me, active speakers first.

Returns

RemoteParticipant[]

---

polite

Get Signature

get polite(): boolean;

Which side of a p2p call yields when both offer at once, assigned by the server. Exposed for diagnostics: a call that deadlocks is one where both ends believe the same thing.

Returns

boolean

---

recording

Get Signature

get recording(): RoomRecording | null;

The room's recording, as the server last said: active, then stopped or failed; null until the room is recorded. Every change is also a recordingChanged event. Only a room in sfu mode is recorded, and only the participants whose clients claim recording — which this SDK does, because it tells its host every change — so a host that shows nothing when this says active is a recording nobody was told of. The words are the host's.

Returns

RoomRecording | null

---

sid

Get Signature

get sid(): string;

Returns

string

Methods

acknowledgeRecording()

acknowledgeRecording(): Promise<void>;

This user agrees to be recorded by the room's active recording. Call it only when the user said so: it stands for a person's consent. In a room whose recording has consentRequired, this user's media is recorded from now on; elsewhere it changes nothing. The acknowledgement is the identity's, for this recording only — a new recording asks again. Refused invalid_state when no recording is active.

Returns

Promise<void>

---

leave()

leave(): Promise<void>;

A clean goodbye: the server does not wait out the departure grace, and in a p2p call an empty seat is the hangup.

Returns

Promise<void>

---

participant()

participant(identity): RemoteParticipant | null;

Parameters

Parameter	Type
identity	string

Returns

RemoteParticipant | null

---

sendData()

sendData(payload, opts?): Promise<void>;

A data message. Bytes on the wire; an object or a string is JSON-encoded for convenience, because the platform never parses it either way.

Parameters

Parameter	Type
payload	| string | Record<string, unknown> | Uint8Array<ArrayBufferLike>
opts	SendDataOptions

Returns

Promise<void>