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

package/dist/alphaTab.d.ts

@@ -324,7 +324,6 @@ declare class AlphaSynthWebWorkerApi implements IAlphaSynth {
     stop(): void;
     playOneTimeMidiFile(midi: MidiFile): void;
     loadSoundFont(data: Uint8Array, append: boolean): void;
-    loadSoundFontFromUrl(url: string, append: boolean, progress: (e: ProgressEventArgs) => void): void;
     resetSoundFonts(): void;
     loadMidiFile(midi: MidiFile): void;
     applyTranspositionPitches(transpositionPitches: Map<number, number>): void;
@@ -471,6 +470,8 @@ export declare class AlphaTabApiBase<TSettings> {
     private _score;
     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).
      */
@@ -516,7 +517,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
@@ -611,6 +612,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * @param settings The UI settings object to use for loading the settings.
      */
     constructor(uiFacade: IUiFacade<TSettings>, settings: TSettings);
+    private setupPlayerWrapper;
     /**
      * Destroys the alphaTab control and restores the initial state of the UI.
      * @remarks
@@ -681,6 +683,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
@@ -1022,7 +1025,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * setupPlayerEvents(api.player)
      * ```
      */
-    player: IAlphaSynth | null;
+    get player(): IAlphaSynth | null;
     /**
      * Whether the player is ready for starting the playback.
      * @remarks
@@ -1375,8 +1378,19 @@ export declare class AlphaTabApiBase<TSettings> {
     get isLooping(): boolean;
     set isLooping(value: boolean);
     private destroyPlayer;
-    private setupPlayer;
-    private loadMidiForScore;
+    /**
+     *
+     * @returns true if a new player was created, false if no player was created (includes destroy & reuse of the current one)
+     */
+    private setupOrDestroyPlayer;
+    /**
+     * 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.
@@ -1700,15 +1714,14 @@ export declare class AlphaTabApiBase<TSettings> {
     private _beatCursor;
     private _selectionWrapper;
     private _previousTick;
-    private _playerState;
     private _currentBeat;
-    private _currentBarBounds;
+    private _currentBeatBounds;
+    private _isInitialBeatCursorUpdate;
     private _previousStateForCursor;
     private _previousCursorCache;
     private _lastScroll;
     private destroyCursors;
     private updateCursors;
-    private setupPlayerEvents;
     /**
      * updates the cursors to highlight the beat at the specified tick position
      * @param tick
@@ -2350,7 +2363,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * }
      * ```
      */
-    playerReady: IEventEmitter;
+    get playerReady(): IEventEmitter;
     private onPlayerReady;
     /**
      * This event is fired when the playback of the whole song finished.
@@ -2402,7 +2415,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    playerFinished: IEventEmitter;
+    get playerFinished(): IEventEmitter;
     private onPlayerFinished;
     /**
      * This event is fired when the SoundFont needed for playback was loaded.
@@ -2440,7 +2453,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    soundFontLoaded: IEventEmitter;
+    get soundFontLoaded(): IEventEmitter;
     private onSoundFontLoaded;
     /**
      * This event is fired when a Midi file is being loaded.
@@ -2567,7 +2580,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    playerStateChanged: IEventEmitterOfT<PlayerStateChangedEventArgs>;
+    get playerStateChanged(): IEventEmitterOfT<PlayerStateChangedEventArgs>;
     private onPlayerStateChanged;
     /**
      * This event is fired when the current playback position of the song changed.
@@ -2605,7 +2618,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    playerPositionChanged: IEventEmitterOfT<PositionChangedEventArgs>;
+    get playerPositionChanged(): IEventEmitterOfT<PositionChangedEventArgs>;
     private onPlayerPositionChanged;
     /**
      * This event is fired when the synthesizer played certain midi events.
@@ -2686,7 +2699,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * @see {@link SystemCommonEvent}
      * @see {@link SystemExclusiveEvent}
      */
-    midiEventsPlayed: IEventEmitterOfT<MidiEventsPlayedEventArgs>;
+    get midiEventsPlayed(): IEventEmitterOfT<MidiEventsPlayedEventArgs>;
     private onMidiEventsPlayed;
     /**
      * This event is fired when the playback range changed.
@@ -2740,9 +2753,45 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    playbackRangeChanged: IEventEmitterOfT<PlaybackRangeChangedEventArgs>;
+    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.
@@ -7295,16 +7344,42 @@ declare interface IContainer {
     mouseUp: IEventEmitterOfT<IMouseEventArgs>;
 }
 
+/**
+ * An emitter for an event without any value passed to the listeners.
+ */
 export declare interface IEventEmitter {
-    on(value: () => void): void;
+    /**
+     * Registers to the event with the given handler
+     * @param value The function to call when the event occurs.
+     * @returns A function which can be called to unregister the registered handler.
+     * This is usedful if the original function passed to this is not stored somewhere but
+     * unregistering of the event needs to be done.
+     */
+    on(value: () => void): () => void;
+    /**
+     * Unregisters the given handler from this event.
+     * @param value The value originally passed into {@link on}, NOT the function returned by it.
+     */
     off(value: () => void): void;
 }
 
 /**
+ * An emitter for an event with a single parameter passed to the listeners.
  * @partial
  */
 export declare interface IEventEmitterOfT<T> {
-    on(value: (arg: T) => void): void;
+    /**
+     * Registers to the event with the given handler
+     * @param value The function to call when the event occurs.
+     * @returns A function which can be called to unregister the registered handler.
+     * This is usedful if the original function passed to this is not stored somewhere but
+     * unregistering of the event needs to be done.
+     */
+    on(value: (arg: T) => void): () => void;
+    /**
+     * Unregisters the given handler from this event.
+     * @param value The value originally passed into {@link on}, NOT the function returned by it.
+     */
     off(value: (arg: T) => void): void;
 }
 
@@ -9151,13 +9226,12 @@ declare class MidiFileSequencer {
     fillMidiEventQueueToEndTime(endTime: number): boolean;
     private fillMidiEventQueueLimited;
     mainTickPositionToTimePosition(tickPosition: number): number;
-    mainTimePositionToTickPosition(timePosition: number): number;
     mainUpdateSyncPoints(syncPoints: BackingTrackSyncPoint[]): void;
     currentTimePositionToTickPosition(timePosition: number): number;
+    private updateCurrentTempo;
     mainTimePositionFromBackingTrack(timePosition: number, backingTrackLength: number): number;
     mainTimePositionToBackingTrack(timePosition: number, backingTrackLength: number): number;
     private tickPositionToTimePositionWithSpeed;
-    private timePositionToTickPositionWithSpeed;
     private get internalEndTime();
     get isFinished(): boolean;
     stop(): void;