Class RoomWatcher

Monitors room occupancy via the signaling server. Use to show room status (e.g. "1 person waiting") before joining a call.

Index

Constructors

Accessors

activeTransport currentStatuses isConnected

Methods

stop subscribe watchRooms

Constructors

constructor

new RoomWatcher(
config: SerenadaConfig,
dependencies?: RoomWatcherDependencies,
): RoomWatcher
Parameters
- config: SerenadaConfig
- dependencies: RoomWatcherDependencies = {}
Returns RoomWatcher
- Defined in packages/core/src/RoomWatcher.ts:26

Accessors

activeTransport

get activeTransport(): TransportKind | null
Returns TransportKind | null
- Defined in packages/core/src/RoomWatcher.ts:48

currentStatuses

get currentStatuses(): RoomStatuses
Returns RoomStatuses
- Defined in packages/core/src/RoomWatcher.ts:52

isConnected

get isConnected(): boolean
Returns boolean
- Defined in packages/core/src/RoomWatcher.ts:44

Methods

stop

stop(): void
Stop watching all rooms and release resources.

Returns void
- Defined in packages/core/src/RoomWatcher.ts:91

subscribe(listener: RoomWatcherListener): () => void
Subscribe to room status updates. Returns an unsubscribe function.
Parameters
- listener: RoomWatcherListener
Returns () => void
- Defined in packages/core/src/RoomWatcher.ts:57

watchRooms

watchRooms(roomIds: string[]): void
Start watching the given room IDs for occupancy changes. Replaces any previous watch list.
Parameters
- roomIds: string[]
Returns void
- Defined in packages/core/src/RoomWatcher.ts:66