MediaSFU React Native
    Preparing search index...

    Interface DisplaySettingsModalOptions

    Configuration options for the DisplaySettingsModal component.

    DisplaySettingsModalOptions

    Modal Control:

    interface DisplaySettingsModalOptions {
        isDisplaySettingsModalVisible: boolean;
        onDisplaySettingsClose: () => void;
        onModifyDisplaySettings?: (
            options: ModifyDisplaySettingsOptions,
        ) => Promise<void>;
        parameters: DisplaySettingsModalParameters;
        position?: "topLeft" | "topRight" | "bottomLeft" | "bottomRight";
        backgroundColor?: string;
        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

    isDisplaySettingsModalVisible onDisplaySettingsClose onModifyDisplaySettings? parameters position? backgroundColor? style? renderContent? renderContainer?

    Properties

    isDisplaySettingsModalVisible: boolean

    Toggles modal visibility.

    onDisplaySettingsClose: () => void

    Invoked when the settings modal should close.

    Settings Handler:

    onModifyDisplaySettings?: (
        options: ModifyDisplaySettingsOptions,
    ) => Promise<void>

    Custom handler for persisting updated display settings.

    State Parameters:

    parameters: DisplaySettingsModalParameters

    Current display configuration state.

    Customization:

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

    Preferred modal anchor location.

    backgroundColor?: string

    Modal background color.

    style?: StyleProp<ViewStyle>

    Additional styling applied to the modal container.

    Advanced Render Overrides:

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

    Override for the default content layout.

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

    Override for the outer modal container.

    Settings

    Member Visibility

    On This Page

    Properties