@coderline/alphatab 1.6.0-alpha.1416 → 1.6.0-alpha.1420

package/dist/alphaTab.d.ts

@@ -192,7 +192,8 @@ declare class AlphaSynthBase implements IAlphaSynth {
     readonly playbackRangeChanged: IEventEmitterOfT<PlaybackRangeChangedEventArgs>;
     /* Excluded from this release type: hasSamplesForProgram */
     /* Excluded from this release type: hasSamplesForPercussion */
-    loadBackingTrack(_score: Score, _syncPoints: BackingTrackSyncPoint[]): void;
+    loadBackingTrack(_score: Score): void;
+    updateSyncPoints(_syncPoints: BackingTrackSyncPoint[]): void;
 }
 
 /**
@@ -350,6 +351,7 @@ declare class AlphaSynthWebWorkerApi implements IAlphaSynth {
     onOutputSamplesPlayed(samples: number): void;
     private onOutputReady;
     loadBackingTrack(_score: Score): void;
+    updateSyncPoints(_syncPoints: BackingTrackSyncPoint[]): void;
 }
 
 /**
@@ -1399,6 +1401,12 @@ export declare class AlphaTabApiBase<TSettings> {
      * @since 1.6.0
      */
     loadMidiForScore(): void;
+    /**
+     * Triggers an update of the sync points for the current score after modification within the data model
+     * @category Methods - Player
+     * @since 1.6.0
+     */
+    updateSyncPoints(): void;
     /**
      * Changes the volume of the given tracks.
      * @param tracks The tracks for which the volume should be changed.
@@ -3078,11 +3086,6 @@ declare class BackingTrack {
      * @json_ignore
      */
     rawAudioFile: Uint8Array | undefined;
-    /**
-     * The number of milliseconds the audio should be shifted to align with the song.
-     * (e.g. negative values allow skipping potential silent parts at the start of the file and directly start with the first note).
-     */
-    padding: number;
 }
 
 /**
@@ -3094,9 +3097,12 @@ declare class BackingTrackSyncPoint {
     constructor(tick: number, data: SyncPointData);
 }
 
-declare class BackingTrackSyncPointWithTime extends BackingTrackSyncPoint {
-    time: number;
-    constructor(tick: number, data: SyncPointData, time: number);
+declare class BackingTrackSyncPointWithTime {
+    alphaTabTick: number;
+    alphaTabTime: number;
+    modifiedTempo: number;
+    millisecondOffset: number;
+    constructor(tick: number, time: number, modifiedTempo: number, millisecondOffset: number);
 }
 
 /**
@@ -4975,12 +4981,34 @@ export declare class CoreSettings {
      * where the Web Font files of [Bravura](https://github.com/steinbergmedia/bravura) are. Normally alphaTab expects
      * them to be in a `font` subfolder beside the script file. If this is not the case, this setting must be used to configure the path.
      * Alternatively also a global variable `ALPHATAB_FONT` can be set on the page before initializing alphaTab.
+     *
+     * Use {@link smuflFontSources} for more flexible font configuration.
      * @defaultValue `"${AlphaTabScriptFolder}/font/"`
      * @category Core - JavaScript Specific
      * @target web
      * @since 0.9.6
      */
     fontDirectory: string | null;
+    /**
+     * Defines the URLs from which to load the SMuFL compliant font files.
+     * @remarks
+     * These sources will be used to load and register the webfonts on the page so
+     * they are available for rendering the music sheet. The sources can be set to any
+     * CSS compatible URL which can be passed into `url()`.
+     * See https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src#url
+     * @defaultValue Bravura files located at {@link fontDirectory} .
+     * @category Core - JavaScript Specific
+     * @target web
+     * @since 1.6.0
+     */
+    smuflFontSources: Map<FontFileFormat, string> | null;
+    /**
+     * Builds the default SMuFL font sources for the usage with alphaTab in cases
+     * where no custom {@link smuflFontSources} are provided.
+     * @param fontDirectory The {@link fontDirectory} configured.
+     * @target web
+     */
+    static buildDefaultSmuflFontSources(fontDirectory: string | null): Map<FontFileFormat, string>;
     /**
      * The full URL to the input file to be loaded.
      * @remarks
@@ -5129,12 +5157,27 @@ declare interface CoreSettingsJson {
      * where the Web Font files of [Bravura](https://github.com/steinbergmedia/bravura) are. Normally alphaTab expects
      * them to be in a `font` subfolder beside the script file. If this is not the case, this setting must be used to configure the path.
      * Alternatively also a global variable `ALPHATAB_FONT` can be set on the page before initializing alphaTab.
+     *
+     * Use {@link smuflFontSources} for more flexible font configuration.
      * @defaultValue `"${AlphaTabScriptFolder}/font/"`
      * @category Core - JavaScript Specific
      * @target web
      * @since 0.9.6
      */
     fontDirectory?: string | null;
+    /**
+     * Defines the URLs from which to load the SMuFL compliant font files.
+     * @remarks
+     * These sources will be used to load and register the webfonts on the page so
+     * they are available for rendering the music sheet. The sources can be set to any
+     * CSS compatible URL which can be passed into `url()`.
+     * See https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src#url
+     * @defaultValue Bravura files located at {@link fontDirectory} .
+     * @category Core - JavaScript Specific
+     * @target web
+     * @since 1.6.0
+     */
+    smuflFontSources?: Map<FontFileFormat | keyof typeof FontFileFormat | Lowercase<keyof typeof FontFileFormat>, string>;
     /**
      * The full URL to the input file to be loaded.
      * @remarks
@@ -6177,7 +6220,6 @@ export declare class Environment {
     private static readonly StaffIdBeforeEndAlways;
     /* Excluded from this release type: MusicFontSize */
     /* Excluded from this release type: HighDpiFactor */
-    /* Excluded from this release type: createStyleElement */
     /**
      * @target web
      */
@@ -6203,7 +6245,6 @@ export declare class Environment {
      * @target web
      */
     static readonly fontDirectory: string | null;
-    /* Excluded from this release type: bravuraFontChecker */
     /**
      * @target web
      */
@@ -6506,8 +6547,39 @@ declare class Font {
      */
     static withFamilyList(families: string[], size: number, style?: FontStyle, weight?: FontWeight): Font;
     toCssString(scale?: number): string;
-    static fromJson(v: unknown): Font | null;
-    static toJson(font: Font): Map<string, unknown>;
+    static fromJson(v: unknown): Font | undefined;
+    static toJson(font: Font | undefined): Map<string, unknown> | undefined;
+}
+
+/**
+ * Lists the known file formats for font files.
+ * @target web
+ */
+export declare enum FontFileFormat {
+    /**
+     * .eot
+     */
+    EmbeddedOpenType = 0,
+    /**
+     * .woff
+     */
+    Woff = 1,
+    /**
+     * .woff2
+     */
+    Woff2 = 2,
+    /**
+     * .otf
+     */
+    OpenType = 3,
+    /**
+     * .ttf
+     */
+    TrueType = 4,
+    /**
+     * .svg
+     */
+    Svg = 5
 }
 
 /**
@@ -6522,21 +6594,6 @@ declare type FontJson = Font | string | {
     weight: FontWeight | keyof typeof FontWeight;
 };
 
-/**
- * This small utility helps to detect whether a particular font is already loaded.
- * @target web
- */
-declare class FontLoadingChecker {
-    private _originalFamilies;
-    private _families;
-    private _isStarted;
-    isFontLoaded: boolean;
-    fontLoaded: IEventEmitterOfT<string>;
-    constructor(families: string[]);
-    checkForFontAvailability(): void;
-    private isFontAvailable;
-}
-
 /**
  * Describes the sizes of a font for measuring purposes.
  */
@@ -6987,7 +7044,12 @@ declare interface IAlphaSynth {
      * Loads the synchronization information from the given score (used for backing tracks and external media).
      * @param score
      */
-    loadBackingTrack(score: Score, syncPoints: BackingTrackSyncPoint[]): void;
+    loadBackingTrack(score: Score): void;
+    /**
+     * Updates the points used to synchronize the backing track with the synthesized audio for correct cursor placement.
+     * @param syncPoints
+     */
+    updateSyncPoints(syncPoints: BackingTrackSyncPoint[]): void;
     /**
      * Applies the given transposition pitches to be used during playback.
      * @param transpositionPitches a map defining the transposition pitches for midi channel.
@@ -8758,7 +8820,13 @@ declare class MasterBarTickLookup {
      * Gets or sets the MasterBar which is played.
      */
     masterBar: MasterBar;
+    /**
+     * The first beat in the bar.
+     */
     firstBeat: BeatTickLookup | null;
+    /**
+     * The last beat in the bar.
+     */
     lastBeat: BeatTickLookup | null;
     /**
      * Inserts `newNextBeat` after `currentBeat` in the linked list of items and updates.
@@ -9117,6 +9185,17 @@ declare class MidiFileGenerator {
     private addProgramChange;
     static buildTranspositionPitches(score: Score, settings: Settings): Map<number, number>;
     private generateChannel;
+    /**
+     * Generates the sync points for the given score without re-generating the midi itself.
+     * @remarks
+     * Use this method if a re-generation of the sync points after modification is required.
+     * It correctly handles repeats and places sync points accoridng to their absolute midi tick when they
+     * need to be considered for synchronization.
+     * @param score The song for which to regenerate the sync points.
+     * @returns The generated sync points for usage in the backing track playback.
+     */
+    static generateSyncPoints(score: Score): BackingTrackSyncPoint[];
+    private static playThroughSong;
     private static toChannelShort;
     private generateMasterBar;
     private generateBar;
@@ -9314,7 +9393,10 @@ declare class MidiSequencerState {
 declare class MidiTickLookup {
     private _currentMasterBar;
     /* Excluded from this release type: masterBarLookup */
-    /* Excluded from this release type: masterBars */
+    /**
+     * A list of all {@link MasterBarTickLookup} sorted by time.
+     */
+    readonly masterBars: MasterBarTickLookup[];
     /**
      * The information about which bars are displayed via multi-bar rests.
      * The key is the start bar, and the value is the additional bars in sequential order.
@@ -12066,6 +12148,7 @@ export declare namespace rendering {
 export declare class RenderingResources {
     private static sansFont;
     private static serifFont;
+    /* Excluded from this release type: smuflFont */
     /**
      * The font to use for displaying the songs copyright information in the header of the music sheet.
      * @defaultValue `bold 12px Arial, sans-serif`
@@ -12208,6 +12291,7 @@ export declare class RenderingResources {
  * @target web
  */
 declare interface RenderingResourcesJson {
+    /* Excluded from this release type: smuflFont */
     /**
      * The font to use for displaying the songs copyright information in the header of the music sheet.
      * @defaultValue `bold 12px Arial, sans-serif`