MediaSFU React Native
    Preparing search index...

    Interface BreakoutRoomsModalParameters

    Parameters that power the breakout room management workflow within BreakoutRoomsModal.

    BreakoutRoomsModalParameters

    Participants & Rooms:

    interface BreakoutRoomsModalParameters {
        participants: Participant[];
        showAlert?: ShowAlert;
        socket: Socket;
        localSocket?: Socket;
        itemPageLimit: number;
        meetingDisplayType: string;
        prevMeetingDisplayType: string;
        roomName: string;
        shareScreenStarted: boolean;
        shared: boolean;
        breakOutRoomStarted: boolean;
        breakOutRoomEnded: boolean;
        isBreakoutRoomsModalVisible: boolean;
        currentRoomIndex: number;
        canStartBreakout: boolean;
        breakoutRooms: BreakoutParticipant[][];
        updateBreakOutRoomStarted: (started: boolean) => void;
        updateBreakOutRoomEnded: (ended: boolean) => void;
        updateCurrentRoomIndex: (roomIndex: number) => void;
        updateCanStartBreakout: (canStart: boolean) => void;
        updateBreakoutRooms: (breakoutRooms: BreakoutParticipant[][]) => void;
        updateMeetingDisplayType: (displayType: string) => void;
        getUpdatedAllParams: () => BreakoutRoomsModalParameters;
        [key: string]: any;
    }

    Indexable

    • [key: string]: any
    Index

    Properties

    participants showAlert? socket localSocket? itemPageLimit meetingDisplayType prevMeetingDisplayType roomName shareScreenStarted shared breakOutRoomStarted breakOutRoomEnded isBreakoutRoomsModalVisible currentRoomIndex canStartBreakout breakoutRooms updateBreakOutRoomStarted updateBreakOutRoomEnded updateCurrentRoomIndex updateCanStartBreakout updateBreakoutRooms updateMeetingDisplayType getUpdatedAllParams

    Properties

    participants: Participant[]

    Full participant roster.

    showAlert?: ShowAlert

    Alert helper for UI feedback.

    Display State:

    socket: Socket

    Primary socket connection.

    localSocket?: Socket

    Optional local socket for mirrored events.

    itemPageLimit: number

    Maximum participants per room.

    meetingDisplayType: string

    Current display mode.

    prevMeetingDisplayType: string

    Previous display mode before breakout.

    roomName: string

    Active room identifier.

    shareScreenStarted: boolean

    Whether screen share is active.

    shared: boolean

    Indicates shared content state.

    breakOutRoomStarted: boolean

    Flag when breakout is active.

    breakOutRoomEnded: boolean

    Flag when breakout has ended.

    isBreakoutRoomsModalVisible: boolean

    Whether modal is visible.

    currentRoomIndex: number

    Index of the room in focus.

    Session Context:

    canStartBreakout: boolean

    Whether start button should be enabled.

    Limits & Utilities:

    breakoutRooms: BreakoutParticipant[][]

    Current room assignments.

    updateBreakOutRoomStarted: (started: boolean) => void

    Setter for breakout start flag.

    updateBreakOutRoomEnded: (ended: boolean) => void

    Setter for breakout end flag.

    updateCurrentRoomIndex: (roomIndex: number) => void

    Setter for current room index.

    updateCanStartBreakout: (canStart: boolean) => void

    Controls breakout eligibility.

    updateBreakoutRooms: (breakoutRooms: BreakoutParticipant[][]) => void

    Persists room assignments.

    updateMeetingDisplayType: (displayType: string) => void

    Updates meeting display type.

    getUpdatedAllParams: () => BreakoutRoomsModalParameters

    Helper returning refreshed parameters.

    State Updaters:

    Settings

    Member Visibility

    On This Page

    Properties