Documentation
    Preparing search index...

    Type Alias UsePlayer

    Properties exposed by the usePlayer hook.

    type UsePlayer = {
        isCurrentScore: (score: Score) => boolean;
        pause: () => void;
        play: (score: Score, bpm?: number) => void;
        playedNotes: string[][];
        playerStatus: PlayerStatus;
        position: TransportPosition;
        resume: () => void;
        seekTo: (position: TransportPosition) => void;
        setBpm: (bpm: number) => void;
        stop: () => void;
    }
    Index
    isCurrentScore pause play playedNotes playerStatus position resume seekTo setBpm stop
    isCurrentScore: (score: Score) => boolean

    Tells if the passed score is the one being played.

    pause: () => void

    Pauses the current playback.

    play: (score: Score, bpm?: number) => void

    Plays the current score.

    playedNotes: string[][]

    The notes being currently played.

    playerStatus: PlayerStatus

    The current playback status.

    position: TransportPosition

    The current transport position.

    resume: () => void

    Resumes the current playback.

    seekTo: (position: TransportPosition) => void

    Seeks the current playback to the passed position.

    setBpm: (bpm: number) => void

    Sets the transport bpm to the passed value.

    stop: () => void

    Stops the current playback.

    Settings
    Member Visibility

    On This Page
    Properties