@coderline/alphatab 1.7.1 → 1.8.0-alpha.1636

package/dist/alphaTab.d.ts

@@ -217,12 +217,19 @@ declare class AlphaSynthBase implements IAlphaSynth {
 declare class AlphaSynthMidiFileHandler implements IMidiFileHandler {
     private _midiFile;
     private _smf1Mode;
+    /**
+     * An indicator by how many midi-ticks the song contents are shifted.
+     * Grace beats at start might require a shift for the first beat to start at 0.
+     * This information can be used to translate back the player time axis to the music notation.
+     */
+    tickShift: number;
     /**
      * Initializes a new instance of the {@link AlphaSynthMidiFileHandler} class.
      * @param midiFile The midi file.
      * @param smf1Mode Whether to generate a SMF1 compatible midi file. This might break multi note bends.
      */
     constructor(midiFile: MidiFile, smf1Mode?: boolean);
+    addTickShift(tickShift: number): void;
     addTimeSignature(tick: number, timeSignatureNumerator: number, timeSignatureDenominator: number): void;
     addRest(track: number, tick: number, channel: number): void;
     addNote(track: number, start: number, length: number, key: number, velocity: number, channel: number): void;
@@ -356,6 +363,12 @@ export declare class AlphaTabApiBase<TSettings> {
     private _actualPlayerMode;
     private _player;
     private _renderer;
+    /**
+     * An indicator by how many midi-ticks the song contents are shifted.
+     * Grace beats at start might require a shift for the first beat to start at 0.
+     * This information can be used to translate back the player time axis to the music notation.
+     */
+    get midiTickShift(): number;
     /**
      * The actual player mode which is currently active.
      * @remarks
@@ -3744,6 +3757,7 @@ declare class AlphaTexParser {
     private _beatMultiplier;
     private _noteList;
     private _note;
+    private static readonly _allowValuesAfterProperties;
     private _metaData;
     private _properties;
     private _property;
@@ -6106,6 +6120,7 @@ export declare class DisplaySettings {
      * @remarks
      * AlphaTab has various stave profiles that define which staves will be shown in for the rendered tracks. Its recommended
      * to keep this on {@link StaveProfile.Default} and rather rely on the options available ob {@link Staff} level
+     * @deprecated Set the notation visibility by modifying the {@link Staff} properties.
      */
     staveProfile: StaveProfile;
     /**
@@ -6221,7 +6236,7 @@ export declare class DisplaySettings {
      * The top padding applied to first system.
      * @since 1.4.0
      * @category Display
-     * @defaultValue `5`
+     * @defaultValue `0`
      */
     firstSystemPaddingTop: number;
     /**
@@ -6235,14 +6250,14 @@ export declare class DisplaySettings {
      * The bottom padding applied to systems beside the last one.
      * @since 1.4.0
      * @category Display
-     * @defaultValue `20`
+     * @defaultValue `10`
      */
     systemPaddingBottom: number;
     /**
      * The bottom padding applied to the last system.
      * @since 1.4.0
      * @category Display
-     * @defaultValue `0`
+     * @defaultValue `5`
      */
     lastSystemPaddingBottom: number;
     /**
@@ -6267,17 +6282,31 @@ export declare class DisplaySettings {
      */
     accoladeBarPaddingRight: number;
     /**
-     * The bottom padding applied to main notation staves (standard, tabs, numbered, slash).
+     * The top padding applied to the first main notation staff (standard, tabs, numbered, slash).
+     * @since 1.8.0
+     * @category Display
+     * @defaultValue `0`
+     */
+    firstNotationStaffPaddingTop: number;
+    /**
+     * The bottom padding applied to last main notation staff (standard, tabs, numbered, slash).
+     * @since 1.8.0
+     * @category Display
+     * @defaultValue `0`
+     */
+    lastNotationStaffPaddingBottom: number;
+    /**
+     * The top padding applied to main notation staves (standard, tabs, numbered, slash).
      * @since 1.4.0
      * @category Display
-     * @defaultValue `5`
+     * @defaultValue `0`
      */
     notationStaffPaddingTop: number;
     /**
      * The bottom padding applied to main notation staves (standard, tabs, numbered, slash).
      * @since 1.4.0
      * @category Display
-     * @defaultValue `5`
+     * @defaultValue `0`
      */
     notationStaffPaddingBottom: number;
     /**
@@ -6285,6 +6314,8 @@ export declare class DisplaySettings {
      * @since 1.4.0
      * @category Display
      * @defaultValue `0`
+     * @deprecated Effect staves do not exist anymore, effects are now part of the main notation staves. This value has no effect anymore.
+     * Use {@link effectBandPaddingBottom} to control the padding after effect bands.
      */
     effectStaffPaddingTop: number;
     /**
@@ -6292,6 +6323,8 @@ export declare class DisplaySettings {
      * @since 1.4.0
      * @category Display
      * @defaultValue `0`
+     * @deprecated Effect staves do not exist anymore, effects are now part of the main notation staves. This value has no effect anymore.
+     * Use {@link effectBandPaddingBottom} to control the padding after effect bands.
      */
     effectStaffPaddingBottom: number;
     /**
@@ -6315,6 +6348,13 @@ export declare class DisplaySettings {
      * @defaultValue `2`
      */
     effectBandPaddingBottom: number;
+    /**
+     * The additional padding to apply between the staves of two separate tracks.
+     * @since 1.8.0
+     * @category Display
+     * @defaultValue `5`
+     */
+    trackStaffPaddingBetween: number;
     /**
      * The mode used to arrange staves and systems.
      * @since 1.3.0
@@ -6431,6 +6471,7 @@ declare interface DisplaySettingsJson {
      * @remarks
      * AlphaTab has various stave profiles that define which staves will be shown in for the rendered tracks. Its recommended
      * to keep this on {@link StaveProfile.Default} and rather rely on the options available ob {@link Staff} level
+     * @deprecated Set the notation visibility by modifying the {@link Staff} properties.
      */
     staveProfile?: StaveProfile | keyof typeof StaveProfile | Lowercase<keyof typeof StaveProfile>;
     /**
@@ -6546,7 +6587,7 @@ declare interface DisplaySettingsJson {
      * The top padding applied to first system.
      * @since 1.4.0
      * @category Display
-     * @defaultValue `5`
+     * @defaultValue `0`
      */
     firstSystemPaddingTop?: number;
     /**
@@ -6560,14 +6601,14 @@ declare interface DisplaySettingsJson {
      * The bottom padding applied to systems beside the last one.
      * @since 1.4.0
      * @category Display
-     * @defaultValue `20`
+     * @defaultValue `10`
      */
     systemPaddingBottom?: number;
     /**
      * The bottom padding applied to the last system.
      * @since 1.4.0
      * @category Display
-     * @defaultValue `0`
+     * @defaultValue `5`
      */
     lastSystemPaddingBottom?: number;
     /**
@@ -6592,17 +6633,31 @@ declare interface DisplaySettingsJson {
      */
     accoladeBarPaddingRight?: number;
     /**
-     * The bottom padding applied to main notation staves (standard, tabs, numbered, slash).
+     * The top padding applied to the first main notation staff (standard, tabs, numbered, slash).
+     * @since 1.8.0
+     * @category Display
+     * @defaultValue `0`
+     */
+    firstNotationStaffPaddingTop?: number;
+    /**
+     * The bottom padding applied to last main notation staff (standard, tabs, numbered, slash).
+     * @since 1.8.0
+     * @category Display
+     * @defaultValue `0`
+     */
+    lastNotationStaffPaddingBottom?: number;
+    /**
+     * The top padding applied to main notation staves (standard, tabs, numbered, slash).
      * @since 1.4.0
      * @category Display
-     * @defaultValue `5`
+     * @defaultValue `0`
      */
     notationStaffPaddingTop?: number;
     /**
      * The bottom padding applied to main notation staves (standard, tabs, numbered, slash).
      * @since 1.4.0
      * @category Display
-     * @defaultValue `5`
+     * @defaultValue `0`
      */
     notationStaffPaddingBottom?: number;
     /**
@@ -6610,6 +6665,8 @@ declare interface DisplaySettingsJson {
      * @since 1.4.0
      * @category Display
      * @defaultValue `0`
+     * @deprecated Effect staves do not exist anymore, effects are now part of the main notation staves. This value has no effect anymore.
+     * Use {@link effectBandPaddingBottom} to control the padding after effect bands.
      */
     effectStaffPaddingTop?: number;
     /**
@@ -6617,6 +6674,8 @@ declare interface DisplaySettingsJson {
      * @since 1.4.0
      * @category Display
      * @defaultValue `0`
+     * @deprecated Effect staves do not exist anymore, effects are now part of the main notation staves. This value has no effect anymore.
+     * Use {@link effectBandPaddingBottom} to control the padding after effect bands.
      */
     effectStaffPaddingBottom?: number;
     /**
@@ -6640,6 +6699,13 @@ declare interface DisplaySettingsJson {
      * @defaultValue `2`
      */
     effectBandPaddingBottom?: number;
+    /**
+     * The additional padding to apply between the staves of two separate tracks.
+     * @since 1.8.0
+     * @category Display
+     * @defaultValue `5`
+     */
+    trackStaffPaddingBetween?: number;
     /**
      * The mode used to arrange staves and systems.
      * @since 1.3.0
@@ -7193,6 +7259,11 @@ export declare class EngravingSettings {
      * The size of the dashes on bends (e.g. on holds)
      */
     tabBendDashSize: number;
+    /**
+     * The additional padding between the staff and the point
+     * where bend values are calculated from.
+     */
+    tabBendStaffPadding: number;
     /**
      * The height applied per quarter-note.
      */
@@ -7580,6 +7651,11 @@ declare interface EngravingSettingsJson {
      * The size of the dashes on bends (e.g. on holds)
      */
     tabBendDashSize?: number;
+    /**
+     * The additional padding between the staff and the point
+     * where bend values are calculated from.
+     */
+    tabBendStaffPadding?: number;
     /**
      * The height applied per quarter-note.
      */
@@ -7710,13 +7786,6 @@ declare interface EngravingStemInfoJson {
  * @public
  */
 export declare class Environment {
-    private static readonly _staffIdBeforeSlashAlways;
-    private static readonly _staffIdBeforeScoreAlways;
-    private static readonly _staffIdBeforeScoreHideable;
-    private static readonly _staffIdBeforeNumberedAlways;
-    private static readonly _staffIdBeforeTabAlways;
-    private static readonly _staffIdBeforeTabHideable;
-    private static readonly _staffIdBeforeEndAlways;
 
     /**
      * @target web
@@ -7800,7 +7869,7 @@ export declare class Environment {
      * @partial
      */
     private static _createPlatformSpecificRenderEngines;
-    private static _createDefaultRenderers;
+
     private static _createDefaultStaveProfiles;
     private static _createDefaultLayoutEngines;
     /**
@@ -9051,6 +9120,12 @@ declare interface IMidiFileHandler {
      * @param tick The end tick for this track.
      */
     finishTrack(track: number, tick: number): void;
+    /**
+     * Registers a general shift of the time-axis for the generate midi file.
+     * @param tickShift The shift in midi ticks by which all midi events beside the initial channel setups are shifted.
+     * This shift is applied in case grace beats
+     */
+    addTickShift(tickShift: number): void;
 }
 
 /**
@@ -10608,6 +10683,12 @@ declare class MidiFile {
      * Gets or sets the division per quarter notes.
      */
     division: number;
+    /**
+     * An indicator by how many midi-ticks the song contents are shifted.
+     * Grace beats at start might require a shift for the first beat to start at 0.
+     * This information can be used to translate back the player time axis to the music notation.
+     */
+    tickShift: number;
     /**
      * Gets a list of midi events sorted by time.
      */
@@ -10690,6 +10771,7 @@ declare class MidiFileGenerator {
      * Starts the generation of the midi file.
      */
     generate(): void;
+    private _detectTickShift;
     private _generateTrack;
     private _addProgramChange;
     private _addBankChange;
@@ -11562,7 +11644,11 @@ export declare enum NotationElement {
     /**
      * The absolute playback time of beats.
      */
-    EffectBeatTimer = 49
+    EffectBeatTimer = 49,
+    /**
+     * The whammy bar line effect shown above the tab staff
+     */
+    EffectWhammyBarLine = 50
 }
 
 /**
@@ -11722,7 +11808,7 @@ export declare class NotationSettings {
      * Controls how high the ryhthm notation is rendered below the tab staff
      * @since 0.9.6
      * @category Notation
-     * @defaultValue `15`
+     * @defaultValue `25`
      * @remarks
      * This setting can be used in combination with the {@link rhythmMode} setting to control how high the rhythm notation should be rendered below the tab staff.
      */
@@ -11935,7 +12021,7 @@ declare interface NotationSettingsJson {
      * Controls how high the ryhthm notation is rendered below the tab staff
      * @since 0.9.6
      * @category Notation
-     * @defaultValue `15`
+     * @defaultValue `25`
      * @remarks
      * This setting can be used in combination with the {@link rhythmMode} setting to control how high the rhythm notation should be rendered below the tab staff.
      */
@@ -13981,6 +14067,10 @@ declare class RenderStylesheet {
      * If single track: Whether to render multiple subsequent empty (or rest-only) bars together as multi-bar rest.
      */
     perTrackMultiBarRest: Set<number> | null;
+    /**
+     * Whether barlines should be drawn across staves within the same system.
+     */
+    extendBarLines: boolean;
 }
 
 /**