Interface RecordingModalOptions

Interface defining the options for the RecordingModal component.

RecordingModalOptions

Display Control:

interface RecordingModalOptions {
    isRecordingModalVisible: boolean;
    onClose: (() => void);
    backgroundColor?: string;
    position?:
        | "center"
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    confirmRecording: ConfirmRecordingType;
    startRecording: StartRecordingType;
    parameters: RecordingModalParameters;
    style?: object;
    renderContent?: ((options: {
        defaultContent: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => Element);
    renderContainer?: ((options: {
        defaultContainer: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

isRecordingModalVisible onClose backgroundColor? position? confirmRecording startRecording parameters style? renderContent? renderContainer?

Properties

isRecordingModalVisible

isRecordingModalVisible: boolean

Whether the modal is currently visible

onClose

onClose: (() => void)

Callback when modal is closed

OptionalbackgroundColor

backgroundColor?: string

Background color of the modal content

Optionalposition

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

Screen position where the modal should appear

Recording Actions:

confirmRecording

confirmRecording: ConfirmRecordingType

Function to confirm and apply recording settings

startRecording

startRecording: StartRecordingType

Function to start the recording with configured settings

Configuration:

parameters

parameters: RecordingModalParameters

Recording configuration parameters and state

Advanced Render Overrides:

Optionalstyle

style?: object

Custom styles for modal container

OptionalrenderContent

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

Function to wrap or replace the default modal content

OptionalrenderContainer

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

Function to wrap or replace the entire modal container

Settings

Member Visibility

On This Page

Properties