Class RoomServiceClient

Client to access Room APIs

Hierarchy

ServiceBase
- RoomServiceClient

Index

Constructors

Methods

authHeader createRoom deleteRoom forwardParticipant getParticipant listParticipants listRooms moveParticipant mutePublishedTrack removeParticipant sendData updateParticipant updateRoomMetadata updateSubscriptions

Constructors

constructor

new RoomServiceClient(
    host: string,
    apiKey?: string,
    secret?: string,
): RoomServiceClient
Parameters
- host: string
  hostname including protocol. i.e. 'https://.livekit.cloud'
- OptionalapiKey: string
  API Key, can be set in env var LIVEKIT_API_KEY
- Optionalsecret: string
  API Secret, can be set in env var LIVEKIT_API_SECRET
Returns RoomServiceClient
Overrides ServiceBase.constructor
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:119

Methods

authHeader

authHeader(grant: VideoGrant, sip?: SIPGrant): Promise<Record<string, string>>
Parameters
- grant: VideoGrant
- Optionalsip: SIPGrant
Returns Promise<Record<string, string>>
Inherited from ServiceBase.authHeader
- Defined in packages/livekit-server-sdk/src/ServiceBase.ts:28

createRoom

createRoom(options: CreateOptions): Promise<Room>
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.
Parameters
- options: CreateOptions
Returns Promise<Room>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:130

deleteRoom

deleteRoom(room: string): Promise<void>
Parameters
- room: string
Returns Promise<void>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:157

forwardParticipant

forwardParticipant(
    room: string,
    identity: string,
    destinationRoom: string,
): Promise<void>
Forwards a participant's track to another room. This will create a participant to join the destination room that has same information with the source participant except the kind to be Forwarded. All changes to the source participant will be reflected to the forwarded participant. When the source participant disconnects or the RemoveParticipant method is called in the destination room, the forwarding will be stopped.
Parameters
- room: string
- identity: string
- destinationRoom: string
  the room to forward the participant to
Returns Promise<void>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:241

getParticipant

getParticipant(room: string, identity: string): Promise<ParticipantInfo>
Get information on a specific participant, including the tracks that participant has published
Parameters
- room: string
  name of the room
- identity: string
  identity of the participant to return
Returns Promise<ParticipantInfo>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:202

listParticipants

listParticipants(room: string): Promise<ParticipantInfo[]>
List participants in a room
Parameters
- room: string
  name of the room
Returns Promise<ParticipantInfo[]>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:185

listRooms

listRooms(names?: string[]): Promise<Room[]>
List active rooms
Parameters
- Optionalnames: string[]
  when undefined or empty, list all rooms. otherwise returns rooms with matching names
Returns Promise<Room[]>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:146

moveParticipant

moveParticipant(
    room: string,
    identity: string,
    destinationRoom: string,
): Promise<void>
Move a connected participant to a different room. Requires roomAdmin and destinationRoom. The participant will be removed from the current room and added to the destination room. From the other observers' perspective, the participant would've disconnected from the previous room and joined the new one.
Parameters
- room: string
- identity: string
- destinationRoom: string
  the room to move the participant to
Returns Promise<void>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:258

mutePublishedTrack

mutePublishedTrack(
    room: string,
    identity: string,
    trackSid: string,
    muted: boolean,
): Promise<TrackInfo>
Mutes a track that the participant has published.
Parameters
- room: string
- identity: string
- trackSid: string
  sid of the track to be muted
- muted: boolean
  true to mute, false to unmute
Returns Promise<TrackInfo>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:274

removeParticipant

removeParticipant(room: string, identity: string): Promise<void>
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.
Parameters
- room: string
- identity: string
Returns Promise<void>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:220

sendData

sendData(
    room: string,
    data: Uint8Array,
    kind: DataPacket_Kind,
    options: SendDataOptions,
): Promise<void>
Sends data message to participants in the room
Parameters
- room: string
- data: Uint8Array
  opaque payload to send
- kind: DataPacket_Kind
  delivery reliability
- options: SendDataOptions
  optionally specify a topic and destinationSids (when destinationSids is empty, message is sent to everyone)
Returns Promise<void>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:389
sendData(
    room: string,
    data: Uint8Array,
    kind: DataPacket_Kind,
    destinationSids?: string[],
): Promise<void>
Sends data message to participants in the room
Parameters
- room: string
- data: Uint8Array
  opaque payload to send
- kind: DataPacket_Kind
  delivery reliability
- OptionaldestinationSids: string[]
  optional. when empty, message is sent to everyone
Returns Promise<void>
Deprecated
use sendData(room, data, kind, options) instead
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:403

updateParticipant

updateParticipant(
    room: string,
    identity: string,
    options: UpdateParticipantOptions,
): Promise<ParticipantInfo>
Updates a participant's state or permissions
Parameters
- room: string
  target room
- identity: string
  participant identity
- options: UpdateParticipantOptions
  participant fields to update
Returns Promise<ParticipantInfo>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:302
updateParticipant(
    room: string,
    identity: string,
    metadata?: string,
    permission?: Partial<ParticipantPermission>,
    name?: string,
): Promise<ParticipantInfo>
Updates a participant's state or permissions
Parameters
- room: string
  target room
- identity: string
  participant identity
- Optionalmetadata: string
- Optionalpermission: Partial<ParticipantPermission>
- Optionalname: string
Returns Promise<ParticipantInfo>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:313

updateRoomMetadata

updateRoomMetadata(room: string, metadata: string): Promise<Room>
Update metadata of a room
Parameters
- room: string
  name of the room
- metadata: string
  the new metadata for the room
Returns Promise<Room>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:171

updateSubscriptions

updateSubscriptions(
    room: string,
    identity: string,
    trackSids: string[],
    subscribe: boolean,
): Promise<void>
Updates a participant's subscription to tracks
Parameters
- room: string
- identity: string
- trackSids: string[]
- subscribe: boolean
  true to subscribe, false to unsubscribe
Returns Promise<void>
- Defined in packages/livekit-server-sdk/src/RoomServiceClient.ts:361

Class RoomServiceClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RoomServiceClient

Methods

authHeader

Parameters

Returns Promise<Record<string, string>>

createRoom

Parameters

Returns Promise<Room>

deleteRoom

Parameters

Returns Promise<void>

forwardParticipant

Parameters

Returns Promise<void>

getParticipant

Parameters

Returns Promise<ParticipantInfo>

listParticipants

Parameters

Returns Promise<ParticipantInfo[]>

listRooms

Parameters

Returns Promise<Room[]>

moveParticipant

Parameters

Returns Promise<void>

mutePublishedTrack

Parameters

Returns Promise<TrackInfo>

removeParticipant

Parameters

Returns Promise<void>

sendData

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Deprecated

updateParticipant

Parameters

Returns Promise<ParticipantInfo>

Parameters

Returns Promise<ParticipantInfo>

updateRoomMetadata

Parameters

Returns Promise<Room>

updateSubscriptions

Parameters

Returns Promise<void>

Settings

On This Page