Class Room

constructor

• new Room(): Room

  Returns Room

connectionState

Optionale2eeManager

OptionallocalParticipant

remoteParticipants

creationTime

• get creationTime(): Date

  Returns Date

departureTimeout

• get departureTimeout(): number

  The time in seconds after which a room will be closed after the last participant has disconnected.

  Returns number

emptyTimeout

• get emptyTimeout(): number

  The time in seconds after which an empty room will be automatically closed.

  Returns number

isConnected

• get isConnected(): boolean

  Returns boolean

isRecording

• get isRecording(): boolean

  Returns boolean

metadata

• get metadata(): undefined | string

  Returns undefined | string

name

• get name(): undefined | string

  Returns undefined | string

numParticipants

• get numParticipants(): number

  Returns number

numPublishers

• get numPublishers(): number

  Returns number

connect

• connect(url: string, token: string, opts?: RoomOptions): Promise<void>

  Connects to a LiveKit room using the provided URL and access token.

  Parameters

  • url: string

    The WebSocket URL of the LiveKit server
  • token: string

    A valid LiveKit access token for authentication
  • Optionalopts: RoomOptions

    Optional room configuration options

  Returns Promise<void>

  Throws

  ConnectError if connection fails

disconnect

• disconnect(): Promise<void>

  Disconnects from the room and cleans up all resources. This will stop all tracks and close the connection.

  Returns Promise<void>

getSid

• getSid(): Promise<string>

  Gets the room's server ID. This ID is assigned by the LiveKit server and is unique for each room session. SID is assigned asynchronously after connection.

  Returns Promise<string>

  Promise that resolves to the room's server ID, or empty string if not connected

registerByteStreamHandler

• registerByteStreamHandler(topic: string, callback: ByteStreamHandler): void

  Registers a handler for incoming byte data streams on a specific topic. Byte streams are used for receiving binary data like files from other participants.

  Parameters

  • topic: string

    The topic to listen for byte streams on
  • callback: ByteStreamHandler

    Function to handle incoming byte stream data

  Returns void

  Throws

  Error if a handler for this topic is already registered

registerTextStreamHandler

• registerTextStreamHandler(topic: string, callback: TextStreamHandler): void

  Registers a handler for incoming text data streams on a specific topic. Text streams are used for receiving structured text data from other participants.

  Parameters

  • topic: string

    The topic to listen for text streams on
  • callback: TextStreamHandler

    Function to handle incoming text stream data

  Returns void

  Throws

  Error if a handler for this topic is already registered

unregisterByteStreamHandler

• unregisterByteStreamHandler(topic: string): void

  Parameters

  • topic: string

  Returns void

unregisterTextStreamHandler

• unregisterTextStreamHandler(topic: string): void

  Parameters

  • topic: string

  Returns void