• English
  • API Overview

    Muse Player is organized as a monorepo with five packages, each with a focused responsibility.

    Packages

    @muse-player/core

    Core React hooks and the ScoreRenderer component. This is the primary package for integrating Muse Player into a React application.

    Exports: useScore, usePlayback, usePianoSampler, useAutoScroll, useNoteHighlight, ScoreRenderer

    @muse-player/component

    Pre-built UI components for playback controls, styled with StyleX.

    Exports: PlaybackControls

    @muse-player/server

    Node.js library for server-side MXL/MusicXML rendering via Verovio WASM. Converts MXL files into SVG pages, MIDI data, and timemaps.

    Exports: renderScore

    @muse-player/cli

    CLI tool (muse-render) for pre-rendering MXL files to static asset directories.

    @muse-player/instruments

    Piano sample manifests and URL resolution for realistic audio playback.

    Exports: getPianoSampleUrls, PIANO_MANIFEST, PIANO_CDN_URL

    @muse-player/core

    @muse-player/component

    @muse-player/server

    @muse-player/cli

    @muse-player/instruments