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

    Interface TakeRecorderProps

    Props for the TakeRecorder component.

    interface TakeRecorderProps {
        colors?: Partial<TakeRecorderColors>;
        defaultAudioDeviceId?: string;
        defaultMidiInputId?: string;
        defaultProfile?: AudioProfile;
        enableDownload?: boolean;
        icons?: Partial<TakeRecorderIcons>;
        labels?: Partial<TakeRecorderLabels>;
        notes?: string;
        onAudioChunk?: (chunk: AudioChunk) => void;
        onError?: (error: Error) => void;
        onMidiEvent?: (event: MidiEvent) => void;
        onRecordingStarted?: (take: TakeClockHandle) => void;
        onTakeCompleted?: (bundle: TakeBundle) => void;
        score?: TakeScoreReference;
        showAlignment?: boolean;
        showAudioSelector?: boolean;
        showMidiSelector?: boolean;
        showProfileSelector?: boolean;
        sx?: SxProps<Theme>;
    }
    Index

    Properties

    colors? defaultAudioDeviceId? defaultMidiInputId? defaultProfile? enableDownload? icons? labels? notes? onAudioChunk? onError? onMidiEvent? onRecordingStarted? onTakeCompleted? score? showAlignment? showAudioSelector? showMidiSelector? showProfileSelector? sx?

    Properties

    colors?: Partial<TakeRecorderColors>
    defaultAudioDeviceId?: string

    Initially selected microphone; omit for the browser default

    defaultMidiInputId?: string

    Initially selected MIDI input; omit for all inputs

    defaultProfile?: AudioProfile

    Initial capture profile (default: 'instrument')

    enableDownload?: boolean

    Offer download buttons once a take is finished (default: true)

    icons?: Partial<TakeRecorderIcons>
    labels?: Partial<TakeRecorderLabels>
    notes?: string

    Free-text notes stored with the take

    onAudioChunk?: (chunk: AudioChunk) => void

    Called with every captured audio chunk as it arrives, for live analysis (see useLivePerformance)

    onError?: (error: Error) => void

    Called for microphone, MIDI, and audio-context failures

    onMidiEvent?: (event: MidiEvent) => void

    Called with every MIDI event as it arrives, for live analysis

    onRecordingStarted?: (take: TakeClockHandle) => void

    Called once capture is running, with the take's clock

    onTakeCompleted?: (bundle: TakeBundle) => void

    Called with the finished take

    score?: TakeScoreReference

    The score the take is performed against, stored with the take

    showAlignment?: boolean

    Show the measured MIDI-to-audio offset once a take is finished (default: true)

    showAudioSelector?: boolean

    Show the microphone selector (default: true)

    showMidiSelector?: boolean

    Show the MIDI input selector (default: true)

    showProfileSelector?: boolean

    Show the capture-profile selector (default: true)

    sx?: SxProps<Theme>

    MUI sx styling for the root element

    Settings

    Member Visibility

    On This Page

    Properties