Class RoomServiceClient

Client to access Room APIs

Hierarchy

  • ServiceBase
    • RoomServiceClient

Constructors

constructor

Methods

authHeader createRoom deleteRoom getParticipant listParticipants listRooms 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

Methods

authHeader

createRoom

deleteRoom

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>

listParticipants

listRooms

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>

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>

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>

  • 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

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>

  • 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>

updateRoomMetadata

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>

Settings

Member Visibility

On This Page

Constructors
Methods