MediaSFU React Native
    Preparing search index...

    Interface PaginationParameters

    Interface defining the parameters required by the Pagination component.

    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;
        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;
        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 Summary)

    Indexable

    • [key: string]: any
    Index

    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[]

    Live loudness metrics per participant.

    coHostResponsibility: CoHostResponsibility[]

    Active co-host capabilities.

    coHost: string

    Current co-host identifier.

    mainRoomsLength: number
    memberRoom: number
    breakOutRoomStarted: boolean
    breakOutRoomEnded: boolean
    member: string

    Local member identifier.

    breakoutRooms: BreakoutParticipant[][]
    hostNewRoom: number
    roomName: string

    Active room identifier.

    islevel: string

    Member privilege level.

    showAlert?: ShowAlert

    Optional alert helper.

    socket: Socket

    Socket instance for media control events.

    getUpdatedAllParams: () => PaginationParameters

    Refreshes parameters before invoking side effects.

    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[]

    Current participant roster.

    Session Context:

    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

    Meeting event type (e.g., conference).

    Helpers:

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