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

package/dist/alphaTab.d.ts

@@ -471,12 +471,21 @@ export declare class AlphaTabApiBase<TSettings> {
     private _tracks;
     private _actualPlayerMode;
     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>;
     /**
@@ -516,7 +525,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * @category Properties - Core
      * @since 0.9.4
      */
-    readonly renderer: IScoreRenderer;
+    get renderer(): IScoreRenderer;
     /**
      * The score holding all information about the song being rendered
      * @category Properties - Core
@@ -682,6 +691,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      */
     updateSettings(): void;
+    private updateRenderer;
     /**
      * Initiates a load of the score using the given data.
      * @returns true if the data object is supported and a load was initiated, otherwise false
@@ -1376,8 +1386,19 @@ export declare class AlphaTabApiBase<TSettings> {
     get isLooping(): boolean;
     set isLooping(value: boolean);
     private destroyPlayer;
+    /**
+     *
+     * @returns true if a new player was created, false if no player was created (includes destroy & reuse of the current one)
+     */
     private setupOrDestroyPlayer;
-    private loadMidiForScore;
+    /**
+     * Re-creates the midi for the current score and loads it.
+     * @remarks
+     * This will result in the player to stop playback. Some setting changes require re-genration of the midi song.
+     * @category Methods - Player
+     * @since 1.6.0
+     */
+    loadMidiForScore(): void;
     /**
      * Changes the volume of the given tracks.
      * @param tracks The tracks for which the volume should be changed.
@@ -1703,6 +1724,7 @@ export declare class AlphaTabApiBase<TSettings> {
     private _previousTick;
     private _currentBeat;
     private _currentBeatBounds;
+    private _isInitialBeatCursorUpdate;
     private _previousStateForCursor;
     private _previousCursorCache;
     private _lastScroll;
@@ -2741,7 +2763,43 @@ export declare class AlphaTabApiBase<TSettings> {
      */
     get playbackRangeChanged(): IEventEmitterOfT<PlaybackRangeChangedEventArgs>;
     private onPlaybackRangeChanged;
-    /* Excluded from this release type: settingsUpdated */
+    /**
+     * This event is fired when a settings update was requested.
+     *
+     * @eventProperty
+     * @category Events - Core
+     * @since 1.6.0
+     *
+     * @example
+     * JavaScript
+     * ```js
+     * const api = new alphaTab.AlphaTabApi(document.querySelector('#alphaTab'));
+     * api.settingsUpdated.on(() => {
+     *     updateSettingsUI(api.settings);
+     * });
+     * ```
+     *
+     * @example
+     * C#
+     * ```cs
+     * var api = new AlphaTabApi<MyControl>(...);
+     * api.SettingsUpdated.On(() =>
+     * {
+     *     UpdateSettingsUI(api.settings);
+     * });
+     * ```
+     *
+     * @example
+     * Android
+     * ```kotlin
+     * val api = AlphaTabApi<MyControl>(...)
+     * api.SettingsUpdated.on {
+     *     updateSettingsUI(api.settings)
+     * }
+     * ```
+     *
+     */
+    settingsUpdated: IEventEmitter;
     private onSettingsUpdated;
     /**
      * Loads and lists the available output devices which can be used by the player.
@@ -13427,7 +13485,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;
@@ -13440,6 +13498,7 @@ declare class SyncPointData {
 
 export declare namespace synth {
     export {
+        AlphaSynthBase,
         AlphaSynth,
         CircularSampleBuffer,
         PlaybackRange,
@@ -13447,6 +13506,7 @@ export declare namespace synth {
         ISynthOutputDevice,
         IBackingTrackSynthOutput,
         IAlphaSynth,
+        BackingTrackSyncPoint,
         PlayerState,
         PlayerStateChangedEventArgs,
         PlaybackRangeChangedEventArgs,