Interface Room

Комната

Hierarchy

  • Room

Properties

name participantCount participantIds addParticipantIds? removeParticipantIds? participants? active? muteStates? pinnedParticipantId? countdownSec?

Properties

name

name: string

name of this room

participantCount

participantCount: number

count of participants (read/write, optional)

participantIds

participantIds: ExternalParticipantId[]

ids of all participants (read/write, optional)

Optional addParticipantIds

addParticipantIds?: ExternalParticipantId[]

ids of participants to be added to this room (read/write, optional)

Optional removeParticipantIds

removeParticipantIds?: ExternalParticipantId[]

ids of participants to be removed from this room (read/write, optional)

Optional participants

participants?: ExternalParticipantListChunk

if participant requested then contains first chunk of participants in this rooms (if client fails to support chunks, then contains all participant in this room) (read, optional)

Optional active

active?: boolean

if this room is active (read/write, optional)

Optional muteStates

muteStates?: MuteStates

global (room-wide) mute state, if any

Optional pinnedParticipantId

pinnedParticipantId?: ExternalParticipantId

pinned participant in the room, if any

Optional countdownSec

countdownSec?: number

room timer