Interface defining the parameters required by the Pagination component. Extends GeneratePageContentParameters for full page content generation functionality.

PaginationParameters

Room Context:

interface PaginationParameters {
    audioDecibels: AudioDecibels[];
    coHostResponsibility: CoHostResponsibility[];
    coHost: string;
    mainRoomsLength: number;
    memberRoom: number;
    breakOutRoomStarted: boolean;
    breakOutRoomEnded: boolean;
    member: string;
    breakoutRooms: BreakoutParticipant[][];
    hostNewRoom: number;
    roomName: string;
    islevel: string;
    showAlert?: ShowAlert;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    getUpdatedAllParams: (() => PaginationParameters);
    updateAddAltGrid: ((addAltGrid: boolean) => void);
    otherGridStreams: Element[][];
    updateOtherGridStreams: ((otherGridStreams: Element[][]) => void);
    updateMiniCardsGrid: UpdateMiniCardsGridType;
    prevActiveNames: string[];
    updatePrevActiveNames: ((prevActiveNames: string[]) => void);
    trigger: TriggerType;
    consumerTransports: Transport[];
    streamNames: Stream[];
    audStreamNames: Stream[];
    participants: Participant[];
    ref_participants: Participant[];
    recordingDisplayType: "video" | "media" | "all";
    recordingVideoOptimized: boolean;
    meetingDisplayType: string;
    meetingVideoOptimized: boolean;
    hostLabel: string;
    mainHeightWidth: number;
    prevMainHeightWidth: number;
    prevDoPaginate: boolean;
    doPaginate: boolean;
    firstAll: boolean;
    shared: boolean;
    shareScreenStarted: boolean;
    shareEnded: boolean;
    oldAllStreams: (Stream | Participant)[];
    remoteProducerId?: string;
    activeNames: string[];
    dispActiveNames: string[];
    p_dispActiveNames: string[];
    nForReadjustRecord: number;
    first_round: boolean;
    lock_screen: boolean;
    chatRefStreams: (Stream | Participant)[];
    eventType: EventType;
    localStreamVideo: MediaStream;
    keepBackground: boolean;
    virtualStream: MediaStream;
    updateActiveNames: ((names: string[]) => void);
    updateDispActiveNames: ((names: string[]) => void);
    updateLStreams: ((streams: (Stream | Participant)[]) => void);
    updateChatRefStreams: ((streams: (Stream | Participant)[]) => void);
    updateNForReadjustRecord: ((n: number) => void);
    updateShowMiniView: ((value: boolean) => void);
    prepopulateUserMedia: PrepopulateUserMediaType;
    rePort: RePortType;
    processConsumerTransports: ProcessConsumerTransportsType;
    resumePauseStreams: ResumePauseStreamsType;
    readjust: ReadjustType;
    addVideosGrid: AddVideosGridType;
    getEstimate: GetEstimateType;
    checkGrid: CheckGridType;
    resumePauseAudioStreams: ResumePauseAudioStreamsType;
    paginatedStreams: (Stream | Participant)[][];
    currentUserPage: number;
    updateMainWindow: boolean;
    updateCurrentUserPage: ((page: number) => void);
    updateUpdateMainWindow: ((flag: boolean) => void);
    dispStreams: DispStreamsType;
    fixedPageLimit: number;
    screenPageLimit: number;
    removeAltGrid: boolean;
    isMediumScreen: boolean;
    updateRemoveAltGrid: ((value: boolean) => void);
    calculateRowsAndColumns: CalculateRowsAndColumnsType;
    allVideoStreams: (Stream | Participant)[];
    screenId?: string;
    forceFullDisplay: boolean;
    mainScreenFilled: boolean;
    adminOnMainScreen: boolean;
    mainScreenPerson: string;
    videoAlreadyOn: boolean;
    audioAlreadyOn: boolean;
    checkOrientation: (() => string);
    screenForceFullDisplay: boolean;
    localStreamScreen: MediaStream;
    remoteScreenStream: Stream[];
    isWideScreen: boolean;
    localUIMode: boolean;
    whiteboardStarted: boolean;
    whiteboardEnded: boolean;
    annotateScreenStream: boolean;
    updateMainScreenPerson: ((person: string) => void);
    updateMainScreenFilled: ((filled: boolean) => void);
    updateAdminOnMainScreen: ((admin: boolean) => void);
    updateMainHeightWidth: ((heightWidth: number) => void);
    updateScreenForceFullDisplay: ((force: boolean) => void);
    updateMainGridStream: ((components: Element[]) => void);
    customVideoCard?: CustomVideoCardType;
    customAudioCard?: CustomAudioCardType;
    customMiniCard?: CustomMiniCardType;
    videoCardComponent?: ComponentType<VideoCardOptions>;
    audioCardComponent?: ComponentType<AudioCardOptions>;
    miniCardComponent?: ComponentType<MiniCardOptions>;
    newLimitedStreams: (Stream | Participant)[];
    sleep: SleepType;
    recordStarted: boolean;
    recordStopped: boolean;
    recordPaused: boolean;
    recordResumed: boolean;
    screenStates: ScreenState[];
    prevScreenStates: ScreenState[];
    updateScreenStates: ((states: ScreenState[]) => void);
    updatePrevScreenStates: ((states: ScreenState[]) => void);
    compareActiveNames: CompareActiveNamesType;
    compareScreenStates: CompareScreenStatesType;
    allAudioStreams: (Stream | Participant)[];
    limitedBreakRoom: BreakoutParticipant[];
    updateLimitedBreakRoom: ((limitedBreakRoom: BreakoutParticipant[]) => void);
    processConsumerTransportsAudio: ProcessConsumerTransportsAudioType;
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    updateDateState?: number;
    lastUpdate: number;
    nForReadjust: number;
    updateUpdateDateState: ((timestamp: number) => void);
    updateLastUpdate: ((lastUpdate: number) => void);
    updateNForReadjust: ((nForReadjust: number) => void);
    autoAdjust: AutoAdjustType;
    updateGridRows: ((rows: number) => void);
    updateGridCols: ((cols: number) => void);
    updateAltGridRows: ((rows: number) => void);
    updateAltGridCols: ((cols: number) => void);
    updateGridSizes: ((gridSizes: GridSizes) => void);
    gridSizes: GridSizes;
    paginationDirection: string;
    paginationHeightWidth: number;
    componentSizes: ComponentSizes;
    [key: string]: any;
}

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

audioDecibels coHostResponsibility coHost mainRoomsLength memberRoom breakOutRoomStarted breakOutRoomEnded member breakoutRooms hostNewRoom roomName islevel showAlert? socket getUpdatedAllParams updateAddAltGrid otherGridStreams updateOtherGridStreams updateMiniCardsGrid prevActiveNames updatePrevActiveNames trigger consumerTransports streamNames audStreamNames participants ref_participants recordingDisplayType recordingVideoOptimized meetingDisplayType meetingVideoOptimized hostLabel mainHeightWidth prevMainHeightWidth prevDoPaginate doPaginate firstAll shared shareScreenStarted shareEnded oldAllStreams remoteProducerId? activeNames dispActiveNames p_dispActiveNames nForReadjustRecord first_round lock_screen chatRefStreams eventType localStreamVideo keepBackground virtualStream updateActiveNames updateDispActiveNames updateLStreams updateChatRefStreams updateNForReadjustRecord updateShowMiniView prepopulateUserMedia rePort processConsumerTransports resumePauseStreams readjust addVideosGrid getEstimate checkGrid resumePauseAudioStreams paginatedStreams currentUserPage updateMainWindow updateCurrentUserPage updateUpdateMainWindow dispStreams fixedPageLimit screenPageLimit removeAltGrid isMediumScreen updateRemoveAltGrid calculateRowsAndColumns allVideoStreams screenId? forceFullDisplay mainScreenFilled adminOnMainScreen mainScreenPerson videoAlreadyOn audioAlreadyOn checkOrientation screenForceFullDisplay localStreamScreen remoteScreenStream isWideScreen localUIMode whiteboardStarted whiteboardEnded annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateMainHeightWidth updateScreenForceFullDisplay updateMainGridStream customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? newLimitedStreams sleep recordStarted recordStopped recordPaused recordResumed screenStates prevScreenStates updateScreenStates updatePrevScreenStates compareActiveNames compareScreenStates allAudioStreams limitedBreakRoom updateLimitedBreakRoom processConsumerTransportsAudio localSocket? updateDateState? lastUpdate nForReadjust updateUpdateDateState updateLastUpdate updateNForReadjust autoAdjust updateGridRows updateGridCols updateAltGridRows updateAltGridCols updateGridSizes gridSizes paginationDirection paginationHeightWidth componentSizes

Properties

audioDecibels: AudioDecibels[]

Array of audio level data for all participants (used for waveform visualization)

coHostResponsibility: CoHostResponsibility[]

Array of responsibilities assigned to co-hosts

coHost: string

User ID of the co-host

mainRoomsLength: number

Total number of main rooms

memberRoom: number

Current room number of the member

breakOutRoomStarted: boolean

Whether breakout rooms have started

breakOutRoomEnded: boolean

Whether breakout rooms have ended

member: string

Current user's member ID/name

Breakout Room State:

breakoutRooms: BreakoutParticipant[][]

Array of breakout room participant groups

User Context:

hostNewRoom: number

Host's current room number

roomName: string

Name/ID of the current room

islevel: string

User's level/role ('0'=participant, '1'=moderator, '2'=host)

showAlert?: ShowAlert

Function to display alerts/notifications

Utility:

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io client for real-time communication

getUpdatedAllParams: (() => PaginationParameters)

Get latest parameter state

updateAddAltGrid: ((addAltGrid: boolean) => void)
otherGridStreams: Element[][]
updateOtherGridStreams: ((otherGridStreams: Element[][]) => void)
updateMiniCardsGrid: UpdateMiniCardsGridType
prevActiveNames: string[]
updatePrevActiveNames: ((prevActiveNames: string[]) => void)
trigger: TriggerType
consumerTransports: Transport[]
streamNames: Stream[]
audStreamNames: Stream[]
participants: Participant[]

Array of all participants in the session

ref_participants: Participant[]
recordingDisplayType: "video" | "media" | "all"
recordingVideoOptimized: boolean
meetingDisplayType: string
meetingVideoOptimized: boolean
hostLabel: string
mainHeightWidth: number
prevMainHeightWidth: number
prevDoPaginate: boolean
doPaginate: boolean
firstAll: boolean
shared: boolean
shareScreenStarted: boolean
shareEnded: boolean
oldAllStreams: (Stream | Participant)[]
remoteProducerId?: string
activeNames: string[]
dispActiveNames: string[]
p_dispActiveNames: string[]
nForReadjustRecord: number
first_round: boolean
lock_screen: boolean
chatRefStreams: (Stream | Participant)[]
eventType: EventType

Type of event ('conference', 'webinar', 'broadcast', etc.)

localStreamVideo: MediaStream
keepBackground: boolean
virtualStream: MediaStream
updateActiveNames: ((names: string[]) => void)
updateDispActiveNames: ((names: string[]) => void)
updateLStreams: ((streams: (Stream | Participant)[]) => void)
updateChatRefStreams: ((streams: (Stream | Participant)[]) => void)
updateNForReadjustRecord: ((n: number) => void)
updateShowMiniView: ((value: boolean) => void)
prepopulateUserMedia: PrepopulateUserMediaType
rePort: RePortType
processConsumerTransports: ProcessConsumerTransportsType
resumePauseStreams: ResumePauseStreamsType
readjust: ReadjustType
addVideosGrid: AddVideosGridType
getEstimate: GetEstimateType
checkGrid: CheckGridType
resumePauseAudioStreams: ResumePauseAudioStreamsType
paginatedStreams: (Stream | Participant)[][]
currentUserPage: number
updateMainWindow: boolean
updateCurrentUserPage: ((page: number) => void)
updateUpdateMainWindow: ((flag: boolean) => void)
dispStreams: DispStreamsType
fixedPageLimit: number
screenPageLimit: number
removeAltGrid: boolean
isMediumScreen: boolean
updateRemoveAltGrid: ((value: boolean) => void)
calculateRowsAndColumns: CalculateRowsAndColumnsType
allVideoStreams: (Stream | Participant)[]
screenId?: string
forceFullDisplay: boolean
mainScreenFilled: boolean
adminOnMainScreen: boolean
mainScreenPerson: string
videoAlreadyOn: boolean
audioAlreadyOn: boolean
checkOrientation: (() => string)
screenForceFullDisplay: boolean
localStreamScreen: MediaStream
remoteScreenStream: Stream[]
isWideScreen: boolean
localUIMode: boolean
whiteboardStarted: boolean
whiteboardEnded: boolean
annotateScreenStream: boolean
updateMainScreenPerson: ((person: string) => void)
updateMainScreenFilled: ((filled: boolean) => void)
updateAdminOnMainScreen: ((admin: boolean) => void)
updateMainHeightWidth: ((heightWidth: number) => void)
updateScreenForceFullDisplay: ((force: boolean) => void)
updateMainGridStream: ((components: Element[]) => void)
customVideoCard?: CustomVideoCardType
customAudioCard?: CustomAudioCardType
customMiniCard?: CustomMiniCardType
videoCardComponent?: ComponentType<VideoCardOptions>
audioCardComponent?: ComponentType<AudioCardOptions>
miniCardComponent?: ComponentType<MiniCardOptions>
newLimitedStreams: (Stream | Participant)[]
sleep: SleepType
recordStarted: boolean
recordStopped: boolean
recordPaused: boolean
recordResumed: boolean
screenStates: ScreenState[]
prevScreenStates: ScreenState[]
updateScreenStates: ((states: ScreenState[]) => void)
updatePrevScreenStates: ((states: ScreenState[]) => void)
compareActiveNames: CompareActiveNamesType
compareScreenStates: CompareScreenStatesType
allAudioStreams: (Stream | Participant)[]
limitedBreakRoom: BreakoutParticipant[]
updateLimitedBreakRoom: ((limitedBreakRoom: BreakoutParticipant[]) => void)
processConsumerTransportsAudio: ProcessConsumerTransportsAudioType
localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>
updateDateState?: number
lastUpdate: number
nForReadjust: number
updateUpdateDateState: ((timestamp: number) => void)
updateLastUpdate: ((lastUpdate: number) => void)
updateNForReadjust: ((nForReadjust: number) => void)
autoAdjust: AutoAdjustType
updateGridRows: ((rows: number) => void)
updateGridCols: ((cols: number) => void)
updateAltGridRows: ((rows: number) => void)
updateAltGridCols: ((cols: number) => void)
updateGridSizes: ((gridSizes: GridSizes) => void)
gridSizes: GridSizes
paginationDirection: string
paginationHeightWidth: number
componentSizes: ComponentSizes