Interface NotationEngine

A notation engine: the OpenSheetMusicDisplay module, or any build exposing the same classes.

The three playback classes are optional. When any of them is missing the player renders the score and hides the playback controls.

interface NotationEngine {
    BasicAudioPlayer?: new () => NotationAudioPlayer;
    CursorType?: { Standard?: number };
    LinearTimingSource?: new () => NotationTimingSource;
    OpenSheetMusicDisplay: new (
        container: HTMLElement,
        options?: object,
    ) => NotationDisplay;
    PlaybackManager?: new (
        timingSource: NotationTimingSource,
        metronomePlayer: undefined,
        audioPlayer: NotationAudioPlayer,
        messageViewer: undefined,
    ) => NotationPlaybackManager;
}

Properties

BasicAudioPlayer?: new () => NotationAudioPlayer

CursorType?: { Standard?: number }

LinearTimingSource?: new () => NotationTimingSource

OpenSheetMusicDisplay: new (
container: HTMLElement,
options?: object,
) => NotationDisplay

PlaybackManager?: new (
    timingSource: NotationTimingSource,
    metronomePlayer: undefined,
    audioPlayer: NotationAudioPlayer,
    messageViewer: undefined,
) => NotationPlaybackManager