MediaSFU React Native
    Preparing search index...

    Interface EventSettingsModalOptions

    Configuration options for the EventSettingsModal component.

    EventSettingsModalOptions

    Modal Control:

    interface EventSettingsModalOptions {
        isEventSettingsModalVisible: boolean;
        onEventSettingsClose: () => void;
        onModifyEventSettings?: (options: ModifySettingsOptions) => Promise<void>;
        position?: "topLeft" | "topRight" | "bottomLeft" | "bottomRight";
        backgroundColor?: string;
        audioSetting: string;
        videoSetting: string;
        screenshareSetting: string;
        chatSetting: string;
        updateAudioSetting: (setting: string) => void;
        updateVideoSetting: (setting: string) => void;
        updateScreenshareSetting: (setting: string) => void;
        updateChatSetting: (setting: string) => void;
        updateIsSettingsModalVisible: (isVisible: boolean) => void;
        roomName: string;
        socket: Socket;
        showAlert?: ShowAlert;
        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

    isEventSettingsModalVisible onEventSettingsClose onModifyEventSettings? position? backgroundColor? audioSetting videoSetting screenshareSetting chatSetting updateAudioSetting updateVideoSetting updateScreenshareSetting updateChatSetting updateIsSettingsModalVisible roomName socket showAlert? style? renderContent? renderContainer?

    Properties

    isEventSettingsModalVisible: boolean

    Controls visibility state.

    onEventSettingsClose: () => void

    Invoked when the modal should close.

    Settings Actions:

    onModifyEventSettings?: (options: ModifySettingsOptions) => Promise<void>

    Handler to persist updated settings.

    Appearance:

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

    Preferred anchor location.

    backgroundColor?: string

    Background color for the modal card.

    audioSetting: string

    Initial audio participant rule.

    videoSetting: string

    Initial video participant rule.

    screenshareSetting: string

    Initial screenshare rule.

    chatSetting: string

    Initial chat rule.

    State Updaters:

    updateAudioSetting: (setting: string) => void

    Persists audio rule updates.

    updateVideoSetting: (setting: string) => void

    Persists video rule updates.

    updateScreenshareSetting: (setting: string) => void

    Persists screenshare rule updates.

    updateChatSetting: (setting: string) => void

    Persists chat rule updates.

    updateIsSettingsModalVisible: (isVisible: boolean) => void

    Updates visibility flag from external triggers.

    Session Context:

    roomName: string

    Room identifier forwarded to the backend.

    socket: Socket

    Active socket connection used for updates.

    showAlert?: ShowAlert

    Optional alert helper for in-modal feedback.

    Advanced Render Overrides:

    style?: StyleProp<ViewStyle>

    Additional styling for the modal container.

    Permission Settings:

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

    Override for customizing the internal layout.

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

    Override for swapping the modal container implementation.

    Settings

    Member Visibility

    On This Page

    Properties