Class RoomServiceClient

Client to access Room APIs

Hierarchy

default
- RoomServiceClient

Index

Constructors

Methods

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

Constructors

constructor

new RoomServiceClient(host, apiKey?, secret?): 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:116

Methods

authHeader

authHeader(grant, sip?): 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): 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:127

deleteRoom

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

getParticipant

getParticipant(room, identity): 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:199

listParticipants

listParticipants(room): 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:182

listRooms

listRooms(names?): 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:143

mutePublishedTrack

mutePublishedTrack(room, identity, trackSid, muted): 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:233

removeParticipant

removeParticipant(room, identity): 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:217

sendData

sendData(room, data, kind, options): 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:348
sendData(room, data, kind, destinationSids?): 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:362

updateParticipant

updateParticipant(room, identity, options): 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:261
updateParticipant(room, identity, metadata?, permission?, name?): 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:272

updateRoomMetadata

updateRoomMetadata(room, metadata): 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:168

updateSubscriptions

updateSubscriptions(room, identity, trackSids, subscribe): 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:320

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>

getParticipant

Parameters

Returns Promise<ParticipantInfo>

listParticipants

Parameters

Returns Promise<ParticipantInfo[]>

listRooms

Parameters

Returns Promise<Room[]>

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