@videosdk.live/server-sdk
    Preparing search index...

    Class ParticipantsResource

    Participants API — the room-keyed view over a room's live participants.

    Convenience over SessionsResource: these methods resolve the room's current (ongoing) session for you, so you work with a roomId instead of a sessionId. For historical sessions/participants, use sessions directly.

    Index
    constructor
    get list remove

    • Fetch a single active participant in a room's current session. Throws RoomNotFoundError when the room has no live session.

      Parameters

      • roomId: string
      • participantId: string

      Returns Promise<Participant>

    • List the active participants in a room's current session (paginated, async-iterable). Resolves to an empty page when the room has no live session.

      Parameters

      Returns Promise<Page<Participant>>

    • Remove (kick) a participant from a room's live session. The active session is resolved from roomId. Returns a confirmation message.

      Parameters

      • roomId: string
      • participantId: string

      Returns Promise<string>

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods