Interface MediaSettingsModalOptions

Interface defining the options (props) for the MediaSettingsModal component.

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;
}

Properties

isMediaSettingsModalVisible onMediaSettingsClose switchCameraOnPress? switchVideoOnPress? switchAudioOnPress? parameters position? backgroundColor?

Properties

isMediaSettingsModalVisible

isMediaSettingsModalVisible: boolean

Determines if the media settings modal is visible.

onMediaSettingsClose

onMediaSettingsClose: (() => void)

Callback function to close the media settings modal.

OptionalswitchCameraOnPress

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

Function to handle camera switch action.

Default

switchVideoAlt

OptionalswitchVideoOnPress

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

Function to handle video input switch action.

Default

switchVideo

OptionalswitchAudioOnPress

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

Function to handle audio input switch action.

Default

switchAudio

parameters

parameters: MediaSettingsModalParameters

Parameters containing user default devices and available devices.

Optionalposition

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

Position of the modal on the screen.

Default

"topRight"

OptionalbackgroundColor

backgroundColor?: string

Background color of the modal.

Default

"#83c0e9"

Settings

Member Visibility

On This Page

Properties