@tspro/web-music-score 4.0.0 → 4.1.0

package/dist/{interface-XoKiryoV.d.mts → music-objects-DIaqNPjs.d.mts}

@@ -1,5 +1,5 @@
-import { N as Note, A as Accidental } from './note-BFa43I86.mjs';
-import { R as RhythmProps, N as NoteLength, h as NoteLengthStr, j as TupletRatio, c as Tempo, K as KeySignature, a as TimeSignature, T as TimeSignatureString } from './tempo-BAYoZ_Li.mjs';
+import { N as Note, A as Accidental } from './note-eA2xPPiG.mjs';
+import { R as RhythmProps, N as NoteLength, i as NoteLengthStr, k as TupletRatio, d as Tempo, K as KeySignature, b as TimeSignature } from './tempo-S85Q7uJA.mjs';
 import { Vec2 } from '@tspro/ts-utils-lib';
 
 /**
@@ -20,31 +20,31 @@ declare class DivRect {
      * Create rectangle with left, right, top, bottom.
      * Properties centerX and centerY will be centered in the middle.
      *
-     * @param left -
-     * @param right -
-     * @param top -
-     * @param bottom -
+     * @param left - Left coordinate.
+     * @param right - Right coordinate.
+     * @param top - Top coordinate.
+     * @param bottom - Bottom coordinate.
      */
     constructor(left: number, right: number, top: number, bottom: number);
     /**
      * Create rectangle with full arguments.
      *
-     * @param left -
-     * @param centerX -
-     * @param right -
-     * @param top -
-     * @param centerY -
-     * @param bottom -
+     * @param left - Left coordinate.
+     * @param centerX - Center x-coordinate.
+     * @param right - Right coordinate.
+     * @param top - Top coordinate.
+     * @param centerY - Center y-coordinate.
+     * @param bottom - Bottom coordinate.
      */
     constructor(left: number, centerX: number, right: number, top: number, centerY: number, bottom: number);
     /**
      * Create rect from basic left, top, width and height arguments.
      *
-     * @param left -
-     * @param top -
-     * @param width -
-     * @param height -
-     * @returns
+     * @param left - Left coordinate.
+     * @param top - Top coordinate.
+     * @param width - With.
+     * @param height - Height.
+     * @returns - DivRect.
      */
     static create(left: number, top: number, width: number, height: number): DivRect;
     /**
@@ -52,9 +52,9 @@ declare class DivRect {
      *
      * @param centerX - Center x-coordinate.
      * @param centerY - Center y-coordinate.
-     * @param width -
-     * @param height -
-     * @returns
+     * @param width - Width.
+     * @param height - Height.
+     * @returns - DivRect.
      */
     static createCentered(centerX: number, centerY: number, width: number, height: number): DivRect;
     /**
@@ -64,139 +64,146 @@ declare class DivRect {
      * @param rightw - Right section width.
      * @param toph - Top section height.
      * @param bottomh - Bottomsection height.
-     * @returns
+     * @returns - DivRect.
      */
     static createSections(leftw: number, rightw: number, toph: number, bottomh: number): DivRect;
     /**
-     * Width.
+     * Width getter.
      */
     get width(): number;
     /**
-     * Height.
+     * Height getter.
      */
     get height(): number;
     /**
-     * Left section width.
+     * Left section width getter.
      */
     get leftw(): number;
     /**
-     * Right section width.
+     * Right section width getter.
      */
     get rightw(): number;
     /**
-     * Top section height.
+     * Top section height getter.
      */
     get toph(): number;
     /**
-     * Bottom section height.
+     * Bottom section height getter.
      */
     get bottomh(): number;
     /**
      * Does this Rect contain given (x, y)-point?
      *
-     * @param x -
-     * @param y -
-     * @returns
+     * @param x - X-coordinate.
+     * @param y - Y-coordinate.
+     * @returns - True/false.
      */
     contains(x: number, y: number): boolean;
     /**
      * Do a and b rects overlap?
      *
-     * @param a -
-     * @param b -
-     * @returns
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
      */
     static overlap(a: DivRect, b: DivRect): boolean;
     /**
      * Do horizontal measures of a and b rects overlap?
      *
-     * @param a -
-     * @param b -
-     * @returns
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
      */
     static overlapX(a: DivRect, b: DivRect): boolean;
     /**
      * Check if this Rect equals with given Rect.
-     * @param b -
-     * @returns
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
      */
     static equals(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
     /**
-     * Check if frame (ignoring centerX/Y) of this Rect equals with given Rect, ignoring centerX and centerY.
+     * Check if frame of this Rect equals with given Rect, ignoring center x- and center y-coordinates.
      *
-     * @param b -
-     * @returns
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
      */
     static equalsFrame(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
     /**
      * Created duplicate of this Rect.
      *
-     * @returns
+     * @returns - Duplicate.
      */
     copy(): DivRect;
     /**
      * Move this rect by (dx, dy). Modifies this Rect.
      *
-     * @param dx -
-     * @param dy -
-     * @returns
+     * @param dx - Offset amount in x-direction.
+     * @param dy - Offset amount in y-direction.
+     * @returns - This DivRect instance.
      */
     offsetInPlace(dx: number, dy: number): DivRect;
     /**
      * Move this rect by (dx, dy). Immutable, returns modified copy.
      *
-     * @param dx -
-     * @param dy -
-     * @returns
+     * @param dx - Offset amount in x-direction.
+     * @param dy - Offset amount in y-direction.
+     * @returns - DivRect copy with applied offset.
      */
     offsetCopy(dx: number, dy: number): DivRect;
     /**
      * Expand this Rect by given Rect. Modifies this Rect.
      *
-     * @param rect -
-     * @returns
+     * @param rect - DivRect to expand this instance with.
+     * @returns - This DivRect instance.
      */
     expandInPlace(rect: DivRect): DivRect;
     /**
      * Expand this Rect by given Rect. Immutable, returns modified copy.
      *
-     * @param rect -
-     * @returns
+     * @param rect - DivRect to expand this instance with.
+     * @returns - Expanded copy of this DivRect.
      */
     expandCopy(rect: DivRect): DivRect;
     /**
      * Clip this Rect by given Rect. Mmodifies this Rect.
      *
-     * @param clipRect -
-     * @returns
+     * @param clipRect - DivRect to clip this instance with.
+     * @returns - This DivRect instance.
      */
     clipInPlace(clipRect: DivRect): DivRect;
     /**
      * Clip this Rect by given Rect. Immutable, return modified copy.
      *
-     * @param clipRect -
-     * @returns
+     * @param clipRect - DivRecto to clip this instance with.
+     * @returns - Clipped DivRect copy.
      */
     clipCopy(clipRect: DivRect): DivRect;
     /**
      * Scale Rect. Anchor pos is (centerX, centerY). Modifies this Rect.
      *
-     * @param scaleX -
-     * @param scaleY -
-     * @returns Copy of scaled Rect.
+     * @param scaleX - Scale x-amount.
+     * @param scaleY - Scale y-amount. If undefined then scale x-amount is used.
+     * @returns This DivRect instance.
      */
     scaleInPlace(scaleX: number, scaleY?: number): DivRect;
     /**
      * Scale Rect. Anchor pos is (centerX, centerY). Immutable, returns modified copy.
      *
-     * @param scaleX -
-     * @param scaleY -
-     * @returns Copy of scaled Rect.
+     * @param scaleX - Scale x-amount.
+     * @param scaleY - Scale y-amount. If undefined then scale x-amount is used.
+     * @returns Scaled copy of this DivRect.
      */
     scaleCopy(scaleX: number, scaleY?: number): DivRect;
+    /**
+     * Get this DivRect instance.
+     * @returns - This DivRect instance.
+     */
     getRect(): DivRect;
 }
 
+/** Staff preset values for score configuration. */
 declare enum StaffPreset {
     /** Treble staff has treble (G-) clef. */
     Treble = "treble",
@@ -211,92 +218,157 @@ declare enum StaffPreset {
     /** GuitarCombined has treble clef and tab for guitar. */
     GuitarCombined = "guitarCombined"
 }
+/** Clef for staff notation lines. */
 declare enum Clef {
+    /** G-clef (treble cleff) */
     G = "G",
+    /** F-clef (bass cleff) */
     F = "F"
 }
+/** Staff config to add staff notation line in score configuration. */
 type StaffConfig = {
+    /** Config type, must be "staff" for staff config. */
     type: "staff";
+    /** G-clef or F-clef for this staff config? */
     clef: Clef | `${Clef}`;
+    /** Set name for this staff config. */
     name?: string;
+    /** Set octave down with G-clef for guitar treble staff notation line. */
     isOctaveDown?: boolean;
+    /** Lowest note (e.g. "C2")that can be presented in this staff notation line. */
     minNote?: string;
+    /** Highest note (e.g. "C6") that can be presented in this staff notation line. */
     maxNote?: string;
+    /** Voice ids that are presented in this staff notation line. */
     voiceIds?: number[];
+    /** Set true for two staff configs with G-clef and F-clef to create grand staff. */
     isGrand?: boolean;
 };
+/** Tab config to add guitar tab in score configuration. */
 type TabConfig = {
+    /** Config type, must be "tab" for tab config. */
     type: "tab";
+    /** Set name for this tab config. */
     name?: string;
     tuning?: string | string[];
+    /** Voice ids that are presented in this guitar tab notation line. */
     voiceIds?: number[];
 };
+/** Score configuration. */
 type ScoreConfiguration = StaffConfig | TabConfig | (StaffConfig | TabConfig)[];
+/** VoiceId type. */
 type VoiceId = 0 | 1 | 2 | 3;
+/** Get supported VoiceIds. Returns [0, 1, 2, 3]. */
 declare function getVoiceIds(): ReadonlyArray<VoiceId>;
+/** Strng number type. */
 type StringNumber = 1 | 2 | 3 | 4 | 5 | 6;
+/** Get strin numbers. Returns [0, 1, 2, 3, 4, 5]. */
 declare function getStringNumbers(): ReadonlyArray<StringNumber>;
+/** Stem direction enum. */
 declare enum Stem {
+    /** Auto stem direction. */
     Auto = "auto",
+    /** Stem is upwards. */
     Up = "up",
+    /** Stm is downwards. */
     Down = "down"
 }
+/** Arpeggio direction enum. */
 declare enum Arpeggio {
+    /** Upwards, chord played from lowes to highest. */
     Up = "up",
+    /** Downwards, chord played from highest to loest. */
     Down = "down"
 }
+/** Special tie length enum. */
 declare enum TieType {
+    /** Stub tie is short tie that left anchors to note and has not right anchor point. */
     Stub = "stub",
+    /** To measure end tie is tie that left anchors to note and right anchors to measure end. */
     ToMeasureEnd = "toMeasureEnd"
 }
+/** Anchor point enum for connectives (ties, slurs, slides). */
 declare enum NoteAnchor {
+    /** Automatically choose anchor point using simple logic. */
     Auto = "auto",
+    /** Anchor connective above note head. */
     Above = "above",
+    /** Anchor connective center/next to note head.*/
     Center = "center",
+    /** Anchor connective below note head. */
     Below = "below",
+    /** Anchor connective to stem tip. */
     StemTip = "stemTip"
 }
+/** Connective enum. */
 declare enum Connective {
+    /** Tie, connects two or more adjacent notes of same pitch with arc. */
     Tie = "tie",
+    /** Slur, connects two or more adjacent notes of different pitch with arc. */
     Slur = "slur",
+    /** Slide, connects two adjacent notes of different pitch with straight line. */
     Slide = "slide"
 }
+/** Vertical position enum used to layout notation elements. */
 declare enum VerticalPosition {
+    /** Automatic/default layout position depending on element. */
     Auto = "auto",
+    /** Add  element above staff/tab. */
     Above = "above",
+    /** Add element below staff/tab. */
     Below = "below",
+    /** Add element both above and below staff/tab. */
     Both = "both"
 }
+/** Staff/tab/group type can be staff/tab index or staff/tab/group name. */
 type StaffTabOrGroup = number | string;
+/** Staff/tab/group snglevalue or array of values. */
 type StaffTabOrGroups = StaffTabOrGroup | StaffTabOrGroup[];
+/** Options for notes/chords. */
 type NoteOptions = {
+    /** Stem direction. */
     stem?: Stem | `${Stem}`;
+    /** Set color. */
     color?: string;
+    /** Arepggio direction for chords. true = "up". */
     arpeggio?: boolean | Arpeggio | `${Arpeggio}`;
+    /** Add staccato dot. */
     staccato?: boolean;
+    /** Use diamond shaped note head. */
     diamond?: boolean;
+    /** Set string number (array of numbers for chord) to use in guitar tab. */
     string?: StringNumber | StringNumber[];
     /** @deprecated - Use triplet NoteLength values instead, e.g. NoteLength.QuarterTriplet or "4t", etc. */
     triplet?: boolean;
     /** @deprecated - Use dotted NoteLength values instead, e.g. NoteLength.Quarter2Dots or "4..", etc. */
     dotted?: boolean | number;
 };
+/** Options for rests. */
 type RestOptions = {
+    /** Set staff position for this rest. Can be instance of Note, string (e.g. "C3"), or midiNumber. */
     staffPos?: Note | string | number;
+    /** Set color. */
     color?: string;
+    /** Hide this rest, still affects playing. */
     hide?: boolean;
     /** @deprecated - Use triplet NoteLength values instead, e.g. NoteLength.QuarterTriplet or "4t", etc. */
     triplet?: boolean;
     /** @deprecated - Use dotted NoteLength values instead, e.g. NoteLength.Quarter2Dots or "4..", etc. */
     dotted?: boolean | number;
 };
+/** Tuplet options. */
 type TupletOptions = {
+    /** Show tuplet ratio (e.g. "3:2") instead of number of parts (e.g. "3"). */
     showRatio?: boolean;
 };
+/** Fermata enum. */
 declare enum Fermata {
+    /** Anchor fermata to note/rest. */
     AtNote = "atNote",
+    /** Anchor fermata to measure end. */
     AtMeasureEnd = "atMeasureEnd"
 }
+/** Navigation element enum. */
 declare enum Navigation {
     /** Repeat back to beginning and play to the "Fine" marking. */
     DC_al_Fine = "D.C. al Fine",
@@ -321,23 +393,53 @@ declare enum Navigation {
     /** Jump to ending with correct passage number. */
     Ending = "ending"
 }
+/** Annotation element enum. */
 declare enum Annotation {
     /** "ppp", "pp", "p", "mp", "m", "mf", "f", "ff", "fff", "cresc.", "decresc.", "dim." */
     Dynamics = "dynamics",
     /** "accel.", "rit.", "a tempo" */
     Tempo = "tempo"
 }
+/** Some known dynamics annotations. */
+declare enum DynamicsAnnotation {
+    cresc = "cresc.",
+    decresc = "decresc.",
+    dim = "dim.",
+    ppp = "ppp",
+    pp = "pp",
+    p = "p",
+    mp = "mp",
+    m = "m",
+    mf = "mf",
+    f = "f",
+    ff = "ff",
+    fff = "fff"
+}
+/** Some known tempo annotations. */
+declare enum TempoAnnotation {
+    accel = "accel.",
+    rit = "rit.",
+    a_tempo = "a tempo"
+}
+/** Known annotation test type. */
+type AnnotationText = `${DynamicsAnnotation}` | `${TempoAnnotation}`;
+/** Label element enum. */
 declare enum Label {
     /** "C", "C#", "Db", "D", etc. */
     Note = "note",
     /** "C", "Am", "G7", etc. */
     Chord = "chord"
 }
+/** Play state enum. */
 declare enum PlayState {
+    /** Playing. */
     Playing = 0,
+    /** Paused. */
     Paused = 1,
+    /** Stopped. */
     Stopped = 2
 }
+/** Play state change listener type. */
 type PlayStateChangeListener = (playState: PlayState) => void;
 
 declare class AccidentalState {
@@ -958,7 +1060,7 @@ declare class ObjMeasure extends MusicObject {
     setKeySignature(...args: unknown[]): void;
     updateKeySignature(): void;
     getTimeSignature(): TimeSignature;
-    setTimeSignature(timeSignature: TimeSignature | TimeSignatureString): void;
+    setTimeSignature(timeSignature: TimeSignature): void;
     updateTimeSignature(): void;
     getTempo(): Tempo;
     setTempo(beatsPerMinute: number, beatLength?: NoteLength | NoteLengthStr, dotted?: boolean | number): void;
@@ -1458,350 +1560,750 @@ declare class ObjSignature extends MusicObject {
     draw(renderer: Renderer): void;
 }
 
+/** Score event type. */
 type ScoreEventType = "enter" | "leave" | "click";
+/** Abstract score event class. */
 declare abstract class ScoreEvent {
     readonly type: ScoreEventType;
+    /**
+     * Create new score event instance.
+     * @param type - Score event type.
+     */
     constructor(type: ScoreEventType);
 }
+/** Score staff position event for clicking/entering/leaving staff position (diatonic id) in staff notation line. */
 declare class ScoreStaffPosEvent extends ScoreEvent {
     readonly renderer: MRenderer;
     readonly scoreRow: MScoreRow;
     readonly diatonicId: number;
+    /**
+     * Create new score staff position event.
+     * @param type - Score event type.
+     * @param renderer - Renderer.
+     * @param scoreRow - Score row.
+     * @param diatonicId - Diatonic id that was clicked/entered/left.
+     */
     constructor(type: ScoreEventType, renderer: MRenderer, scoreRow: MScoreRow, diatonicId: number);
 }
+/** Score object event for clicking/entering/leaving score object. */
 declare class ScoreObjectEvent extends ScoreEvent {
     readonly renderer: MRenderer;
     readonly objects: MusicInterface[];
+    /**
+     * Create new score object event.
+     * @param type - Score event type.
+     * @param renderer - Renderer.
+     * @param objects - Array of objects, last object in this array is the top object that was clicked/entered/left, previous objects are it's parent objects.
+     */
     constructor(type: ScoreEventType, renderer: MRenderer, objects: MusicInterface[]);
+    /** Top object getter. */
     get topObject(): MusicInterface;
+    /**
+     * Find object.
+     * @param fn - Compare function.
+     * @returns - First object that matched compare function, or undefined if no match.
+     */
     findObject(fn: (obj: MusicInterface) => boolean): MusicInterface | undefined;
 }
+/** Score event listener type. */
 type ScoreEventListener = (event: ScoreEvent) => void;
 
+/** Music player class. */
+declare class MPlayer {
+    private static currentlyPlaying;
+    private readonly player;
+    /**
+     * Create new music player.
+     * @param doc - Music document to play.
+     * @param playStateChangeListener - Play state change listener.
+     */
+    constructor(doc: MDocument, playStateChangeListener?: PlayStateChangeListener);
+    /**
+     * Stop all playing.
+     */
+    static stopAll(): void;
+    /**
+     * Playe attached document.
+     * @returns - This player instance.
+     */
+    play(): this;
+    /**
+     * Pause playback of attached document.
+     * @returns - This player instance.
+     */
+    pause(): this;
+    /**
+     * Stop playback of attached document.
+     * @returns - This player instance.
+     */
+    stop(): this;
+}
+/** Renderer class. */
+declare class MRenderer {
+    private readonly renderer;
+    /**
+     * Create new renderer instance.
+     */
+    constructor();
+    /**
+     * Attach music document to this renderer.
+     * @param doc - Music document.
+     * @returns - This renderer instance.
+     */
+    setDocument(doc?: MDocument): MRenderer;
+    /**
+     * Set target canvas html element for this renderer.
+     * @param canvas - HTML canvas element or element id.
+     * @returns - This renderer instance.
+     */
+    setCanvas(canvas: HTMLCanvasElement | string): MRenderer;
+    /**
+     * Set score event listener.
+     * @param scoreEventListener - Score event listener.
+     */
+    setScoreEventListener(scoreEventListener: ScoreEventListener): void;
+    /**
+     * Draw given music object hilighted.
+     * @param obj - Music object or undefined to remove hilighting.
+     */
+    hilightObject(obj?: MusicInterface): void;
+    /**
+     * Draw given staff position hilighted.
+     * @param staffPos - Staff position (score row and diatonic id) or undefined to remove hilighting.
+     */
+    hilightStaffPos(staffPos?: {
+        scoreRow: MScoreRow;
+        diatonicId: number;
+    }): void;
+    /**
+     * Draw contents of attached music document to attached canvas.
+     */
+    draw(): void;
+}
+/** Playback buttons helper class. */
+declare class MPlaybackButtons {
+    private playButton?;
+    private stopButton?;
+    private playStopButton?;
+    private pauseButton?;
+    private onPlay;
+    private onStop;
+    private onPlayStop;
+    private onPause;
+    private playLabel;
+    private stopLabel;
+    private pauseLabel;
+    private playState;
+    private player?;
+    /**
+     * Create new playback buttons helper class instance.
+     */
+    constructor();
+    /**
+     * Attach music document whose playcak will be controlled by this playback buttons helper class instance.
+     * @param doc - Music document.
+     * @returns
+     */
+    setDocument(doc?: MDocument): MPlaybackButtons;
+    /**
+     * Detach attached music document.
+     */
+    detachDocument(): void;
+    private updateButtons;
+    /**
+     * Set play button.
+     * @param btn - HTML button element or element id.
+     * @param btnLabel - Custom button label (e.g. "Play").
+     * @returns - This playback buttons class instance.
+     */
+    setPlayButton(btn: HTMLButtonElement | string, btnLabel?: string): MPlaybackButtons;
+    /**
+     * Set stop button.
+     * @param btn - HTML button element or element id.
+     * @param btnLabel - Custom button label (e.g. "Stop").
+     * @returns - This playback buttons class instance.
+     */
+    setStopButton(btn: HTMLButtonElement | string, btnLabel?: string): MPlaybackButtons;
+    /**
+     * Set play/stop button.
+     * @param btn - HTML button element or element id.
+     * @param playLabel - Custom button label for play action (e.g. "Play").
+     * @param stopLabel - Custom button label for stop action (e.g. "Stop").
+     * @returns - This playback buttons class instance.
+     */
+    setPlayStopButton(btn: HTMLButtonElement | string, playLabel?: string, stopLabel?: string): MPlaybackButtons;
+    /**
+     * Set pause button.
+     * @param btn - HTML button element or element id.
+     * @param btnLabel - Custom button label (e.g. "Pause").
+     * @returns - This playback buttons class instance.
+     */
+    setPauseButton(btn: HTMLButtonElement | string, btnLabel?: string): MPlaybackButtons;
+    private static savedOnClickListeners;
+    private static removeOnClickListeners;
+    private static addOnClickListener;
+}
+
+/** Abstract music interface object class. */
 declare abstract class MusicInterface {
     readonly name: string;
+    /**
+     * Create new music interface object.
+     * @param name - OBject name.
+     */
     constructor(name: string);
     /** @internal */
     abstract getMusicObject(): MusicObject;
+    /**
+     * Get parent object.
+     * @returns - Parent object or undefined.
+     */
     getParent(): MusicInterface | undefined;
 }
+/** Accidental object. */
 declare class MAccidental extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "Accidental";
     /** @internal */
     constructor(obj: ObjAccidental);
     /** @internal */
     getMusicObject(): ObjAccidental;
+    /**
+     * Get accidental.
+     * @returns - Accidental (e.g. 1 = #).
+     */
     getAccidental(): Accidental;
 }
+/** Connective object. */
 declare class MConnective extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "Connective";
     /** @internal */
     constructor(obj: ObjConnective);
     /** @internal */
     getMusicObject(): ObjConnective;
 }
+/** Arpeggio object. */
 declare class MArpeggio extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "Arpeggio";
     /** @internal */
     constructor(obj: ObjArpeggio);
     /** @internal */
     getMusicObject(): ObjArpeggio;
+    /**
+     * Get rhythm column this arpeggio is in.
+     * @returns - Rhythm column.
+     */
     getRhythmColumn(): MRhythmColumn;
+    /**
+     * Get notation line this arpeggio is in.
+     * @returns - Staff or tab object.
+     */
     getNotationLine(): MStaff | MTab;
 }
+/** Beam group object. */
 declare class MBeamGroup extends MusicInterface {
     private readonly obj;
+    /** OBject name. */
     static readonly Name = "BeamGroup";
     /** @internal */
     constructor(obj: ObjBeamGroup);
     /** @internal */
     getMusicObject(): ObjBeamGroup;
 }
+/** Beam group object of certain staff. */
 declare class MStaffBeamGroup extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "StaffBeamGroup";
     /** @internal */
     constructor(obj: ObjStaffBeamGroup);
     /** @internal */
     getMusicObject(): ObjStaffBeamGroup;
+    /**
+     * Get staff this beam group is in.
+     * @returns - Staff object.
+     */
     getStaff(): MStaff;
 }
+/** Document object. */
 declare class MDocument extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "Document";
     /** @internal */
     constructor(obj: ObjDocument);
     /** @internal */
     getMusicObject(): ObjDocument;
+    /**
+     * Get title.
+     * @returns - Title string or undefined.
+     */
     getTitle(): string | undefined;
+    /**
+     * Get composer.
+     * @returns - Composer string or undefined.
+     */
     getComposer(): string | undefined;
+    /**
+     * Get arranger.
+     * @returns - Arranger string or undefined.
+     */
     getArranger(): string | undefined;
+    /**
+     * Get score rows.
+     * @returns - Array or score rows.
+     */
     getRows(): ReadonlyArray<MScoreRow>;
+    /**
+     * Get measures.
+     * @returns - Array of measures.
+     */
     getMeasures(): ReadonlyArray<MMeasure>;
-    play(fn?: PlayStateChangeListener): MPlayer;
+    /**
+     * Play this document.
+     * @param playStateChangeListener - Play state change listener function or undefined.
+     * @returns - Player instance.
+     */
+    play(playStateChangeListener?: PlayStateChangeListener): MPlayer;
 }
+/** Ending object. */
 declare class MEnding extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "Ending";
     /** @internal */
     constructor(obj: ObjEnding);
     /** @internal */
     getMusicObject(): ObjEnding;
+    /**
+     * Get passages.
+     * @returns - Array of passage numbers, e.g. passage number 1 means that this ending is played on first pass.
+     */
     getPassages(): ReadonlyArray<number>;
+    /**
+     * Has passage number?
+     * @param passage - Passage number to find out.
+     * @returns - Boolean whether this ending has asked passage number.
+     */
     hasPassage(passage: number): boolean;
 }
+/** Fermata object. */
 declare class MFermata extends MusicInterface {
     private readonly obj;
+    /** OBject name. */
     static readonly Name = "Fermata";
     /** @internal */
     constructor(obj: ObjFermata);
     /** @internal */
     getMusicObject(): ObjFermata;
 }
+/** Header object. */
 declare class MHeader extends MusicInterface {
     private readonly obj;
+    /** OBject name. */
     static readonly Name = "Header";
     /** @internal */
     constructor(obj: ObjHeader);
     /** @internal */
     getMusicObject(): ObjHeader;
+    /**
+     * Get title.
+     * @returns - Title string or undefined.
+     */
     getTitle(): string | undefined;
+    /**
+     * Get composer.
+     * @returns - Composer string or undefined.
+     */
     getComposer(): string | undefined;
+    /**
+     * Get arranger.
+     * @returns - Arranger string or undefined.
+     */
     getArranger(): string | undefined;
 }
+/** Image object. */
 declare class MImage extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "Image";
     /** @internal */
     constructor(obj: ObjImage);
     /** @internal */
     getMusicObject(): ObjImage;
 }
+/** Measure object. */
 declare class MMeasure extends MusicInterface {
     private readonly obj;
+    /** OBject name. */
     static readonly Name = "Measure";
     /** @internal */
     constructor(obj: ObjMeasure);
     /** @internal */
     getMusicObject(): ObjMeasure;
+    /**
+     * Get measure number.
+     * @returns - Measure number starting from 1, or 0 if upbeat.
+     */
     getMeasureNumber(): number;
+    /**
+     * Get rhythm columns.
+     * @returns - Array of rhythm columns.
+     */
     getRhythmColumns(): ReadonlyArray<MRhythmColumn>;
+    /**
+     * Get score row that this measure is in.
+     * @returns - Score row.
+     */
     getRow(): MScoreRow;
 }
+/** Right bar line object. */
 declare class MBarLineRight extends MusicInterface {
     private readonly obj;
+    /** OBject name. */
     static readonly Name = "BarLineRight";
     /** @internal */
     constructor(obj: ObjBarLineRight);
     /** @internal */
     getMusicObject(): ObjBarLineRight;
 }
+/** Left bar line object. */
 declare class MBarLineLeft extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "BarLineLeft";
     /** @internal */
     constructor(obj: ObjBarLineLeft);
     /** @internal */
     getMusicObject(): ObjBarLineLeft;
 }
+/** Bar line object for certain staff or tab. */
 declare class MStaffTabBarLine extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "StaffTabBarLine";
     /** @internal */
     constructor(obj: ObjStaffTabBarLine);
     /** @internal */
     getMusicObject(): ObjStaffTabBarLine;
+    /**
+     * Get parent bar line object.
+     * @returns - Parent bar line object.
+     */
     getBarLine(): MBarLineLeft | MBarLineRight;
+    /**
+     * Get staff or tab this bar lien object is in.
+     * @returns - Staff or tab.
+     */
     getNotationLine(): MStaff | MTab;
 }
+/** Note group object. */
 declare class MNoteGroup extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "NoteGroup";
     /** @internal */
     constructor(obj: ObjNoteGroup);
     /** @internal */
     getMusicObject(): ObjNoteGroup;
+    /**
+     * Get notes of this note group.
+     * @returns - Array of Note instances.
+     */
     getNotes(): ReadonlyArray<Note>;
+    /**
+     * Get rhythm props of this note group.
+     * @returns - Rhythm props.
+     */
     getRhythmProps(): RhythmProps;
+    /**
+     * Get rhythm column this note group is in.
+     * @returns - Rhythm column.
+     */
     getRhythmColumn(): MRhythmColumn;
+    /**
+     * Get the measure this note group is in.
+     * @returns - Measure.
+     */
     getMeasure(): MMeasure;
 }
+/** Note group object of certain staff. */
 declare class MStaffNoteGroup extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "StaffNoteGroup";
     /** @internal */
     constructor(obj: ObjStaffNoteGroup);
     /** @internal */
     getMusicObject(): ObjStaffNoteGroup;
+    /**
+     * Get parent note group.
+     * @returns - Parent note group.
+     */
     getNoteGroup(): MNoteGroup;
+    /**
+     * Get rhythm column this note group is in.
+     * @returns - Rhythm column.
+     */
     getRhythmColumn(): MRhythmColumn;
+    /**
+     * Get the measure this note group is in.
+     * @returns - Measure.
+     */
     getMeasure(): MMeasure;
+    /**
+     * Get staff notation line this note group is in.
+     * @returns - Staff object.
+     */
     getStaff(): MStaff;
 }
+/** Note group object of certain tab. Contains fret numbers for tab. */
 declare class MTabNoteGroup extends MusicInterface {
     private readonly obj;
+    /** OBject name. */
     static readonly Name = "TabNoteGroup";
     /** @internal */
     constructor(obj: ObjTabNoteGroup);
     /** @internal */
     getMusicObject(): ObjTabNoteGroup;
+    /**
+     * Get parent note group.
+     * @returns - Parent note group.
+     */
     getNoteGroup(): MNoteGroup;
+    /**
+     * Get rhythm column this note group is in.
+     * @returns - Rhythm column.
+     */
     getRhythmColumn(): MRhythmColumn;
+    /**
+     * Get the measure this note group is in.
+     * @returns - Measure.
+     */
     getMeasure(): MMeasure;
+    /**
+     * Get guitar tab this note group is in.
+     * @returns - Tab object.
+     */
     getTab(): MTab;
 }
+/** Rest object. */
 declare class MRest extends MusicInterface {
     private readonly obj;
+    /** OBject name. */
     static readonly Name = "Rest";
     /** @internal */
     constructor(obj: ObjRest);
     /** @internal */
     getMusicObject(): ObjRest;
+    /**
+     * Get rhythm props of this rest.
+     * @returns - Rhythm props.
+     */
     getRhythmProps(): RhythmProps;
+    /**
+     * Get rhythm column this rest is in.
+     * @returns - Rhythm column.
+     */
     getRhythmColumn(): MRhythmColumn;
+    /**
+     * Get the measure this rest is in.
+     * @returns - Measure.
+     */
     getMeasure(): MMeasure;
 }
+/** Rest object for certain tab. */
 declare class MStaffRest extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "StaffRest";
     /** @internal */
     constructor(obj: ObjStaffRest);
     /** @internal */
     getMusicObject(): ObjStaffRest;
+    /**
+     * Get parent rest object.
+     * @returns - Parent rest object.
+     */
     getRest(): MRest;
+    /**
+     * Get rhythm column this rest is in.
+     * @returns - Rhythm column.
+     */
     getRhythmColumn(): MRhythmColumn;
+    /**
+     * Get the measure this rest is in.
+     * @returns - Measure.
+     */
     getMeasure(): MMeasure;
+    /**
+     * Get staff notation line this rest is in.
+     * @returns - Staff object.
+     */
     getStaff(): MStaff;
 }
+/** Rhythm column object. */
 declare class MRhythmColumn extends MusicInterface {
     private readonly obj;
+    /** OBject name. */
     static readonly Name = "RhythmColumn";
     /** @internal */
     constructor(obj: ObjRhythmColumn);
     /** @internal */
     getMusicObject(): ObjRhythmColumn;
+    /**
+     * Get symbol (note group or rest) of this column for given voice id.
+     * @param voiceId - Voice id.
+     * @returns - Note group, rest or undefined.
+     */
     getRhythmSymbol(voiceId: number): MNoteGroup | MRest | undefined;
-    getMeasure(): MMeasure;
+    /**
+     * Get symbol (note group or rest) of this column for given voice id.
+     * @deprecated - Use getRhythmSymbol(voiceId) instead.
+     * @param voiceId - Voice id.
+     * @returns - Note group, rest or undefined.
+     */
     getVoiceSymbol(voiceId: VoiceId): MNoteGroup | MRest | undefined;
+    /**
+     * Get the measure this rhythm column is in.
+     * @returns - Measure.
+     */
+    getMeasure(): MMeasure;
 }
+/** Score row object. */
 declare class MScoreRow extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "ScoreRow";
     /** @internal */
     constructor(obj: ObjScoreRow);
     /** @internal */
     getMusicObject(): ObjScoreRow;
+    /**
+     * Parent music document.
+     * @returns - Parent music document.
+     */
     getDocument(): MDocument;
+    /**
+     * Get measures of this score row.
+     * @returns - Array of measures.
+     */
     getMeasures(): ReadonlyArray<MMeasure>;
+    /**
+     * Get notation lines (staves and tabs) of this score row.
+     * @returns - Array of staves and tabs.
+     */
     getNotationLines(): ReadonlyArray<MStaff | MTab>;
 }
+/** Staff notatio line object. */
 declare class MStaff extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "Staff";
     /** @internal */
     constructor(obj: ObjStaff);
     /** @internal */
     getMusicObject(): ObjStaff;
+    /**
+     * Get index of this staff in score row.
+     * @returns - Index (0=top notation line).
+     */
     getId(): number;
+    /**
+     * Get name of this staff.
+     * @returns - Staff name.
+     */
     getName(): string | undefined;
+    /**
+     * Get the score row this staff is in.
+     * @returns - Score row.
+     */
     getRow(): MScoreRow;
 }
+/** Guitar tab notation line object. */
 declare class MTab extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "Tab";
     /** @internal */
     constructor(obj: ObjTab);
     /** @internal */
     getMusicObject(): ObjTab;
+    /**
+     * Get index of this guitar tab in score row.
+     * @returns - Index (0=top notation line).
+     */
     getId(): number;
+    /**
+     * Get name of this guitar tab.
+     * @returns - Staff name.
+     */
     getName(): string | undefined;
+    /**
+     * Get the score row this guitar tab is in.
+     * @returns - Score row.
+     */
     getRow(): MScoreRow;
 }
+/** Signature object contains clef, key signature, time signature and tempo, all optional depending on measure. */
 declare class MSignature extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "Signature";
     /** @internal */
     constructor(obj: ObjSignature);
     /** @internal */
     getMusicObject(): ObjSignature;
+    /**
+     * Get staff notation line this signature is in.
+     * @returns - Staff object.
+     */
     getStaff(): MStaff;
 }
+/** Spacial text object contains text and possibly special symbols (e.g. Segno or Coda). */
 declare class MSpecialText extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "SpecialText";
     /** @internal */
     constructor(obj: ObjSpecialText);
     /** @internal */
     getMusicObject(): ObjSpecialText;
+    /**
+     * Get text content.
+     * @returns - Text content.
+     */
     getText(): string;
 }
+/** Text object. */
 declare class MText extends MusicInterface {
     private readonly obj;
+    /** Object name. */
     static readonly Name = "Text";
     /** @internal */
     constructor(obj: ObjText);
     /** @internal */
     getMusicObject(): ObjText;
+    /**
+     * Get text content.
+     * @returns - Text content.
+     */
     getText(): string;
 }
+/** Extension line object. */
 declare class MExtensionLine extends MusicInterface {
     private readonly obj;
+    /** OBject name. */
     static readonly Name = "ExtensionLine";
     /** @internal */
     constructor(obj: ObjExtensionLine);
     /** @internal */
     getMusicObject(): ObjExtensionLine;
 }
-declare class MPlayer {
-    private static currentlyPlaying;
-    private readonly player;
-    constructor(doc: MDocument, fn?: PlayStateChangeListener);
-    static stopAll(): void;
-    play(): this;
-    pause(): this;
-    stop(): this;
-}
-declare class MRenderer {
-    private readonly renderer;
-    constructor();
-    setDocument(doc?: MDocument): this;
-    setCanvas(canvas: HTMLCanvasElement | string): this;
-    setScoreEventListener(fn: ScoreEventListener): void;
-    hilightObject(obj?: MusicInterface): void;
-    hilightStaffPos(staffPos?: {
-        scoreRow: MScoreRow;
-        diatonicId: number;
-    }): void;
-    draw(): void;
-}
-declare class MPlaybackButtons {
-    private playButton?;
-    private stopButton?;
-    private playStopButton?;
-    private pauseButton?;
-    private onPlay;
-    private onStop;
-    private onPlayStop;
-    private onPause;
-    private playLabel;
-    private stopLabel;
-    private pauseLabel;
-    private playState;
-    private player?;
-    constructor();
-    setDocument(doc?: MDocument): this;
-    detachDocument(): void;
-    private updateButtons;
-    setPlayButton(btn: HTMLButtonElement | string, btnLabel?: string): this;
-    setStopButton(btn: HTMLButtonElement | string, btnLabel?: string): this;
-    setPlayStopButton(btn: HTMLButtonElement | string, playLabel?: string, stopLabel?: string): this;
-    setPauseButton(btn: HTMLButtonElement | string, btnLabel?: string): this;
-    private static savedOnClickListeners;
-    private static removeOnClickListeners;
-    private static addOnClickListener;
-}
 
-export { type StaffConfig as $, Annotation as A, MStaffNoteGroup as B, Connective as C, DivRect as D, MTabNoteGroup as E, Fermata as F, MRest as G, MStaffRest as H, MRhythmColumn as I, MScoreRow as J, MStaff as K, Label as L, MDocument as M, type NoteOptions as N, MTab as O, MSignature as P, MSpecialText as Q, type RestOptions as R, StaffPreset as S, type TupletOptions as T, MText as U, type VoiceId as V, MExtensionLine as W, MPlayer as X, MRenderer as Y, MPlaybackButtons as Z, Clef as _, type ScoreConfiguration as a, type TabConfig as a0, getVoiceIds as a1, type StringNumber as a2, getStringNumbers as a3, Stem as a4, Arpeggio as a5, type StaffTabOrGroup as a6, PlayState as a7, type PlayStateChangeListener as a8, type StaffTabOrGroups as b, Navigation as c, TieType as d, NoteAnchor as e, VerticalPosition as f, type ScoreEventType as g, ScoreEvent as h, ScoreStaffPosEvent as i, ScoreObjectEvent as j, type ScoreEventListener as k, MusicInterface as l, MAccidental as m, MConnective as n, MArpeggio as o, MBeamGroup as p, MStaffBeamGroup as q, MEnding as r, MFermata as s, MHeader as t, MImage as u, MMeasure as v, MBarLineRight as w, MBarLineLeft as x, MStaffTabBarLine as y, MNoteGroup as z };
+export { Clef as $, type AnnotationText as A, MBarLineRight as B, Connective as C, DivRect as D, MBarLineLeft as E, Fermata as F, MStaffTabBarLine as G, MNoteGroup as H, MStaffNoteGroup as I, MTabNoteGroup as J, MRest as K, Label as L, MDocument as M, type NoteOptions as N, MStaffRest as O, MRhythmColumn as P, MScoreRow as Q, type RestOptions as R, StaffPreset as S, type TupletOptions as T, MStaff as U, type VoiceId as V, MTab as W, MSignature as X, MSpecialText as Y, MText as Z, MExtensionLine as _, type ScoreConfiguration as a, type StaffConfig as a0, type TabConfig as a1, getVoiceIds as a2, type StringNumber as a3, getStringNumbers as a4, Stem as a5, Arpeggio as a6, type StaffTabOrGroup as a7, DynamicsAnnotation as a8, TempoAnnotation as a9, PlayState as aa, type PlayStateChangeListener as ab, type StaffTabOrGroups as b, Navigation as c, Annotation as d, TieType as e, NoteAnchor as f, VerticalPosition as g, type ScoreEventType as h, ScoreEvent as i, ScoreStaffPosEvent as j, ScoreObjectEvent as k, type ScoreEventListener as l, MPlayer as m, MRenderer as n, MPlaybackButtons as o, MusicInterface as p, MAccidental as q, MConnective as r, MArpeggio as s, MBeamGroup as t, MStaffBeamGroup as u, MEnding as v, MFermata as w, MHeader as x, MImage as y, MMeasure as z };