MediaSFU React Native
    Preparing search index...

    Interface MediaSettingsModalOptions

    Configuration options for the MediaSettingsModal component.

    MediaSettingsModalOptions

    Modal Control:

    interface MediaSettingsModalOptions {
        isMediaSettingsModalVisible: boolean;
        onMediaSettingsClose: () => void;
        switchCameraOnPress?: (options: SwitchVideoAltOptions) => Promise<void>;
        switchVideoOnPress?: (options: SwitchVideoOptions) => Promise<void>;
        switchAudioOnPress?: (options: SwitchAudioOptions) => Promise<void>;
        parameters: MediaSettingsModalParameters;
        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

    isMediaSettingsModalVisible onMediaSettingsClose switchCameraOnPress? switchVideoOnPress? switchAudioOnPress? parameters position? backgroundColor? style? renderContent? renderContainer?

    Properties

    isMediaSettingsModalVisible: boolean

    Toggles visibility of the media settings modal.

    onMediaSettingsClose: () => void

    Callback invoked when the modal should close.

    Device Switch Handlers:

    switchCameraOnPress?: (options: SwitchVideoAltOptions) => Promise<void>

    Handler for flipping between device cameras.

    switchVideoOnPress?: (options: SwitchVideoOptions) => Promise<void>

    Handler for changing the active video input.

    switchAudioOnPress?: (options: SwitchAudioOptions) => Promise<void>

    Handler for changing the active audio input.

    State Parameters:

    parameters: MediaSettingsModalParameters

    Current device selections and available devices.

    Customization:

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

    Modal anchoring position.

    backgroundColor?: string

    Background color of the modal surface.

    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 modal content body.

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

    Override for the modal container wrapper.

    Settings

    Member Visibility

    On This Page

    Properties