MediaSFU React Native
    Preparing search index...

    Interface WaitingRoomModalOptions

    Configuration options for the WaitingRoomModal component.

    WaitingRoomModalOptions

    Modal Control:

    interface WaitingRoomModalOptions {
        isWaitingModalVisible: boolean;
        onWaitingRoomClose: () => void;
        waitingRoomCounter: number;
        onWaitingRoomFilterChange: (filter: string) => void;
        waitingRoomList: WaitingRoomParticipant[];
        updateWaitingList: (updatedList: WaitingRoomParticipant[]) => void;
        roomName: string;
        socket: Socket;
        position?: "center" | "topLeft" | "topRight" | "bottomLeft" | "bottomRight";
        backgroundColor?: string;
        parameters: WaitingRoomModalParameters;
        onWaitingRoomItemPress?: RespondToWaitingType;
        style?: StyleProp<ViewStyle>;
        renderContent?: (
            options: {
                defaultContent: Element;
                dimensions: { width: number; height: number };
            },
        ) => Element;
        renderContainer?: (
            options: {
                defaultContainer: Element;
                dimensions: { width: number; height: number };
            },
        ) => Element;
    }
    Index

    Properties

    isWaitingModalVisible onWaitingRoomClose waitingRoomCounter onWaitingRoomFilterChange waitingRoomList updateWaitingList roomName socket position? backgroundColor? parameters onWaitingRoomItemPress? style? renderContent? renderContainer?

    Properties

    isWaitingModalVisible: boolean

    Controls modal visibility.

    onWaitingRoomClose: () => void

    Invoked when the waiting room modal should close.

    Queue Management:

    waitingRoomCounter: number

    Pending participants count displayed in the header badge.

    onWaitingRoomFilterChange: (filter: string) => void

    Callback fired whenever the search input changes.

    waitingRoomList: WaitingRoomParticipant[]

    Complete list of waiting participants.

    updateWaitingList: (updatedList: WaitingRoomParticipant[]) => void

    Persists changes after accept/deny actions.

    roomName: string

    Active room identifier used in network calls.

    socket: Socket

    Live socket.io connection powering real-time updates.

    State Parameters:

    position?: "center" | "topLeft" | "topRight" | "bottomLeft" | "bottomRight"

    Preferred modal anchor position.

    backgroundColor?: string

    Background color for the modal card.

    parameters: WaitingRoomModalParameters

    Parameter bundle supplying filtered state helpers.

    Customization:

    onWaitingRoomItemPress?: RespondToWaitingType

    Handler invoked for accept/deny on each participant.

    Session Context:

    style?: StyleProp<ViewStyle>

    Additional styles merged into the modal container.

    Advanced Render Overrides:

    renderContent?: (
        options: {
            defaultContent: Element;
            dimensions: { width: number; height: number };
        },
    ) => Element

    Override that replaces the default modal body content.

    renderContainer?: (
        options: {
            defaultContainer: Element;
            dimensions: { width: number; height: number };
        },
    ) => Element

    Override that swaps the default modal container wrapper.

    Settings

    Member Visibility

    On This Page

    Properties