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

    @hiyve/react-music-performance — React hooks and components for practising from a score: record a take, follow the performer on the sheet music as they play, grade the take, keep it, and write sight-reading exercises.

    • usePracticeSession — recording, following and grading in one: a take that ends when the piece does, graded as surely as it can be
    • RecordButton / PacingSwitch / PracticeSettingsButton — the controls for a score player's toolbar
    • LiveStrip — what the session makes of a take as it goes
    • TakeScoreCard / MarkedScore / SavedTakesTable — a take's score, its marked score, and the takes kept
    • useTakeHistory — the takes kept in this browser, marked scores and all
    • SightReadingPanel — the settings of a sight-reading exercise, with its code
    • TakeRecorder / useTakeRecorder — the capture flow on its own
    • useLivePerformance / useMetronome — the live session and the click track on their own
    • useMidiInputs / useAudioInputs — connected devices, kept current
    import { usePracticeSession, RecordButton, LiveStrip } from '@hiyve/react-music-performance';

    const session = usePracticeSession({ score, musicxml, title, mode: 'free', bpm: 100, playerRef });
    <MusicXmlPlayer ref={playerRef} fileUrl={url} loadEngine={loadEngine} noteStyles={session.noteStyles} position={session.position}
    transportActions={<RecordButton recorder={session.recorder} />} onPlaybackEnded={session.handlePlaybackEnded} />

    Components

    ExerciseCodeChip
    LiveStrip
    MarkedScore
    PacingSwitch
    PracticeSettingsButton
    RecordButton
    SavedTakesTable
    ScoreRing
    SightReadingPanel
    TakeRecorder
    TakeReport
    TakeScoreCard

    Other

    AudioChunk
    AudioInputInfo
    ExerciseCodeChipLabels
    ExerciseCodeChipProps
    GradedTake
    GradeFinishedTakeOptions
    InstrumentProfile
    LiveStripLabels
    LiveStripProps
    LiveTempoSetting
    LoadedScore
    MarkedScoreLabels
    MarkedScoreProps
    MetronomeClick
    MetronomeStart
    PacingSwitchLabels
    PacingSwitchProps
    PracticeSessionLabels
    PracticeSettings
    PracticeSettingsButtonProps
    PracticeSettingsLabels
    RecordButtonLabels
    RecordButtonProps
    SavedTakeResult
    SavedTakesTableLabels
    SavedTakesTableProps
    ScoreRingProps
    SightReadingPanelLabels
    SightReadingPanelProps
    StoredTakeScore
    TakeClockHandle
    TakeFiles
    TakeRecorderColors
    TakeRecorderIcons
    TakeRecorderLabels
    TakeRecorderProps
    TakeReportLabels
    TakeReportProps
    TakeResult
    TakeResultView
    TakeScoreCardColors
    TakeScoreCardLabels
    TakeScoreCardProps
    TimingStrictnessLevel
    TryAgainTarget
    UseAudioInputsResult
    UseLivePerformanceOptions
    UseLivePerformanceResult
    UseMetronomeOptions
    UseMetronomeResult
    UseMidiInputsResult
    UsePracticeSessionOptions
    UsePracticeSessionResult
    UseScoreOptions
    UseScoreResult
    UseTakeHistoryOptions
    UseTakeHistoryResult
    UseTakeRecorderOptions
    UseTakeRecorderResult
    FinalGradeInputs
    InstrumentFamily
    LiveSource
    LiveStrictness
    PacingMode
    SightReadingSettings
    TakeRecorderStatus
    TakeReportColors
    defaultExerciseCodeChipLabels
    defaultLiveStripLabels
    defaultMarkedScoreLabels
    defaultPacingSwitchLabels
    defaultPracticeSessionLabels
    defaultPracticeSettings
    defaultPracticeSettingsLabels
    defaultRecordButtonLabels
    defaultSavedTakesTableLabels
    defaultSightReadingPanelLabels
    defaultTakeRecorderColors
    defaultTakeRecorderIcons
    defaultTakeRecorderLabels
    defaultTakeReportColors
    defaultTakeReportLabels
    defaultTakeScoreCardColors
    defaultTakeScoreCardLabels
    instrumentFamilies
    instrumentProfiles
    PRACTICE_AUDIO_DEFAULT
    PRACTICE_MIDI_ALL
    PRACTICE_MIDI_NONE
    sightReadingClefBase
    sightReadingRanges
    sightReadingRhythmsByLevel
    timingStrictness
    defaultSightReadingSettings
    downloadTakeAudio
    downloadTakeJson
    formatElapsedDefault
    formatElapsedShort
    formatWhenDefault
    gradeFinishedTake
    liveNoteStyles
    livePositionQuarters
    mergeExerciseCodeChipLabels
    mergeLiveStripLabels
    mergeMarkedScoreLabels
    mergePacingSwitchLabels
    mergePracticeSessionLabels
    mergePracticeSettingsLabels
    mergeRecordButtonLabels
    mergeSavedTakesTableLabels
    mergeSightReadingPanelLabels
    mergeTakeRecorderColors
    mergeTakeRecorderIcons
    mergeTakeRecorderLabels
    mergeTakeReportColors
    mergeTakeReportLabels
    mergeTakeScoreCardColors
    mergeTakeScoreCardLabels
    newSightReadingSeed
    noteKeyOf
    playedPitchOf
    practiceRecorderOptions
    recoverSightReadingSettings
    reportNoteStyles
    savedTakeResultFrom
    savedTakeResultView
    scorePraise
    scoreTone
    strictnessLevel
    takeGradeOf
    takeResultView
    toTakeFiles
    tryAgainTargetOf
    useAudioInputs
    useLivePerformance
    useMetronome
    useMidiInputs
    usePracticeSession
    useScore
    useScoreUrl
    useTakeHistory
    useTakeRecorder
    withoutTimingMarks