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

    Interface UseTakeRecorderResult

    Return value of useTakeRecorder.

    interface UseTakeRecorderResult {
        bundle: TakeBundle | null;
        comparison: CaptureSettingsComparison | null;
        elapsedMs: number;
        error: Error | null;
        isAudioSupported: boolean;
        isMidiSupported: boolean;
        isRecording: boolean;
        level: number;
        midiEventCount: number;
        nowMs: () => number;
        settings: AudioCaptureSettings | null;
        start: () => Promise<void>;
        status: TakeRecorderStatus;
        stop: () => Promise<TakeBundle | null>;
    }
    Index

    Properties

    bundle comparison elapsedMs error isAudioSupported isMidiSupported isRecording level midiEventCount nowMs settings start status stop

    Properties

    bundle: TakeBundle | null

    The most recent finished take

    comparison: CaptureSettingsComparison | null

    Which processing flags the browser honoured for the chosen profile

    elapsedMs: number

    Milliseconds since recording started (updates ~10× per second)

    error: Error | null
    isAudioSupported: boolean
    isMidiSupported: boolean
    isRecording: boolean
    level: number

    Microphone level 0–1 (RMS of the latest chunk)

    midiEventCount: number

    MIDI events recorded so far

    nowMs: () => number

    Take-clock time now, exact; 0 when not recording

    settings: AudioCaptureSettings | null

    What the browser applied to the microphone, once recording has started

    start: () => Promise<void>

    Start capturing. Call from a user gesture so every browser lets audio run.

    status: TakeRecorderStatus
    stop: () => Promise<TakeBundle | null>

    Stop capturing and build the take

    Settings

    Member Visibility

    On This Page

    Properties