hostname including protocol. i.e. 'https://cluster.livekit.io'
Optional
apiKey: stringAPI Key, can be set in env var LIVEKIT_API_KEY
Optional
secret: stringAPI Secret, can be set in env var LIVEKIT_API_SECRET
Creates a new room. Explicit room creation is not required, since rooms will be automatically created when the first participant joins. This method can be used to customize room settings.
Removes a participant in the room. This will disconnect the participant and will emit a Disconnected event for that participant. Even after being removed, the participant can still re-join the room.
Sends data message to participants in the room
opaque payload to send
delivery reliability
optionally specify a topic and destinationSids (when destinationSids is empty, message is sent to everyone)
Sends data message to participants in the room
opaque payload to send
delivery reliability
Optional
destinationSids: string[]optional. when empty, message is sent to everyone
use sendData(room, data, kind, options) instead
Updates a participant's metadata or permissions
Optional
metadata: stringoptional, metadata to update
Optional
permission: Partial<ParticipantPermission>optional, new permissions to assign to participant
Optional
name: stringoptional, new name for participant
Generated using TypeDoc
Client to access Room APIs