Room

Defined in: client-sdk-js/src/Room.ts:184

A typed wrapper over Node’s EventEmitter.

Extends EventEmitter with declare overrides so that emit, on, off, etc. are type-safe without introducing circular-reference issues that arise when using typed-emitter directly in extends clauses whose event maps reference the class itself.

Runtime behaviour is 100% EventEmitter; this class adds zero runtime code.

Extends

TypedEmitter<RoomEvents>

Constructors

Constructor

new Room(options?): Room;

Defined in: client-sdk-js/src/Room.ts:233

Parameters

options?

RoomOptions

Returns

Room

Overrides

TypedEmitter.constructor

Properties

addListener

addListener: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:37

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof RoomEvents ? RoomEvents[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.addListener

emit

emit: <E>(event, ...args) => boolean;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:17

Type Parameters

E

E extends RoomEvent

Parameters

event

E

args

…Parameters<RoomEvents[E]>

Returns

boolean

Inherited from

TypedEmitter.emit

listenerCount

listenerCount: (event) => number;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:57

Parameters

event

string | number

Returns

number

Inherited from

TypedEmitter.listenerCount

listeners

listeners: <E>(event) => E extends keyof RoomEvents ? RoomEvents[E][] : ((...args) => void)[];

Defined in: client-sdk-js/src/utils/typedEmitter.ts:49

Type Parameters

E

E extends string | number

Parameters

event

E

Returns

E extends keyof RoomEvents ? RoomEvents[E][] : ((…args) => void)[]

Inherited from

TypedEmitter.listeners

off

off: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:32

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof RoomEvents ? RoomEvents[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.off

on

on: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:22

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof RoomEvents ? RoomEvents[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.on

once

once: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:27

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof RoomEvents ? RoomEvents[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.once

rawListeners

rawListeners: <E>(event) => E extends keyof RoomEvents ? RoomEvents[E][] : ((...args) => void)[];

Defined in: client-sdk-js/src/utils/typedEmitter.ts:53

Type Parameters

E

E extends string | number

Parameters

event

E

Returns

E extends keyof RoomEvents ? RoomEvents[E][] : ((…args) => void)[]

Inherited from

TypedEmitter.rawListeners

removeAllListeners

removeAllListeners: (event?) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:47

Parameters

event?

string | number

Returns

this

Inherited from

TypedEmitter.removeAllListeners

removeListener

removeListener: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:42

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof RoomEvents ? RoomEvents[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.removeListener

defaultMaxListeners

static defaultMaxListeners: number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:5

Inherited from

TypedEmitter.defaultMaxListeners

Accessors

activeSpeakers

Get Signature

get activeSpeakers(): Participant<TrackPublication>[];

Defined in: client-sdk-js/src/Room.ts:363

List of participants currently speaking, ordered by audio level.

Returns

Participant<TrackPublication>[]

canPlaybackAudio

Get Signature

get canPlaybackAudio(): boolean;

Defined in: client-sdk-js/src/Room.ts:328

Whether audio can be played back automatically (i.e. no autoplay restriction).

Returns

boolean

canPlaybackVideo

Get Signature

get canPlaybackVideo(): boolean;

Defined in: client-sdk-js/src/Room.ts:333

Whether video can be played back automatically.

Returns

boolean

groups

Get Signature

get groups(): ReadonlyMap<string, GroupInfo>;

Defined in: client-sdk-js/src/Room.ts:285

All active groups (breakout rooms) in this room.

Returns

ReadonlyMap<string, GroupInfo>

isRecording

Get Signature

get isRecording(): boolean;

Defined in: client-sdk-js/src/Room.ts:338

Whether the room is currently being recorded.

Returns

boolean

localParticipant

Get Signature

get localParticipant(): LocalParticipant;

Defined in: client-sdk-js/src/Room.ts:269

Returns

LocalParticipant

metadata

Get Signature

get metadata(): string | undefined;

Defined in: client-sdk-js/src/Room.ts:343

Room-level metadata (set by the server).

Returns

string | undefined

name

Get Signature

get name(): string;

Defined in: client-sdk-js/src/Room.ts:257

Returns

string

numParticipants

Get Signature

get numParticipants(): number;

Defined in: client-sdk-js/src/Room.ts:348

Number of participants currently in the room.

Returns

number

numPublishers

Get Signature

get numPublishers(): number;

Defined in: client-sdk-js/src/Room.ts:353

Number of participants that are actively publishing tracks.

Returns

number

remoteParticipants

Get Signature

get remoteParticipants(): Map<string, RemoteParticipant>;

Defined in: client-sdk-js/src/Room.ts:273

Returns

Map<string, RemoteParticipant>

rtt

Get Signature

get rtt(): number;

Defined in: client-sdk-js/src/Room.ts:925

Returns

number

serverInfo

Get Signature

get serverInfo(): ServerInfo | undefined;

Defined in: client-sdk-js/src/Room.ts:265

Returns

ServerInfo | undefined

sharedState

Get Signature

get sharedState(): ReadonlyMap<string, string>;

Defined in: client-sdk-js/src/Room.ts:290

Room-level shared state KV (for collaboration features like whiteboard, shared documents).

Returns

ReadonlyMap<string, string>

sid

Get Signature

get sid(): string;

Defined in: client-sdk-js/src/Room.ts:261

Returns

string

state

Get Signature

get state(): ConnectionState;

Defined in: client-sdk-js/src/Room.ts:253

Returns

ConnectionState

Methods

connect()

connect(
   url,
   token?,
   options?
): Promise<void>;

Defined in: client-sdk-js/src/Room.ts:501

Parameters

url

string

token?

string

options?

Partial<InternalRoomConnectOptions>

Returns

Promise<void>

createGroup()

createGroup(name, permissions?): Promise<GroupInfo>;

Defined in: client-sdk-js/src/Room.ts:395

Create a new group (breakout room) within this room. Requires canManageGroups permission.

Parameters

name

string

permissions?

ParticipantPermission

Returns

Promise<GroupInfo>

deleteGroup()

deleteGroup(groupId): Promise<void>;

Defined in: client-sdk-js/src/Room.ts:411

Delete a group. All participants in the group are returned to the main room and their permissions revert to room-level defaults. Requires canManageGroups permission.

Parameters

groupId

string

Returns

Promise<void>

disconnect()

disconnect(stopTracks?): Promise<void>;

Defined in: client-sdk-js/src/Room.ts:653

Disconnect from the room.

Parameters

stopTracks?

boolean = true

Whether to stop local tracks after disconnecting. Defaults to true.

Returns

Promise<void>

eventNames()

eventNames(): (string | number)[];

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:7

Returns

(string | number)[]

Inherited from

TypedEmitter.eventNames

getActiveDevice()

getActiveDevice(kind): string | undefined;

Defined in: client-sdk-js/src/Room.ts:1012

Returns the device ID currently active for a given kind, if known.

Parameters

kind

MediaDeviceKind

Returns

string | undefined

getGroupParticipants()

getGroupParticipants(groupId): Participant<TrackPublication>[];

Defined in: client-sdk-js/src/Room.ts:298

Get all participants currently in the specified group. Includes the local participant if they are in the group.

Parameters

groupId

string

Returns

Participant<TrackPublication>[]

getMaxListeners()

getMaxListeners(): number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:9

Returns

number

Inherited from

TypedEmitter.getMaxListeners

getParticipantByIdentity()

getParticipantByIdentity(identity): RemoteParticipant | undefined;

Defined in: client-sdk-js/src/Room.ts:376

Look up a remote participant by their identity.

Parameters

identity

string

Returns

RemoteParticipant | undefined

getParticipants()

getParticipants(): Participant<TrackPublication>[];

Defined in: client-sdk-js/src/Room.ts:314

Get all participants.

Returns

Participant<TrackPublication>[]

getTransportStats()

getTransportStats(): Promise<{
  recv?: RTCStatsReport;
  send?: RTCStatsReport;
}>;

Defined in: client-sdk-js/src/Room.ts:280

Returns WebRTC stats for the underlying send and receive transports.

Returns

Promise<{ recv?: RTCStatsReport; send?: RTCStatsReport; }>

listGroups()

listGroups(): Promise<GroupInfo[]>;

Defined in: client-sdk-js/src/Room.ts:418

List all active groups in this room.

Returns

Promise<GroupInfo[]>

pinParticipant()

pinParticipant(participantSid): Promise<void>;

Defined in: client-sdk-js/src/Room.ts:430

Pin a remote participant so their media tracks are always received, regardless of active speaker rotation. Pinned participants occupy lastN slots with highest priority.

Parameters

participantSid

string

Returns

Promise<void>

prependListener()

prependListener(type, listener): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:14

Parameters

type

string | number

listener

Listener

Returns

this

Inherited from

TypedEmitter.prependListener

prependOnceListener()

prependOnceListener(type, listener): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:15

Parameters

type

string | number

listener

Listener

Returns

this

Inherited from

TypedEmitter.prependOnceListener

registerByteStreamHandler()

registerByteStreamHandler(topic, handler): void;

Defined in: client-sdk-js/src/Room.ts:1062

Parameters

topic

string

handler

ByteStreamHandler

Returns

void

registerRpcMethod()

registerRpcMethod(method, handler): void;

Defined in: client-sdk-js/src/Room.ts:1026

Register an RPC method handler. When a remote participant calls performRpc with the given method name, the handler is invoked.

Parameters

method

string

Method name to handle.

handler

(data) => Promise<string>

Async function that receives invocation data and returns a string payload.

Returns

void

registerTextStreamHandler()

registerTextStreamHandler(topic, handler): void;

Defined in: client-sdk-js/src/Room.ts:1048

Parameters

topic

string

handler

TextStreamHandler

Returns

void

setMaxListeners()

setMaxListeners(n): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:8

Parameters

n

number

Returns

this

Inherited from

TypedEmitter.setMaxListeners

startAudio()

startAudio(): Promise<void>;

Defined in: client-sdk-js/src/Room.ts:958

Attempt to start audio playback on all remote audio tracks. Should be called from a user interaction handler when canPlaybackAudio is false.

Returns

Promise<void>

startVideo()

startVideo(): Promise<void>;

Defined in: client-sdk-js/src/Room.ts:986

Attempt to start video playback on all remote video tracks. Should be called from a user interaction handler when canPlaybackVideo is false.

Returns

Promise<void>

switchActiveDevice()

switchActiveDevice(
   kind,
   deviceId,
   exact?
): Promise<void>;

Defined in: client-sdk-js/src/Room.ts:463

Switch the active device for a given kind across all published tracks.

Parameters

kind

MediaDeviceKind

videoinput, audioinput, or audiooutput.

deviceId

string

The device ID to switch to.

exact?

boolean = true

If true, sets the deviceId constraint to exact. Defaults to true.

Returns

Promise<void>

unpinParticipant()

unpinParticipant(participantSid): Promise<void>;

Defined in: client-sdk-js/src/Room.ts:438

Unpin a previously pinned participant. Their media subscription will then be subject to active speaker rotation under lastN rules.

Parameters

participantSid

string

Returns

Promise<void>

unregisterByteStreamHandler()

unregisterByteStreamHandler(topic): void;

Defined in: client-sdk-js/src/Room.ts:1069

Unregister a previously registered byte stream handler.

Parameters

topic

string

Returns

void

unregisterRpcMethod()

unregisterRpcMethod(method): void;

Defined in: client-sdk-js/src/Room.ts:1038

Remove a previously registered RPC method handler.

Parameters

method

string

Returns

void

unregisterTextStreamHandler()

unregisterTextStreamHandler(topic): void;

Defined in: client-sdk-js/src/Room.ts:1055

Unregister a previously registered text stream handler.

Parameters

topic

string

Returns

void

getLocalDevices()

static getLocalDevices(kind?): Promise<MediaDeviceInfo[]>;

Defined in: client-sdk-js/src/Room.ts:448

Enumerate available media input/output devices.

Parameters

kind?

MediaDeviceKind

Filter by device kind. If omitted, all devices are returned.

Returns

Promise<MediaDeviceInfo[]>

listenerCount()

static listenerCount(emitter, type): number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:4

Parameters

emitter

EventEmitter

type

string | number

Returns

number

Inherited from

TypedEmitter.listenerCount