MediaSFU React Native
    Preparing search index...

    Interface RecordingModalOptions

    Configuration options for the RecordingModal component.

    RecordingModalOptions

    Modal Control:

    interface RecordingModalOptions {
        isRecordingModalVisible: boolean;
        onClose: () => void;
        backgroundColor?: string;
        position?: "center" | "topLeft" | "topRight" | "bottomLeft" | "bottomRight";
        confirmRecording: ConfirmRecordingType;
        startRecording: StartRecordingType;
        parameters: RecordingModalParameters;
        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

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

    Properties

    isRecordingModalVisible: boolean

    Controls visibility of the recording modal.

    onClose: () => void

    Invoked when the modal should close.

    Appearance:

    backgroundColor?: string

    Background color applied to the modal surface.

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

    Anchor position for modal placement.

    confirmRecording: ConfirmRecordingType

    Callback to confirm configured recording settings prior to start.

    startRecording: StartRecordingType

    Handler invoked to begin recording after confirmation.

    State Parameters:

    parameters: RecordingModalParameters

    Parameter bundle including recording preferences and update helpers.

    Advanced Render Overrides:

    style?: StyleProp<ViewStyle>

    Additional styles merged into the modal container.

    Recording Actions:

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

    Override for customizing the internal panel layout.

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

    Override for swapping the modal container (e.g., animated wrappers).

    Settings

    Member Visibility

    On This Page

    Properties