@coderline/alphatab 1.7.0-alpha.1517 → 1.7.0-alpha.1522

package/dist/alphaTab.d.ts

@@ -131,6 +131,8 @@ declare class AlphaSynthBase implements IAlphaSynth {
     private _notPlayedSamples;
     private _synthStopping;
     private _output;
+    private _loadedMidiInfo?;
+    private _currentPosition;
     get output(): ISynthOutput;
     isReady: boolean;
     get isReadyForPlayback(): boolean;
@@ -149,6 +151,8 @@ declare class AlphaSynthBase implements IAlphaSynth {
     get playbackSpeed(): number;
     set playbackSpeed(value: number);
     protected updatePlaybackSpeed(value: number): void;
+    get loadedMidiInfo(): PositionChangedEventArgs | undefined;
+    get currentPosition(): PositionChangedEventArgs;
     get tickPosition(): number;
     set tickPosition(value: number);
     get timePosition(): number;
@@ -188,17 +192,33 @@ declare class AlphaSynthBase implements IAlphaSynth {
     private onSamplesPlayed;
     protected checkForFinish(): void;
     private stopOneTimeMidi;
+    private createPositionChangedEventArgs;
     protected updateTimePosition(timePosition: number, isSeek: boolean): void;
+    /**
+     * @lateinit
+     */
     readonly ready: IEventEmitter;
     readonly readyForPlayback: IEventEmitter;
     readonly finished: IEventEmitter;
     readonly soundFontLoaded: IEventEmitter;
     readonly soundFontLoadFailed: IEventEmitterOfT<Error>;
+    /**
+     * @lateinit
+     */
     readonly midiLoaded: IEventEmitterOfT<PositionChangedEventArgs>;
     readonly midiLoadFailed: IEventEmitterOfT<Error>;
+    /**
+     * @lateinit
+     */
     readonly stateChanged: IEventEmitterOfT<PlayerStateChangedEventArgs>;
+    /**
+     * @lateinit
+     */
     readonly positionChanged: IEventEmitterOfT<PositionChangedEventArgs>;
     readonly midiEventsPlayed: IEventEmitterOfT<MidiEventsPlayedEventArgs>;
+    /**
+     * @lateinit
+     */
     readonly playbackRangeChanged: IEventEmitterOfT<PlaybackRangeChangedEventArgs>;
     /* Excluded from this release type: hasSamplesForProgram */
     /* Excluded from this release type: hasSamplesForPercussion */
@@ -298,11 +318,11 @@ declare class AlphaSynthWebWorkerApi implements IAlphaSynth {
     private _metronomeVolume;
     private _countInVolume;
     private _playbackSpeed;
-    private _tickPosition;
-    private _timePosition;
     private _isLooping;
     private _playbackRange;
     private _midiEventsPlayedFilter;
+    private _loadedMidiInfo?;
+    private _currentPosition;
     get output(): ISynthOutput;
     get isReady(): boolean;
     get isReadyForPlayback(): boolean;
@@ -320,6 +340,8 @@ declare class AlphaSynthWebWorkerApi implements IAlphaSynth {
     set midiEventsPlayedFilter(value: MidiEventType[]);
     get playbackSpeed(): number;
     set playbackSpeed(value: number);
+    get loadedMidiInfo(): PositionChangedEventArgs | undefined;
+    get currentPosition(): PositionChangedEventArgs;
     get tickPosition(): number;
     set tickPosition(value: number);
     get timePosition(): number;
@@ -458,7 +480,7 @@ export declare class AlphaTabApi extends AlphaTabApiBase<SettingsJson | Settings
      * });
      * ```
      */
-    soundFontLoad: IEventEmitterOfT<ProgressEventArgs>;
+    readonly soundFontLoad: IEventEmitterOfT<ProgressEventArgs>;
     /**
      * Triggers a load of the soundfont from the given URL.
      * @param url The URL from which to load the soundfont
@@ -1305,6 +1327,18 @@ export declare class AlphaTabApiBase<TSettings> {
      */
     get timePosition(): number;
     set timePosition(value: number);
+    /**
+     * The total length of the song in midi ticks.
+     * @category Properties - Player
+     * @since 1.6.2
+     */
+    get endTick(): number;
+    /**
+     * The total length of the song in milliseconds.
+     * @category Properties - Player
+     * @since 1.6.2
+     */
+    get endTime(): number;
     /**
      * The range of the song that should be played.
      * @remarks
@@ -1804,7 +1838,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    playedBeatChanged: IEventEmitterOfT<Beat>;
+    readonly playedBeatChanged: IEventEmitterOfT<Beat>;
     private onPlayedBeatChanged;
     /**
      * This event is fired when the currently active beats across all tracks change.
@@ -1845,7 +1879,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    activeBeatsChanged: IEventEmitterOfT<ActiveBeatsChangedEventArgs>;
+    readonly activeBeatsChanged: IEventEmitterOfT<ActiveBeatsChangedEventArgs>;
     private onActiveBeatsChanged;
     private _beatMouseDown;
     private _noteMouseDown;
@@ -1885,7 +1919,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * }
      * ```
      */
-    beatMouseDown: IEventEmitterOfT<Beat>;
+    readonly beatMouseDown: IEventEmitterOfT<Beat>;
     /**
      * This event is fired whenever the user moves the mouse over a beat after the user already pressed the button on a beat.
      * @eventProperty
@@ -1920,7 +1954,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * }
      * ```
      */
-    beatMouseMove: IEventEmitterOfT<Beat>;
+    readonly beatMouseMove: IEventEmitterOfT<Beat>;
     /**
      * This event is fired whenever the user releases the mouse after a mouse press on a beat.
      * @remarks
@@ -1959,7 +1993,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * }
      * ```
      */
-    beatMouseUp: IEventEmitterOfT<Beat | null>;
+    readonly beatMouseUp: IEventEmitterOfT<Beat | null>;
     /**
      * This event is fired whenever a the user presses the mouse button on a note head/number.
      * @remarks
@@ -2000,7 +2034,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    noteMouseDown: IEventEmitterOfT<Note>;
+    readonly noteMouseDown: IEventEmitterOfT<Note>;
     /**
      * This event is fired whenever the user moves the mouse over a note after the user already pressed the button on a note.
      * @remarks
@@ -2041,7 +2075,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    noteMouseMove: IEventEmitterOfT<Note>;
+    readonly noteMouseMove: IEventEmitterOfT<Note>;
     /**
      * This event is fired whenever the user releases the mouse after a mouse press on a note.
      * @remarks
@@ -2084,7 +2118,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    noteMouseUp: IEventEmitterOfT<Note | null>;
+    readonly noteMouseUp: IEventEmitterOfT<Note | null>;
     private get hasCursor();
     private onBeatMouseDown;
     private onNoteMouseDown;
@@ -2135,7 +2169,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    scoreLoaded: IEventEmitterOfT<Score>;
+    readonly scoreLoaded: IEventEmitterOfT<Score>;
     private onScoreLoaded;
     /**
      * This event is fired when alphaTab was resized and is about to rerender the music notation.
@@ -2183,7 +2217,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    resize: IEventEmitterOfT<ResizeEventArgs>;
+    readonly resize: IEventEmitterOfT<ResizeEventArgs>;
     private onResize;
     /**
      * This event is fired when the rendering of the whole music sheet is starting.
@@ -2223,7 +2257,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    renderStarted: IEventEmitterOfT<boolean>;
+    readonly renderStarted: IEventEmitterOfT<boolean>;
     private onRenderStarted;
     /**
      * This event is fired when the rendering of the whole music sheet is finished.
@@ -2264,7 +2298,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    renderFinished: IEventEmitterOfT<RenderFinishedEventArgs>;
+    readonly renderFinished: IEventEmitterOfT<RenderFinishedEventArgs>;
     private onRenderFinished;
     /**
      * This event is fired when the rendering of the whole music sheet is finished, and all handlers of `renderFinished` ran.
@@ -2308,7 +2342,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    postRenderFinished: IEventEmitter;
+    readonly postRenderFinished: IEventEmitter;
     private onPostRenderFinished;
     /**
      * This event is fired when an error within alphatab occurred.
@@ -2351,7 +2385,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    error: IEventEmitterOfT<Error>;
+    readonly error: IEventEmitterOfT<Error>;
     /* Excluded from this release type: onError */
     /**
      * This event is fired when all required data for playback is loaded and ready.
@@ -2529,7 +2563,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    midiLoad: IEventEmitterOfT<MidiFile>;
+    readonly midiLoad: IEventEmitterOfT<MidiFile>;
     private onMidiLoad;
     /**
      * This event is fired when the Midi file needed for playback was loaded.
@@ -2570,7 +2604,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    midiLoaded: IEventEmitterOfT<PositionChangedEventArgs>;
+    readonly midiLoaded: IEventEmitterOfT<PositionChangedEventArgs>;
     private onMidiLoaded;
     /**
      * This event is fired when the playback state changed.
@@ -2819,7 +2853,7 @@ export declare class AlphaTabApiBase<TSettings> {
      * ```
      *
      */
-    settingsUpdated: IEventEmitter;
+    readonly settingsUpdated: IEventEmitter;
     private onSettingsUpdated;
     /**
      * Loads and lists the available output devices which can be used by the player.
@@ -3055,8 +3089,6 @@ declare class AlphaTexExporter extends ScoreExporter {
     private writeTrackTo;
     private writeStaffTo;
     private writeBarTo;
-    private writeTrackMetaTo;
-    private writePlaybackInfoTo;
     private writeStaffMetaTo;
     private writeChordTo;
     private writeMasterBarMetaTo;
@@ -3139,6 +3171,7 @@ declare class AlphaTexImporter extends ScoreImporter {
     private parseTrackNameMode;
     private parseTrackNameOrientation;
     private handleStaffMeta;
+    private readTrackInstrument;
     private handleAccidentalMode;
     private makeCurrentStaffPitched;
     /**
@@ -3331,7 +3364,11 @@ declare enum AutomationType {
     /**
      * A sync point for synchronizing the internal time axis with an external audio track.
      */
-    SyncPoint = 4
+    SyncPoint = 4,
+    /**
+     * Midi Bank change.
+     */
+    Bank = 4
 }
 
 /**
@@ -8191,6 +8228,14 @@ declare interface IAlphaSynth {
      * Gets or sets the position within the song in milliseconds.
      */
     timePosition: number;
+    /**
+     * The information about the main song loaded (does not account for "one time midis" or "count in").
+     */
+    readonly loadedMidiInfo?: PositionChangedEventArgs;
+    /**
+     * The latest time information of the played song.
+     */
+    readonly currentPosition: PositionChangedEventArgs;
     /**
      * Gets or sets the range of the song that should be played. Set this to null
      * to play the whole song.
@@ -10520,6 +10565,7 @@ declare class MidiFileGenerator {
     generate(): void;
     private generateTrack;
     private addProgramChange;
+    private addBankChange;
     static buildTranspositionPitches(score: Score, settings: Settings): Map<number, number>;
     private generateChannel;
     /**
@@ -12687,6 +12733,10 @@ declare class PlaybackInformation {
      * Gets or sets the midi program to use.
      */
     program: number;
+    /**
+     * The midi bank to use.
+     */
+    bank: number;
     /**
      * Gets or sets the primary channel for all normal midi events.
      */
@@ -14482,6 +14532,7 @@ export declare class Settings {
      * @target web
      */
     fillFromJson(json: SettingsJson): void;
+    /* Excluded from this release type: handleBackwardsCompatibility */
 }
 
 /**
@@ -15410,6 +15461,10 @@ declare class Track {
      * @json_add addLineBreaks
      */
     lineBreaks?: Set<number>;
+    /**
+     * Gets whether this track is a percussion track.
+     */
+    get isPercussion(): boolean;
     /**
      * Adds a new line break.
      * @param index  The index of the bar before which a line break should happen.