webdaw-modules/publish/src/osmd/getNotesInStaff.d.ts

a set of modules for building a web-based DAW

import { OpenSheetMusicDisplay } from "opensheetmusicdisplay";
import { RepeatData } from "../musicxml/parser";
export declare type NoteInfo = {
    ticks: number;
    noteNumber: number;
    measureIndex: number;
};
export declare type NotesInStaffArgs = {
    osmd: OpenSheetMusicDisplay;
    staffIndex: number;
    repeats: RepeatData[];
    ppq?: number;
    amount?: number;
    start?: number;
};
/**
 * @param {Object} args
 * @param {OpenSheetMusicDisplay} args.osmd
 * @param {number} args.staffIndex
 * @param {RepeatDate} args.repeats
 * @param {number} [args.ppq] - default 960
 * @param {number} [args.amount] - default 100
 * @param {number} [args.start] - default 0
 *
 * The returned notes are objects that contain the ticks value, the MIDI note number and the measure index.
 * Passing a value for ppq affects the ticks values of the notes, this is handy if you need to match tick values
 * with a MIDI file that has a different ppq value then the score.
 */
export declare const getNotesInStaff: ({ osmd, staffIndex, repeats, ppq, amount, start }: NotesInStaffArgs) => NoteInfo[];