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

    Interface MusicXmlPlayerProps

    interface MusicXmlPlayerProps {
        colors?: Partial<MusicXmlPlayerColors>;
        controlsLocked?: boolean;
        fileName?: string;
        fileUrl: string;
        labels?: Partial<MusicXmlPlayerLabels>;
        loadEngine: NotationEngineLoader;
        onClose?: () => void;
        onError?: (error: Error) => void;
        onLocalCommand?: (command: MusicXmlPlayerCommand) => void;
        soundfont?: MusicXmlSoundfontOptions;
        sx?: SxProps<Theme>;
        variant?: "overlay" | "inline";
    }
    Index

    Properties

    colors? controlsLocked? fileName? fileUrl labels? loadEngine onClose? onError? onLocalCommand? soundfont? sx? variant?

    Properties

    colors?: Partial<MusicXmlPlayerColors>
    controlsLocked?: boolean

    Disable every control and ignore clicks on the score. Use for a follower whose player is driven through the ref handle.

    false
    fileName?: string

    Title shown in the overlay header.

    fileUrl: string

    URL of the MusicXML document to display.

    labels?: Partial<MusicXmlPlayerLabels>
    loadEngine: NotationEngineLoader

    Supplies the notation engine. See NotationEngineLoader.

    onClose?: () => void

    Called when the user closes the player from the overlay header.

    onError?: (error: Error) => void

    Called when the engine or the score fails to load.

    onLocalCommand?: (command: MusicXmlPlayerCommand) => void

    Called for each action the local user performs. Commands applied through the ref handle are not reported.

    soundfont?: MusicXmlSoundfontOptions

    Override the hosts playback fetches instrument samples from.

    sx?: SxProps<Theme>

    Styles merged onto the player's root element.

    variant?: "overlay" | "inline"

    Layout.

    • 'overlay' (default): covers the viewport, with a header holding the title and close buttons.
    • 'inline': fills its parent, with no header.

    Settings

    Member Visibility

    On This Page

    Properties