@coderline/alphatab 1.3.0-alpha.848 → 1.3.0-alpha.854

package/dist/alphaTab.d.ts

@@ -2399,6 +2399,7 @@ declare class Note {
     get isStringed(): boolean;
     /**
      * Gets or sets the fret on which this note is played on the instrument.
+     * 0 is the nut.
      */
     fret: number;
     /**
@@ -2716,6 +2717,13 @@ declare class Note {
     static getStringTuning(staff: Staff, noteString: number): number;
     get realValue(): number;
     get realValueWithoutHarmonic(): number;
+    /**
+     * Calculates the real note value of this note as midi key respecting the given options.
+     * @param applyTranspositionPitch Whether or not to apply the transposition pitch of the current staff.
+     * @param applyHarmonic Whether or not to apply harmonic pitches to the note.
+     * @returns The calculated note value as midi key.
+     */
+    calculateRealValue(applyTranspositionPitch: boolean, applyHarmonic: boolean): number;
     get harmonicPitch(): number;
     get initialBendValue(): number;
     get displayValue(): number;
@@ -4954,25 +4962,25 @@ declare enum ControllerType {
  * Lists all midi event types. Based on the type the instance is a specific subclass.
  */
 declare enum MidiEventType {
-    TimeSignature = 88,
-    NoteOn = 128,
-    NoteOff = 144,
-    ControlChange = 176,
-    ProgramChange = 192,
-    TempoChange = 81,
-    PitchBend = 224,
-    PerNotePitchBend = 96,
-    EndOfTrack = 47,
-    AlphaTabRest = 241,
-    AlphaTabMetronome = 242,
+    TimeSignature = 88,// 0xFF _0x58_ in Midi 1.0
+    NoteOn = 128,// Aligned with Midi 1.0
+    NoteOff = 144,// Aligned with Midi 1.0
+    ControlChange = 176,// Aligned with Midi 1.0
+    ProgramChange = 192,// Aligned with Midi 1.0
+    TempoChange = 81,// 0xFF _0x51_ in Midi 1.0 
+    PitchBend = 224,// Aligned with Midi 1.0
+    PerNotePitchBend = 96,// Aligned with Midi 2.0
+    EndOfTrack = 47,// 0xFF _0x2F_ in Midi 1.0
+    AlphaTabRest = 241,// SystemExclusive + 1 
+    AlphaTabMetronome = 242,// SystemExclusive + 2
     /**
      * @deprecated Not used anymore internally. move to the other concrete types.
      */
-    SystemExclusive = 240,
+    SystemExclusive = 240,// Aligned with Midi 1.0
     /**
      * @deprecated Not used anymore internally. move to the other concrete types.
      */
-    SystemExclusive2 = 247,
+    SystemExclusive2 = 247,// Aligned with Midi 1.0
     /**
      * @deprecated Not used anymore internally. move to the other concrete types.
      */
@@ -5992,6 +6000,11 @@ interface IAlphaSynth {
      * @param midi
      */
     loadMidiFile(midi: MidiFile): void;
+    /**
+     * Applies the given transposition pitches to be used during playback.
+     * @param transpositionPitches a map defining the transposition pitches for midi channel.
+     */
+    applyTranspositionPitches(transpositionPitches: Map<number, number>): void;
     /**
      * Sets the mute state of a channel.
      * @param channel The channel number
@@ -6817,6 +6830,14 @@ declare class MidiFileGenerator {
      * at a given midi tick position.
      */
     readonly tickLookup: MidiTickLookup;
+    /**
+     * Gets or sets whether transposition pitches should be applied to the individual midi events or not.
+     */
+    applyTranspositionPitches: boolean;
+    /**
+     * Gets the transposition pitches for the individual midi channels.
+     */
+    readonly transpositionPitches: Map<number, number>;
     /**
      * Initializes a new instance of the {@link MidiFileGenerator} class.
      * @param score The score for which the midi file should be generated.
@@ -6830,6 +6851,7 @@ declare class MidiFileGenerator {
     generate(): void;
     private generateTrack;
     private addProgramChange;
+    static buildTranspositionPitches(score: Score, settings: Settings): Map<number, number>;
     private generateChannel;
     private static toChannelShort;
     private generateMasterBar;
@@ -7186,6 +7208,7 @@ declare class AlphaSynth implements IAlphaSynth {
      * @param midi The midi file to load
      */
     loadMidiFile(midi: MidiFile): void;
+    applyTranspositionPitches(transpositionPitches: Map<number, number>): void;
     setChannelMute(channel: number, mute: boolean): void;
     resetChannelStates(): void;
     setChannelSolo(channel: number, solo: boolean): void;
@@ -7300,6 +7323,7 @@ declare class AlphaSynthWebWorkerApi implements IAlphaSynth {
     loadSoundFontFromUrl(url: string, append: boolean, progress: (e: ProgressEventArgs) => void): void;
     resetSoundFonts(): void;
     loadMidiFile(midi: MidiFile): void;
+    applyTranspositionPitches(transpositionPitches: Map<number, number>): void;
     setChannelMute(channel: number, mute: boolean): void;
     resetChannelStates(): void;
     setChannelSolo(channel: number, solo: boolean): void;