Interface RtcRoom

The LiveKit Room surface this wrapper drives. VERIFY against @livekit/rtc-node.

interface RtcRoom {
    localParticipant: RtcLocalParticipant;
    name?: string;
    remoteParticipants: Map<string, RtcParticipant> | RtcParticipant[];
    connect(url: string, token: string, options?: unknownRecord): Promise<void>;
    disconnect(): Promise<void>;
    on(event: string, listener: (...args: never[]) => void): void;
}

Index

Properties

localParticipant name? remoteParticipants

Methods

connect disconnect on

Properties

localParticipant

localParticipant: RtcLocalParticipant

The bot's local participant.

`Optional`name

name?: string

The room name once connected.

remoteParticipants

remoteParticipants: Map<string, RtcParticipant> | RtcParticipant[]

Remote participants keyed by identity (or an iterable of them).

Methods

connect

connect(url: string, token: string, options?: unknownRecord): Promise<void>
Connects to the room. VERIFY: (url, token, options?).
Parameters
- url: string
- token: string
- Optionaloptions: unknownRecord
Returns Promise<void>
- Defined in livekit-rtc-node-room.ts:125

disconnect

disconnect(): Promise<void>
Disconnects from the room.

Returns Promise<void>
- Defined in livekit-rtc-node-room.ts:127

on

on(event: string, listener: (...args: never[]) => void): void
Subscribes to a room event. VERIFY: event names from RoomEvent.
Parameters
- event: string
- listener: (...args: never[]) => void
Returns void
- Defined in livekit-rtc-node-room.ts:129