Interface Room

Комната

interface Room {
    name: string;
    participantCount: number;
    participantIds: ExternalParticipantId[];
    addParticipantIds?: ExternalParticipantId[];
    removeParticipantIds?: ExternalParticipantId[];
    participants?: ExternalParticipantListChunk;
    active?: boolean;
    muteStates?: MuteStates;
    pinnedParticipantId?: ExternalParticipantId;
    countdownSec?: number;
}

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)

OptionaladdParticipantIds

addParticipantIds?: ExternalParticipantId[]

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

OptionalremoveParticipantIds

removeParticipantIds?: ExternalParticipantId[]

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

Optionalparticipants

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)

Optionalactive

active?: boolean

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

OptionalmuteStates

muteStates?: MuteStates

global (room-wide) mute state, if any

OptionalpinnedParticipantId

pinnedParticipantId?: ExternalParticipantId

pinned participant in the room, if any

OptionalcountdownSec

countdownSec?: number

room timer

Settings

Member Visibility

On This Page

Properties