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?: object;
    renderContent?: ((options: {
        defaultContent: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => Element);
    renderContainer?: ((options: {
        defaultContainer: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

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

Properties

isMediaSettingsModalVisible

isMediaSettingsModalVisible: boolean

Whether the modal is currently visible

onMediaSettingsClose

onMediaSettingsClose: (() => void)

Callback to close the modal

Device Switch Handlers:

OptionalswitchCameraOnPress

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

Handler for camera switching (front/back on mobile)

OptionalswitchVideoOnPress

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

Handler for video input device switching

OptionalswitchAudioOnPress

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

Handler for audio input device switching

State Parameters:

parameters

parameters: MediaSettingsModalParameters

Current device state and available devices

Customization:

Optionalposition

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

Modal screen position

OptionalbackgroundColor

backgroundColor?: string

Modal background color

Optionalstyle

style?: object

Additional custom styles

Advanced Render Overrides:

OptionalrenderContent

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

Custom content renderer (receives defaultContent and dimensions)

OptionalrenderContainer

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

Custom container renderer (receives defaultContainer and dimensions)

Settings

Member Visibility

On This Page

Properties