Interface EventSettingsModalOptions

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

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<DefaultEventsMap, DefaultEventsMap>;
    showAlert?: ShowAlert;
}

Properties

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

Properties

isEventSettingsModalVisible

isEventSettingsModalVisible: boolean

Determines if the modal is visible.

onEventSettingsClose

onEventSettingsClose: (() => void)

Callback function to close the modal.

OptionalonModifyEventSettings

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

Callback function to modify event settings.

Default

modifySettings

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"

audioSetting

audioSetting: string

Initial audio setting.

videoSetting

videoSetting: string

Initial video setting.

screenshareSetting

screenshareSetting: string

Initial screenshare setting.

chatSetting

chatSetting: string

Initial chat setting.

updateAudioSetting

updateAudioSetting: ((setting: string) => void)

Callback function to update audio setting.

updateVideoSetting

updateVideoSetting: ((setting: string) => void)

Callback function to update video setting.

updateScreenshareSetting

updateScreenshareSetting: ((setting: string) => void)

Callback function to update screenshare setting.

updateChatSetting

updateChatSetting: ((setting: string) => void)

Callback function to update chat setting.

updateIsSettingsModalVisible

updateIsSettingsModalVisible: ((isVisible: boolean) => void)

Callback function to update modal visibility.

roomName

roomName: string

Name of the room.

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket object for communication.

OptionalshowAlert

showAlert?: ShowAlert

Callback function to show alerts.

Settings

Member Visibility

On This Page

Properties