Hiyve Components - v1.0.0
    Preparing search index...

    Interface RecordingControlsProps

    Props for the RecordingControls component.

    interface RecordingControlsProps {
        colors?: Partial<RecordingControlsColors>;
        error?: string | null;
        isRecording: boolean;
        isRecordingStarting: boolean;
        labels?: Partial<RecordingControlsLabels>;
        onClearError?: () => void;
        onStartRecording: (
            options?: { autoCompose?: boolean; transcribe?: boolean },
        ) => void;
        onStopRecording: () => void;
        recordingDuration?: number;
        showOptions?: boolean;
    }
    Index

    Properties

    colors? error? isRecording isRecordingStarting labels? onClearError? onStartRecording onStopRecording recordingDuration? showOptions?

    Properties

    colors?: Partial<RecordingControlsColors>

    Partial color overrides merged with built-in defaults. See RecordingControlsColors.

    error?: string | null

    Error message to display, or null/undefined for no error.

    isRecording: boolean

    Whether a recording is currently in progress.

    isRecordingStarting: boolean

    Whether the recording is in the process of starting.

    labels?: Partial<RecordingControlsLabels>

    Partial label overrides merged with built-in defaults. See RecordingControlsLabels.

    onClearError?: () => void

    Called when the user taps the error message to dismiss it.

    onStartRecording: (
        options?: { autoCompose?: boolean; transcribe?: boolean },
    ) => void

    Called when the user presses the record button. Receives optional recording options.

    onStopRecording: () => void

    Called when the user presses the stop button.

    recordingDuration?: number

    Elapsed recording time in seconds.

    showOptions?: boolean

    Whether to show the transcribe and auto-compose option switches.

    false

    Settings

    Member Visibility

    On This Page

    Properties