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

    Interface SyncedMusicXmlPlayerProps

    interface SyncedMusicXmlPlayerProps {
        allowUnverifiedPresenter?: boolean;
        colors?: Partial<MusicXmlPlayerColors>;
        enabled: boolean;
        fileId: string;
        fileName?: string;
        fileUrl: string;
        isPresenter: boolean;
        labels?: Partial<MusicXmlPlayerLabels>;
        loadEngine: NotationEngineLoader;
        localUserId: string;
        onClose?: () => void;
        onError?: (error: Error) => void;
        presenterId?: string;
        soundfont?: MusicXmlSoundfontOptions;
        sx?: SxProps<Theme>;
        variant?: "overlay" | "inline";
    }

    Hierarchy

    Index

    Properties

    allowUnverifiedPresenter? colors? enabled fileId fileName? fileUrl isPresenter labels? loadEngine localUserId onClose? onError? presenterId? soundfont? sx? variant?

    Properties

    allowUnverifiedPresenter?: boolean

    Apply commands from any sender while presenterId is empty. Any participant can then drive every follower's player, so leave this off unless every participant is trusted.

    false
    colors?: Partial<MusicXmlPlayerColors>
    enabled: boolean

    Whether sync is on. For the presenter this is "share my actions"; for a follower, "follow the presenter".

    fileId: string

    Identifies the open score. Commands for a different score are ignored, so use the same id on every client.

    fileName?: string

    Title shown in the overlay header.

    fileUrl: string

    URL of the MusicXML document to display.

    isPresenter: boolean

    True for the one participant whose actions everyone else follows.

    labels?: Partial<MusicXmlPlayerLabels>
    loadEngine: NotationEngineLoader

    Supplies the notation engine. See NotationEngineLoader.

    localUserId: string

    The local user's id, as the relay knows it.

    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.

    presenterId?: string

    The presenter's user id. A follower applies a command only when its sender matches. Until this is known, followers ignore every command, unless UseMusicXmlPlayerSyncOptions.allowUnverifiedPresenter is set.

    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