@coderline/alphatab 1.6.0-alpha.1415 → 1.6.0-alpha.1418

package/dist/alphaTab.d.ts

@@ -473,11 +473,19 @@ export declare class AlphaTabApiBase<TSettings> {
     private _player;
     private _renderer;
     /**
-     * The actual player mode which is currently active (e.g. allows determining whether a backing track or the synthesizer is active).
+     * The actual player mode which is currently active.
+     * @remarks
+     * Allows determining whether a backing track or the synthesizer is active in case automatic detection is enabled.
+     * @category Properties - Player
+     * @since 1.6.0
      */
     get actualPlayerMode(): PlayerMode;
     /**
-     * Gets the UI facade to use for interacting with the user interface.
+     * The UI facade used for interacting with the user interface (like the browser).
+     * @remarks
+     * The implementation depends on the platform alphaTab is running in (e.g. the web version in the browser, WPF in .net etc.)
+     * @category Properties - Core
+     * @since 0.9.4
      */
     readonly uiFacade: IUiFacade<TSettings>;
     /**
@@ -4967,12 +4975,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
@@ -5121,12 +5151,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
@@ -6169,7 +6214,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
      */
@@ -6195,7 +6239,6 @@ export declare class Environment {
      * @target web
      */
     static readonly fontDirectory: string | null;
-    /* Excluded from this release type: bravuraFontChecker */
     /**
      * @target web
      */
@@ -6498,8 +6541,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
 }
 
 /**
@@ -6514,21 +6588,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.
  */
@@ -12058,6 +12117,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`
@@ -12200,6 +12260,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`
@@ -13477,7 +13538,7 @@ declare class SyncPointData {
     barOccurence: number;
     /**
      * The modified tempo at which the cursor should move (aka. the tempo played within the external audio track).
-     * This information is used together with the {@link originalTempo} to calculate how much faster/slower the
+     * This information is used together with normal tempo changes to calculate how much faster/slower the
      * cursor playback is performed to align with the audio track.
      */
     modifiedTempo: number;
@@ -13490,6 +13551,7 @@ declare class SyncPointData {
 
 export declare namespace synth {
     export {
+        AlphaSynthBase,
         AlphaSynth,
         CircularSampleBuffer,
         PlaybackRange,
@@ -13497,6 +13559,7 @@ export declare namespace synth {
         ISynthOutputDevice,
         IBackingTrackSynthOutput,
         IAlphaSynth,
+        BackingTrackSyncPoint,
         PlayerState,
         PlayerStateChangedEventArgs,
         PlaybackRangeChangedEventArgs,