@coderline/alphatab 1.7.0-alpha.1574 → 1.7.0-alpha.1577

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,6 @@
1
1
  /**
2
2
  * Lists all types of note acceuntations
3
+ * @public
3
4
  */
4
5
  declare enum AccentuationType {
5
6
  /**
@@ -22,6 +23,7 @@ declare enum AccentuationType {
22
23
 
23
24
  /**
24
25
  * Defines all possible accidentals for notes.
26
+ * @public
25
27
  */
26
28
  declare enum AccidentalType {
27
29
  /**
@@ -64,6 +66,7 @@ declare enum AccidentalType {
64
66
 
65
67
  /**
66
68
  * Represents the information related to the beats actively being played now.
69
+ * @public
67
70
  */
68
71
  declare class ActiveBeatsChangedEventArgs {
69
72
  /**
@@ -76,6 +79,7 @@ declare class ActiveBeatsChangedEventArgs {
76
79
  /**
77
80
  * This is the main synthesizer component which can be used to
78
81
  * play a {@link MidiFile} via a {@link ISynthOutput}.
82
+ * @public
79
83
  */
80
84
  declare class AlphaSynth extends AlphaSynthBase {
81
85
  /**
@@ -95,39 +99,22 @@ declare class AlphaSynth extends AlphaSynthBase {
95
99
  exportAudio(options: AudioExportOptions, midi: MidiFile, syncPoints: BackingTrackSyncPoint[], mainTranspositionPitches: Map<number, number>): IAlphaSynthAudioExporter;
96
100
  }
97
101
 
98
- /**
99
- * This class implements a HTML5 Web Audio API based audio output device
100
- * for alphaSynth. It can be controlled via a JS API.
101
- * @target web
102
- */
103
- declare class AlphaSynthAudioWorkletOutput extends AlphaSynthWebAudioOutputBase {
104
- private _worklet;
105
- private _bufferTimeInMilliseconds;
106
- private readonly _settings;
107
- constructor(settings: Settings);
108
- open(bufferTimeInMilliseconds: number): void;
109
- play(): void;
110
- private handleMessage;
111
- pause(): void;
112
- addSamples(f: Float32Array): void;
113
- resetSamples(): void;
114
- }
115
-
116
102
  /**
117
103
  * This is the base class for synthesizer components which can be used to
118
104
  * play a {@link MidiFile} via a {@link ISynthOutput}.
105
+ * @public
119
106
  */
120
107
  declare class AlphaSynthBase implements IAlphaSynth {
121
- protected sequencer: MidiFileSequencer;
122
- protected synthesizer: IAudioSampleSynthesizer;
108
+
109
+
123
110
  protected isSoundFontLoaded: boolean;
124
111
  private _isMidiLoaded;
125
112
  private _tickPosition;
126
113
  private _timePosition;
127
114
  private _metronomeVolume;
128
115
  private _countInVolume;
129
- protected _playedEventsQueue: Queue<SynthEvent>;
130
- protected _midiEventsPlayedFilter: Set<MidiEventType>;
116
+
117
+ protected midiEventsPlayedFilterSet: Set<MidiEventType>;
131
118
  private _notPlayedSamples;
132
119
  private _synthStopping;
133
120
  private _output;
@@ -162,14 +149,10 @@ declare class AlphaSynthBase implements IAlphaSynth {
162
149
  get isLooping(): boolean;
163
150
  set isLooping(value: boolean);
164
151
  destroy(): void;
165
- /**
166
- * Initializes a new instance of the {@link AlphaSynthBase} class.
167
- * @param output The output to use for playing the generated samples.
168
- */
169
- constructor(output: ISynthOutput, synthesizer: IAudioSampleSynthesizer, bufferTimeInMilliseconds: number);
152
+
170
153
  protected onSampleRequest(): void;
171
154
  play(): boolean;
172
- private playInternal;
155
+ private _playInternal;
173
156
  pause(): void;
174
157
  playPause(): void;
175
158
  stop(): void;
@@ -177,7 +160,7 @@ declare class AlphaSynthBase implements IAlphaSynth {
177
160
  resetSoundFonts(): void;
178
161
  private _loadedSoundFonts;
179
162
  loadSoundFont(data: Uint8Array, append: boolean): void;
180
- private checkReadyForPlayback;
163
+ private _checkReadyForPlayback;
181
164
  /**
182
165
  * Loads the given midi file for playback.
183
166
  * @param midi The midi file to load
@@ -189,10 +172,10 @@ declare class AlphaSynthBase implements IAlphaSynth {
189
172
  resetChannelStates(): void;
190
173
  setChannelSolo(channel: number, solo: boolean): void;
191
174
  setChannelVolume(channel: number, volume: number): void;
192
- private onSamplesPlayed;
175
+ private _onSamplesPlayed;
193
176
  protected checkForFinish(): void;
194
- private stopOneTimeMidi;
195
- private createPositionChangedEventArgs;
177
+ private _stopOneTimeMidi;
178
+ private _createPositionChangedEventArgs;
196
179
  protected updateTimePosition(timePosition: number, isSeek: boolean): void;
197
180
  /**
198
181
  * @lateinit
@@ -220,8 +203,8 @@ declare class AlphaSynthBase implements IAlphaSynth {
220
203
  * @lateinit
221
204
  */
222
205
  readonly playbackRangeChanged: IEventEmitterOfT<PlaybackRangeChangedEventArgs>;
223
- /* Excluded from this release type: hasSamplesForProgram */
224
- /* Excluded from this release type: hasSamplesForPercussion */
206
+
207
+
225
208
  loadBackingTrack(_score: Score): void;
226
209
  updateSyncPoints(_syncPoints: BackingTrackSyncPoint[]): void;
227
210
  }
@@ -229,6 +212,7 @@ declare class AlphaSynthBase implements IAlphaSynth {
229
212
  /**
230
213
  * This implementation of the {@link IMidiFileHandler}
231
214
  * generates a {@link MidiFile} object which can be used in AlphaSynth for playback.
215
+ * @public
232
216
  */
233
217
  declare class AlphaSynthMidiFileHandler implements IMidiFileHandler {
234
218
  private _midiFile;
@@ -242,7 +226,7 @@ declare class AlphaSynthMidiFileHandler implements IMidiFileHandler {
242
226
  addTimeSignature(tick: number, timeSignatureNumerator: number, timeSignatureDenominator: number): void;
243
227
  addRest(track: number, tick: number, channel: number): void;
244
228
  addNote(track: number, start: number, length: number, key: number, velocity: number, channel: number): void;
245
- private static fixValue;
229
+ private static _fixValue;
246
230
  addControlChange(track: number, tick: number, channel: number, controller: ControllerType, value: number): void;
247
231
  addProgramChange(track: number, tick: number, channel: number, program: number): void;
248
232
  addTempo(tick: number, tempo: number): void;
@@ -251,144 +235,9 @@ declare class AlphaSynthMidiFileHandler implements IMidiFileHandler {
251
235
  finishTrack(track: number, tick: number): void;
252
236
  }
253
237
 
254
- /**
255
- * This class implements a HTML5 Web Audio API based audio output device
256
- * for alphaSynth using the legacy ScriptProcessor node.
257
- * @target web
258
- */
259
- declare class AlphaSynthScriptProcessorOutput extends AlphaSynthWebAudioOutputBase {
260
- private _audioNode;
261
- private _circularBuffer;
262
- private _bufferCount;
263
- private _requestedBufferCount;
264
- open(bufferTimeInMilliseconds: number): void;
265
- play(): void;
266
- pause(): void;
267
- addSamples(f: Float32Array): void;
268
- resetSamples(): void;
269
- private requestBuffers;
270
- private _outputBuffer;
271
- private generateSound;
272
- }
273
-
274
- /**
275
- * @target web
276
- */
277
- declare abstract class AlphaSynthWebAudioOutputBase implements ISynthOutput {
278
- protected static readonly BufferSize: number;
279
- protected static readonly PreferredSampleRate: number;
280
- protected _context: AudioContext | null;
281
- protected _buffer: AudioBuffer | null;
282
- protected _source: AudioBufferSourceNode | null;
283
- private _resumeHandler?;
284
- get sampleRate(): number;
285
- activate(resumedCallback?: () => void): void;
286
- private patchIosSampleRate;
287
- open(_bufferTimeInMilliseconds: number): void;
288
- private registerResumeHandler;
289
- private unregisterResumeHandler;
290
- play(): void;
291
- pause(): void;
292
- destroy(): void;
293
- abstract addSamples(f: Float32Array): void;
294
- abstract resetSamples(): void;
295
- readonly ready: IEventEmitter;
296
- readonly samplesPlayed: IEventEmitterOfT<number>;
297
- readonly sampleRequest: IEventEmitter;
298
- protected onSamplesPlayed(numberOfSamples: number): void;
299
- protected onSampleRequest(): void;
300
- protected onReady(): void;
301
- enumerateOutputDevices(): Promise<ISynthOutputDevice[]>;
302
- setOutputDevice(device: ISynthOutputDevice | null): Promise<void>;
303
- getOutputDevice(): Promise<ISynthOutputDevice | null>;
304
- }
305
-
306
- /**
307
- * a WebWorker based alphaSynth which uses the given player as output.
308
- * @target web
309
- */
310
- declare class AlphaSynthWebWorkerApi implements IAlphaSynth {
311
- private _synth;
312
- private _output;
313
- private _workerIsReadyForPlayback;
314
- private _workerIsReady;
315
- private _outputIsReady;
316
- private _state;
317
- private _masterVolume;
318
- private _metronomeVolume;
319
- private _countInVolume;
320
- private _playbackSpeed;
321
- private _isLooping;
322
- private _playbackRange;
323
- private _midiEventsPlayedFilter;
324
- private _loadedMidiInfo?;
325
- private _currentPosition;
326
- get output(): ISynthOutput;
327
- get isReady(): boolean;
328
- get isReadyForPlayback(): boolean;
329
- get state(): PlayerState;
330
- get logLevel(): LogLevel;
331
- get worker(): Worker;
332
- set logLevel(value: LogLevel);
333
- get masterVolume(): number;
334
- set masterVolume(value: number);
335
- get metronomeVolume(): number;
336
- set metronomeVolume(value: number);
337
- get countInVolume(): number;
338
- set countInVolume(value: number);
339
- get midiEventsPlayedFilter(): MidiEventType[];
340
- set midiEventsPlayedFilter(value: MidiEventType[]);
341
- get playbackSpeed(): number;
342
- set playbackSpeed(value: number);
343
- get loadedMidiInfo(): PositionChangedEventArgs | undefined;
344
- get currentPosition(): PositionChangedEventArgs;
345
- get tickPosition(): number;
346
- set tickPosition(value: number);
347
- get timePosition(): number;
348
- set timePosition(value: number);
349
- get isLooping(): boolean;
350
- set isLooping(value: boolean);
351
- get playbackRange(): PlaybackRange | null;
352
- set playbackRange(value: PlaybackRange | null);
353
- constructor(player: ISynthOutput, settings: Settings);
354
- destroy(): void;
355
- play(): boolean;
356
- pause(): void;
357
- playPause(): void;
358
- stop(): void;
359
- playOneTimeMidiFile(midi: MidiFile): void;
360
- loadSoundFont(data: Uint8Array, append: boolean): void;
361
- resetSoundFonts(): void;
362
- loadMidiFile(midi: MidiFile): void;
363
- applyTranspositionPitches(transpositionPitches: Map<number, number>): void;
364
- setChannelTranspositionPitch(channel: number, semitones: number): void;
365
- setChannelMute(channel: number, mute: boolean): void;
366
- resetChannelStates(): void;
367
- setChannelSolo(channel: number, solo: boolean): void;
368
- setChannelVolume(channel: number, volume: number): void;
369
- handleWorkerMessage(e: MessageEvent): void;
370
- private checkReady;
371
- private checkReadyForPlayback;
372
- readonly ready: IEventEmitter;
373
- readonly readyForPlayback: IEventEmitter;
374
- readonly finished: IEventEmitter;
375
- readonly soundFontLoaded: IEventEmitter;
376
- readonly soundFontLoadFailed: IEventEmitterOfT<Error>;
377
- readonly midiLoaded: IEventEmitterOfT<PositionChangedEventArgs>;
378
- readonly midiLoadFailed: IEventEmitterOfT<Error>;
379
- readonly stateChanged: IEventEmitterOfT<PlayerStateChangedEventArgs>;
380
- readonly positionChanged: IEventEmitterOfT<PositionChangedEventArgs>;
381
- readonly midiEventsPlayed: IEventEmitterOfT<MidiEventsPlayedEventArgs>;
382
- readonly playbackRangeChanged: IEventEmitterOfT<PlaybackRangeChangedEventArgs>;
383
- onOutputSampleRequest(): void;
384
- onOutputSamplesPlayed(samples: number): void;
385
- private onOutputReady;
386
- loadBackingTrack(_score: Score): void;
387
- updateSyncPoints(_syncPoints: BackingTrackSyncPoint[]): void;
388
- }
389
-
390
238
  /**
391
239
  * @target web
240
+ * @public
392
241
  */
393
242
  export declare class AlphaTabApi extends AlphaTabApiBase<SettingsJson | Settings> {
394
243
  /**
@@ -461,7 +310,7 @@ export declare class AlphaTabApi extends AlphaTabApiBase<SettingsJson | Settings
461
310
  * @inheritdoc
462
311
  */
463
312
  changeTrackVolume(tracks: Track[], volume: number): void;
464
- private trackIndexesToTracks;
313
+ private _trackIndexesToTracks;
465
314
  /**
466
315
  * This event is fired when the SoundFont is being loaded.
467
316
  * @remarks
@@ -495,7 +344,7 @@ export declare class AlphaTabApi extends AlphaTabApiBase<SettingsJson | Settings
495
344
  * This class represents the public API of alphaTab and provides all logic to display
496
345
  * a music sheet in any UI using the given {@link IUiFacade}
497
346
  * @param <TSettings> The UI object holding the settings.
498
- * @csharp_public
347
+ * @public
499
348
  */
500
349
  export declare class AlphaTabApiBase<TSettings> {
501
350
  private _startTime;
@@ -655,7 +504,7 @@ export declare class AlphaTabApiBase<TSettings> {
655
504
  * @param settings The UI settings object to use for loading the settings.
656
505
  */
657
506
  constructor(uiFacade: IUiFacade<TSettings>, settings: TSettings);
658
- private setupPlayerWrapper;
507
+ private _setupPlayerWrapper;
659
508
  /**
660
509
  * Destroys the alphaTab control and restores the initial state of the UI.
661
510
  * @remarks
@@ -726,7 +575,7 @@ export declare class AlphaTabApiBase<TSettings> {
726
575
  * ```
727
576
  */
728
577
  updateSettings(): void;
729
- private updateRenderer;
578
+ private _updateRenderer;
730
579
  /**
731
580
  * Initiates a load of the score using the given data.
732
581
  * @returns true if the data object is supported and a load was initiated, otherwise false
@@ -828,10 +677,10 @@ export declare class AlphaTabApiBase<TSettings> {
828
677
  * ```
829
678
  */
830
679
  renderTracks(tracks: Track[]): void;
831
- private internalRenderTracks;
832
- /* Excluded from this release type: triggerResize */
833
- private appendRenderResult;
834
- private updateRenderResult;
680
+ private _internalRenderTracks;
681
+
682
+ private _appendRenderResult;
683
+ private _updateRenderResult;
835
684
  /**
836
685
  * Tells alphaTab to render the given alphaTex.
837
686
  * @param tex The alphaTex code to render.
@@ -1432,12 +1281,12 @@ export declare class AlphaTabApiBase<TSettings> {
1432
1281
  */
1433
1282
  get isLooping(): boolean;
1434
1283
  set isLooping(value: boolean);
1435
- private destroyPlayer;
1284
+ private _destroyPlayer;
1436
1285
  /**
1437
1286
  *
1438
1287
  * @returns true if a new player was created, false if no player was created (includes destroy & reuse of the current one)
1439
1288
  */
1440
- private setupOrDestroyPlayer;
1289
+ private _setupOrDestroyPlayer;
1441
1290
  /**
1442
1291
  * Re-creates the midi for the current score and loads it.
1443
1292
  * @remarks
@@ -1781,27 +1630,27 @@ export declare class AlphaTabApiBase<TSettings> {
1781
1630
  private _previousStateForCursor;
1782
1631
  private _previousCursorCache;
1783
1632
  private _lastScroll;
1784
- private destroyCursors;
1785
- private updateCursors;
1633
+ private _destroyCursors;
1634
+ private _updateCursors;
1786
1635
  /**
1787
1636
  * updates the cursors to highlight the beat at the specified tick position
1788
1637
  * @param tick
1789
1638
  * @param stop
1790
1639
  * @param shouldScroll whether we should scroll to the bar (if scrolling is active)
1791
1640
  */
1792
- private cursorUpdateTick;
1641
+ private _cursorUpdateTick;
1793
1642
  /**
1794
1643
  * updates the cursors to highlight the specified beat
1795
1644
  */
1796
- private cursorUpdateBeat;
1645
+ private _cursorUpdateBeat;
1797
1646
  /**
1798
1647
  * Initiates a scroll to the cursor.
1799
1648
  * @since 1.2.3
1800
1649
  * @category Methods - Player
1801
1650
  */
1802
1651
  scrollToCursor(): void;
1803
- private internalScrollToCursor;
1804
- private internalCursorUpdateBeat;
1652
+ private _internalScrollToCursor;
1653
+ private _internalCursorUpdateBeat;
1805
1654
  /**
1806
1655
  * This event is fired when the played beat changed.
1807
1656
  *
@@ -1839,7 +1688,7 @@ export declare class AlphaTabApiBase<TSettings> {
1839
1688
  *
1840
1689
  */
1841
1690
  readonly playedBeatChanged: IEventEmitterOfT<Beat>;
1842
- private onPlayedBeatChanged;
1691
+ private _onPlayedBeatChanged;
1843
1692
  /**
1844
1693
  * This event is fired when the currently active beats across all tracks change.
1845
1694
  *
@@ -1880,9 +1729,9 @@ export declare class AlphaTabApiBase<TSettings> {
1880
1729
  *
1881
1730
  */
1882
1731
  readonly activeBeatsChanged: IEventEmitterOfT<ActiveBeatsChangedEventArgs>;
1883
- private onActiveBeatsChanged;
1884
- private _beatMouseDown;
1885
- private _noteMouseDown;
1732
+ private _onActiveBeatsChanged;
1733
+ private _isBeatMouseDown;
1734
+ private _isNoteMouseDown;
1886
1735
  private _selectionStart;
1887
1736
  private _selectionEnd;
1888
1737
  /**
@@ -2119,16 +1968,16 @@ export declare class AlphaTabApiBase<TSettings> {
2119
1968
  *
2120
1969
  */
2121
1970
  readonly noteMouseUp: IEventEmitterOfT<Note | null>;
2122
- private get hasCursor();
2123
- private onBeatMouseDown;
2124
- private onNoteMouseDown;
2125
- private onBeatMouseMove;
2126
- private onNoteMouseMove;
2127
- private onBeatMouseUp;
2128
- private onNoteMouseUp;
2129
- private updateSelectionCursor;
2130
- private setupClickHandling;
2131
- private cursorSelectRange;
1971
+ private get _hasCursor();
1972
+ private _onBeatMouseDown;
1973
+ private _onNoteMouseDown;
1974
+ private _onBeatMouseMove;
1975
+ private _onNoteMouseMove;
1976
+ private _onBeatMouseUp;
1977
+ private _onNoteMouseUp;
1978
+ private _updateSelectionCursor;
1979
+ private _setupClickHandling;
1980
+ private _cursorSelectRange;
2132
1981
  /**
2133
1982
  * This event is fired whenever a new song is loaded.
2134
1983
  * @remarks
@@ -2170,7 +2019,7 @@ export declare class AlphaTabApiBase<TSettings> {
2170
2019
  *
2171
2020
  */
2172
2021
  readonly scoreLoaded: IEventEmitterOfT<Score>;
2173
- private onScoreLoaded;
2022
+ private _onScoreLoaded;
2174
2023
  /**
2175
2024
  * This event is fired when alphaTab was resized and is about to rerender the music notation.
2176
2025
  * @remarks
@@ -2218,7 +2067,7 @@ export declare class AlphaTabApiBase<TSettings> {
2218
2067
  *
2219
2068
  */
2220
2069
  readonly resize: IEventEmitterOfT<ResizeEventArgs>;
2221
- private onResize;
2070
+ private _onResize;
2222
2071
  /**
2223
2072
  * This event is fired when the rendering of the whole music sheet is starting.
2224
2073
  * @remarks
@@ -2258,7 +2107,7 @@ export declare class AlphaTabApiBase<TSettings> {
2258
2107
  *
2259
2108
  */
2260
2109
  readonly renderStarted: IEventEmitterOfT<boolean>;
2261
- private onRenderStarted;
2110
+ private _onRenderStarted;
2262
2111
  /**
2263
2112
  * This event is fired when the rendering of the whole music sheet is finished.
2264
2113
  * @remarks
@@ -2299,7 +2148,7 @@ export declare class AlphaTabApiBase<TSettings> {
2299
2148
  *
2300
2149
  */
2301
2150
  readonly renderFinished: IEventEmitterOfT<RenderFinishedEventArgs>;
2302
- private onRenderFinished;
2151
+ private _onRenderFinished;
2303
2152
  /**
2304
2153
  * This event is fired when the rendering of the whole music sheet is finished, and all handlers of `renderFinished` ran.
2305
2154
  * @remarks
@@ -2343,7 +2192,7 @@ export declare class AlphaTabApiBase<TSettings> {
2343
2192
  *
2344
2193
  */
2345
2194
  readonly postRenderFinished: IEventEmitter;
2346
- private onPostRenderFinished;
2195
+ private _onPostRenderFinished;
2347
2196
  /**
2348
2197
  * This event is fired when an error within alphatab occurred.
2349
2198
  *
@@ -2386,7 +2235,7 @@ export declare class AlphaTabApiBase<TSettings> {
2386
2235
  *
2387
2236
  */
2388
2237
  readonly error: IEventEmitterOfT<Error>;
2389
- /* Excluded from this release type: onError */
2238
+
2390
2239
  /**
2391
2240
  * This event is fired when all required data for playback is loaded and ready.
2392
2241
  * @remarks
@@ -2426,7 +2275,7 @@ export declare class AlphaTabApiBase<TSettings> {
2426
2275
  * ```
2427
2276
  */
2428
2277
  get playerReady(): IEventEmitter;
2429
- private onPlayerReady;
2278
+ private _onPlayerReady;
2430
2279
  /**
2431
2280
  * This event is fired when the playback of the whole song finished.
2432
2281
  * @remarks
@@ -2478,7 +2327,7 @@ export declare class AlphaTabApiBase<TSettings> {
2478
2327
  *
2479
2328
  */
2480
2329
  get playerFinished(): IEventEmitter;
2481
- private onPlayerFinished;
2330
+ private _onPlayerFinished;
2482
2331
  /**
2483
2332
  * This event is fired when the SoundFont needed for playback was loaded.
2484
2333
  *
@@ -2516,7 +2365,7 @@ export declare class AlphaTabApiBase<TSettings> {
2516
2365
  *
2517
2366
  */
2518
2367
  get soundFontLoaded(): IEventEmitter;
2519
- private onSoundFontLoaded;
2368
+ private _onSoundFontLoaded;
2520
2369
  /**
2521
2370
  * This event is fired when a Midi file is being loaded.
2522
2371
  *
@@ -2564,7 +2413,7 @@ export declare class AlphaTabApiBase<TSettings> {
2564
2413
  *
2565
2414
  */
2566
2415
  readonly midiLoad: IEventEmitterOfT<MidiFile>;
2567
- private onMidiLoad;
2416
+ private _onMidiLoad;
2568
2417
  /**
2569
2418
  * This event is fired when the Midi file needed for playback was loaded.
2570
2419
  *
@@ -2605,7 +2454,7 @@ export declare class AlphaTabApiBase<TSettings> {
2605
2454
  *
2606
2455
  */
2607
2456
  readonly midiLoaded: IEventEmitterOfT<PositionChangedEventArgs>;
2608
- private onMidiLoaded;
2457
+ private _onMidiLoaded;
2609
2458
  /**
2610
2459
  * This event is fired when the playback state changed.
2611
2460
  *
@@ -2643,7 +2492,7 @@ export declare class AlphaTabApiBase<TSettings> {
2643
2492
  *
2644
2493
  */
2645
2494
  get playerStateChanged(): IEventEmitterOfT<PlayerStateChangedEventArgs>;
2646
- private onPlayerStateChanged;
2495
+ private _onPlayerStateChanged;
2647
2496
  /**
2648
2497
  * This event is fired when the current playback position of the song changed.
2649
2498
  *
@@ -2681,7 +2530,7 @@ export declare class AlphaTabApiBase<TSettings> {
2681
2530
  *
2682
2531
  */
2683
2532
  get playerPositionChanged(): IEventEmitterOfT<PositionChangedEventArgs>;
2684
- private onPlayerPositionChanged;
2533
+ private _onPlayerPositionChanged;
2685
2534
  /**
2686
2535
  * This event is fired when the synthesizer played certain midi events.
2687
2536
  *
@@ -2762,7 +2611,7 @@ export declare class AlphaTabApiBase<TSettings> {
2762
2611
  * @see {@link SystemExclusiveEvent}
2763
2612
  */
2764
2613
  get midiEventsPlayed(): IEventEmitterOfT<MidiEventsPlayedEventArgs>;
2765
- private onMidiEventsPlayed;
2614
+ private _onMidiEventsPlayed;
2766
2615
  /**
2767
2616
  * This event is fired when the playback range changed.
2768
2617
  *
@@ -2816,7 +2665,7 @@ export declare class AlphaTabApiBase<TSettings> {
2816
2665
  *
2817
2666
  */
2818
2667
  get playbackRangeChanged(): IEventEmitterOfT<PlaybackRangeChangedEventArgs>;
2819
- private onPlaybackRangeChanged;
2668
+ private _onPlaybackRangeChanged;
2820
2669
  /**
2821
2670
  * This event is fired when a settings update was requested.
2822
2671
  *
@@ -2854,7 +2703,7 @@ export declare class AlphaTabApiBase<TSettings> {
2854
2703
  *
2855
2704
  */
2856
2705
  readonly settingsUpdated: IEventEmitter;
2857
- private onSettingsUpdated;
2706
+ private _onSettingsUpdated;
2858
2707
  /**
2859
2708
  * Loads and lists the available output devices which can be used by the player.
2860
2709
  * @returns the list of available devices or an empty list if there are no permissions, or the player is not enabled.
@@ -3010,11 +2859,17 @@ export declare class AlphaTabApiBase<TSettings> {
3010
2859
  exportAudio(options: AudioExportOptions): Promise<IAudioExporter>;
3011
2860
  }
3012
2861
 
2862
+ /**
2863
+ * @public
2864
+ */
3013
2865
  export declare class AlphaTabError extends Error {
3014
2866
  type: AlphaTabErrorType;
3015
2867
  constructor(type: AlphaTabErrorType, message?: string | null, inner?: Error);
3016
2868
  }
3017
2869
 
2870
+ /**
2871
+ * @public
2872
+ */
3018
2873
  export declare enum AlphaTabErrorType {
3019
2874
  General = 0,
3020
2875
  Format = 1,
@@ -3024,6 +2879,7 @@ export declare enum AlphaTabErrorType {
3024
2879
  /**
3025
2880
  * Represents a metronome event. This event is emitted by the synthesizer only during playback and
3026
2881
  * is typically not part of the midi file itself.
2882
+ * @public
3027
2883
  */
3028
2884
  declare class AlphaTabMetronomeEvent extends AlphaTabSysExEvent {
3029
2885
  /**
@@ -3048,6 +2904,7 @@ declare class AlphaTabMetronomeEvent extends AlphaTabSysExEvent {
3048
2904
 
3049
2905
  /**
3050
2906
  * Represents a REST beat being 'played'. This event supports alphaTab in placing the cursor.
2907
+ * @public
3051
2908
  */
3052
2909
  declare class AlphaTabRestEvent extends AlphaTabSysExEvent {
3053
2910
  channel: number;
@@ -3057,6 +2914,7 @@ declare class AlphaTabRestEvent extends AlphaTabSysExEvent {
3057
2914
 
3058
2915
  /**
3059
2916
  * The base class for alphaTab specific midi events (like metronomes and rests).
2917
+ * @public
3060
2918
  */
3061
2919
  declare abstract class AlphaTabSysExEvent extends MidiEvent {
3062
2920
  static readonly AlphaTabManufacturerId = 125;
@@ -3068,6 +2926,7 @@ declare abstract class AlphaTabSysExEvent extends MidiEvent {
3068
2926
 
3069
2927
  /**
3070
2928
  * @deprecated Move to the new concrete Midi Event Types.
2929
+ * @public
3071
2930
  */
3072
2931
  declare enum AlphaTabSystemExclusiveEvents {
3073
2932
  MetronomeTick = 0,
@@ -3076,151 +2935,34 @@ declare enum AlphaTabSystemExclusiveEvents {
3076
2935
 
3077
2936
  /**
3078
2937
  * This ScoreExporter can write alphaTex strings.
2938
+ * @public
3079
2939
  */
3080
2940
  declare class AlphaTexExporter extends ScoreExporter {
3081
- private static readonly DefaultScore;
3082
- private static readonly DefaultTrack;
2941
+ private static readonly _defaultScore;
2942
+ private static readonly _defaultTrack;
3083
2943
  get name(): string;
3084
2944
  exportToString(score: Score, settings?: Settings | null): string;
3085
2945
  writeScore(score: Score): void;
3086
2946
  scoreToAlphaTexString(score: Score): string;
3087
- private writeScoreTo;
3088
- private writeStyleSheetTo;
3089
- private writeTrackTo;
3090
- private writeStaffTo;
3091
- private writeBarTo;
3092
- private writeStaffMetaTo;
3093
- private writeChordTo;
3094
- private writeMasterBarMetaTo;
3095
- private writeBarMetaTo;
3096
- private writeVoiceTo;
3097
- private writeBeatTo;
3098
- private writeBeatEffectsTo;
3099
- private writeNoteTo;
3100
- private writeNoteEffectsTo;
3101
- }
3102
-
3103
- /**
3104
- * This importer can parse alphaTex markup into a score structure.
3105
- */
3106
- declare class AlphaTexImporter extends ScoreImporter {
3107
- private _trackChannel;
3108
- private _score;
3109
- private _currentTrack;
3110
- private _currentStaff;
3111
- private _barIndex;
3112
- private _voiceIndex;
3113
- private _initialTempo;
3114
- private _currentDuration;
3115
- private _currentDynamics;
3116
- private _currentTuplet;
3117
- private _lyrics;
3118
- private _ignoredInitialVoice;
3119
- private _staffHasExplicitDisplayTransposition;
3120
- private _staffDisplayTranspositionApplied;
3121
- private _staffHasExplicitTuning;
3122
- private _staffTuningApplied;
3123
- private _percussionArticulationNames;
3124
- private _sustainPedalToBeat;
3125
- private _slurs;
3126
- private _articulationValueToIndex;
3127
- private _lexer;
3128
- private _accidentalMode;
3129
- private _syncPoints;
3130
- logErrors: boolean;
3131
- get name(): string;
3132
- initFromString(tex: string, settings: Settings): void;
3133
- private get sy();
3134
- private get syData();
3135
- private set sy(value);
3136
- private newSy;
3137
- readScore(): Score;
3138
- private syncPoints;
3139
- private syncPoint;
3140
- private error;
3141
- private errorMessage;
3142
- /**
3143
- * Initializes the song with some required default values.
3144
- * @returns
3145
- */
3146
- private createDefaultScore;
3147
- private newTrack;
3148
- /**
3149
- * Converts a clef string into the clef value.
3150
- * @param str the string to convert
3151
- * @returns the clef value
3152
- */
3153
- private parseClefFromString;
3154
- /**
3155
- * Converts a clef tuning into the clef value.
3156
- * @param i the tuning value to convert
3157
- * @returns the clef value
3158
- */
3159
- private parseClefFromInt;
3160
- private parseTripletFeelFromString;
3161
- private parseTripletFeelFromInt;
3162
- /**
3163
- * Converts a keysignature string into the assocciated value.
3164
- * @param str the string to convert
3165
- * @returns the assocciated keysignature value
3166
- */
3167
- private parseKeySignature;
3168
- private parseKeySignatureType;
3169
- private metaData;
3170
- headerFooterStyle(element: ScoreSubElement): void;
3171
- private parseTrackNamePolicy;
3172
- private parseTrackNameMode;
3173
- private parseTrackNameOrientation;
3174
- private handleStaffMeta;
3175
- private readTrackInstrument;
3176
- private handleAccidentalMode;
3177
- private makeCurrentStaffPitched;
3178
- /**
3179
- * Encodes a given string to a shorthand text form without spaces or special characters
3180
- */
3181
- private static toArticulationId;
3182
- private applyPercussionStaff;
3183
- private chordProperties;
3184
- private bars;
3185
- private trackStaffMeta;
3186
- private handleNewVoice;
3187
- private beginStaff;
3188
- private trackProperties;
3189
- private staffProperties;
3190
- private bar;
3191
- private newBar;
3192
- private beat;
3193
- private beatDuration;
3194
- private beatEffects;
3195
- /**
3196
- * Tries to apply a beat effect to the given beat.
3197
- * @returns true if a effect could be applied, otherwise false
3198
- */
3199
- private applyBeatEffect;
3200
- private parseBracketExtendMode;
3201
- private parseFermataFromString;
3202
- private parseClefOttavaFromString;
3203
- private getChordId;
3204
- private static applyTuplet;
3205
- private isNoteText;
3206
- private note;
3207
- private noteEffects;
3208
- private harmonicValue;
3209
- private toFinger;
3210
- private parseDuration;
3211
- private parseBendStyle;
3212
- private parseBendType;
3213
- private barMeta;
3214
- private parseBarLineStyle;
3215
- private parseSimileMarkFromString;
3216
- private handleDirections;
3217
- private readTempoAutomation;
3218
- private applyAlternateEnding;
3219
- private parseWhammyType;
2947
+ private _writeScoreTo;
2948
+ private _writeStyleSheetTo;
2949
+ private _writeTrackTo;
2950
+ private _writeStaffTo;
2951
+ private _writeBarTo;
2952
+ private _writeStaffMetaTo;
2953
+ private _writeChordTo;
2954
+ private _writeMasterBarMetaTo;
2955
+ private _writeBarMetaTo;
2956
+ private _writeVoiceTo;
2957
+ private _writeBeatTo;
2958
+ private _writeBeatEffectsTo;
2959
+ private _writeNoteTo;
2960
+ private _writeNoteEffectsTo;
3220
2961
  }
3221
2962
 
3222
2963
  /**
3223
2964
  * Represents a single chunk of audio produced.
2965
+ * @public
3224
2966
  */
3225
2967
  declare class AudioExportChunk {
3226
2968
  /**
@@ -3247,6 +2989,7 @@ declare class AudioExportChunk {
3247
2989
 
3248
2990
  /**
3249
2991
  * The options controlling how to export the audio.
2992
+ * @public
3250
2993
  */
3251
2994
  declare class AudioExportOptions {
3252
2995
  /**
@@ -3312,6 +3055,7 @@ declare class AudioExportOptions {
3312
3055
  * @cloneable
3313
3056
  * @json
3314
3057
  * @json_strict
3058
+ * @public
3315
3059
  */
3316
3060
  declare class Automation {
3317
3061
  /**
@@ -3349,6 +3093,7 @@ declare class Automation {
3349
3093
 
3350
3094
  /**
3351
3095
  * This public enumeration lists all types of automations.
3096
+ * @public
3352
3097
  */
3353
3098
  declare enum AutomationType {
3354
3099
  /**
@@ -3381,6 +3126,7 @@ declare enum AutomationType {
3381
3126
  * Holds information about the backing track which can be played instead of synthesized audio.
3382
3127
  * @json
3383
3128
  * @json_strict
3129
+ * @public
3384
3130
  */
3385
3131
  declare class BackingTrack {
3386
3132
  /**
@@ -3392,6 +3138,7 @@ declare class BackingTrack {
3392
3138
 
3393
3139
  /**
3394
3140
  * Rerpresents a point to sync the alphaTab time axis with an external backing track.
3141
+ * @public
3395
3142
  */
3396
3143
  declare class BackingTrackSyncPoint {
3397
3144
  /**
@@ -3442,10 +3189,11 @@ declare class BackingTrackSyncPoint {
3442
3189
  * A bar is a single block within a track, also known as Measure.
3443
3190
  * @json
3444
3191
  * @json_strict
3192
+ * @public
3445
3193
  */
3446
3194
  declare class Bar {
3447
3195
  private static _globalBarId;
3448
- /* Excluded from this release type: resetIds */
3196
+
3449
3197
  /**
3450
3198
  * Gets or sets the unique id of this bar.
3451
3199
  */
@@ -3561,8 +3309,8 @@ declare class Bar {
3561
3309
  * The bar line to draw on the right side of the bar with an "automatic" type resolved to the actual one.
3562
3310
  */
3563
3311
  getActualBarLineRight(): BarLineStyle;
3564
- private static automaticToActualType;
3565
- private static actualBarLine;
3312
+ private static _automaticToActualType;
3313
+ private static _actualBarLine;
3566
3314
  /**
3567
3315
  * The style customizations for this item.
3568
3316
  */
@@ -3574,6 +3322,7 @@ declare class Bar {
3574
3322
 
3575
3323
  /**
3576
3324
  * Represents the boundaries of a single bar.
3325
+ * @public
3577
3326
  */
3578
3327
  declare class BarBounds {
3579
3328
  /**
@@ -3613,69 +3362,9 @@ declare class BarBounds {
3613
3362
  finish(scale?: number): void;
3614
3363
  }
3615
3364
 
3616
- declare class BarCollisionHelper {
3617
- reservedLayoutAreasByDisplayTime: Map<number, ReservedLayoutArea>;
3618
- restDurationsByDisplayTime: Map<number, Map<number, number>>;
3619
- getBeatMinMaxY(): number[];
3620
- reserveBeatSlot(beat: Beat, topY: number, bottomY: number): void;
3621
- registerRest(beat: Beat): void;
3622
- applyRestCollisionOffset(beat: Beat, currentY: number, linesToPixel: number): number;
3623
- }
3624
-
3625
- declare class BarHelpers {
3626
- private _renderer;
3627
- beamHelpers: BeamingHelper[][];
3628
- beamHelperLookup: Map<number, BeamingHelper>[];
3629
- collisionHelper: BarCollisionHelper;
3630
- preferredBeamDirection: BeamDirection | null;
3631
- constructor(renderer: BarRendererBase);
3632
- initialize(): void;
3633
- getBeamingHelperForBeat(beat: Beat): BeamingHelper;
3634
- }
3635
-
3636
- /**
3637
- * This public class stores size information about a stave.
3638
- * It is used by the layout engine to collect the sizes of score parts
3639
- * to align the parts across multiple staves.
3640
- */
3641
- declare class BarLayoutingInfo {
3642
- private static readonly MinDuration;
3643
- private static readonly MinDurationWidth;
3644
- private _timeSortedSprings;
3645
- private _minTime;
3646
- private _onTimePositionsForce;
3647
- private _onTimePositions;
3648
- private _incompleteGraceRodsWidth;
3649
- private _minDuration;
3650
- /**
3651
- * an internal version number that increments whenever a change was made.
3652
- */
3653
- version: number;
3654
- preBeatSize: number;
3655
- postBeatSize: number;
3656
- minStretchForce: number;
3657
- totalSpringConstant: number;
3658
- private updateMinStretchForce;
3659
- getPreBeatSize(beat: Beat): number;
3660
- getPostBeatSize(beat: Beat): number;
3661
- incompleteGraceRods: Map<string, Spring[]>;
3662
- allGraceRods: Map<string, Spring[]>;
3663
- springs: Map<number, Spring>;
3664
- addSpring(start: number, duration: number, graceBeatWidth: number, preBeatWidth: number, postSpringSize: number): Spring;
3665
- addBeatSpring(beat: Beat, preBeatSize: number, postBeatSize: number): void;
3666
- finish(): void;
3667
- private calculateSpringConstants;
3668
- height: number;
3669
- paint(_cx: number, _cy: number, _canvas: ICanvas): void;
3670
- private calculateSpringConstant;
3671
- spaceToForce(space: number): number;
3672
- calculateVoiceWidth(force: number): number;
3673
- private calculateWidth;
3674
- buildOnTimePositions(force: number): Map<number, number>;
3675
- }
3676
-
3677
3365
  /**
3678
3366
  * Lists all bar line styles.
3367
+ * @public
3679
3368
  */
3680
3369
  declare enum BarLineStyle {
3681
3370
  /**
@@ -3695,128 +3384,9 @@ declare enum BarLineStyle {
3695
3384
  Tick = 11
3696
3385
  }
3697
3386
 
3698
- /**
3699
- * This is the base public class for creating blocks which can render bars.
3700
- */
3701
- declare class BarRendererBase {
3702
- private _preBeatGlyphs;
3703
- private _voiceContainers;
3704
- private _postBeatGlyphs;
3705
- private _ties;
3706
- get nextRenderer(): BarRendererBase | null;
3707
- get previousRenderer(): BarRendererBase | null;
3708
- scoreRenderer: ScoreRenderer;
3709
- staff: RenderStaff;
3710
- layoutingInfo: BarLayoutingInfo;
3711
- bar: Bar;
3712
- additionalMultiRestBars: Bar[] | null;
3713
- get lastBar(): Bar;
3714
- x: number;
3715
- y: number;
3716
- width: number;
3717
- computedWidth: number;
3718
- height: number;
3719
- index: number;
3720
- topOverflow: number;
3721
- bottomOverflow: number;
3722
- helpers: BarHelpers;
3723
- /**
3724
- * Gets or sets whether this renderer is linked to the next one
3725
- * by some glyphs like a vibrato effect
3726
- */
3727
- isLinkedToPrevious: boolean;
3728
- /**
3729
- * Gets or sets whether this renderer can wrap to the next line
3730
- * or it needs to stay connected to the previous one.
3731
- * (e.g. when having double bar repeats we must not separate the 2 bars)
3732
- */
3733
- canWrap: boolean;
3734
- get showMultiBarRest(): boolean;
3735
- constructor(renderer: ScoreRenderer, bar: Bar);
3736
- registerTies(ties: Glyph[]): void;
3737
- get middleYPosition(): number;
3738
- registerOverflowTop(topOverflow: number): boolean;
3739
- registerOverflowBottom(bottomOverflow: number): boolean;
3740
- scaleToWidth(width: number): void;
3741
- get resources(): RenderingResources;
3742
- get smuflMetrics(): EngravingSettings;
3743
- get settings(): Settings;
3744
- /**
3745
- * Gets the scale with which the bar should be displayed in case the model
3746
- * scale should be respected.
3747
- */
3748
- get barDisplayScale(): number;
3749
- /**
3750
- * Gets the absolute width in which the bar should be displayed in case the model
3751
- * scale should be respected.
3752
- */
3753
- get barDisplayWidth(): number;
3754
- protected wasFirstOfLine: boolean;
3755
- get isFirstOfLine(): boolean;
3756
- get isLast(): boolean;
3757
- registerLayoutingInfo(): void;
3758
- private _appliedLayoutingInfo;
3759
- applyLayoutingInfo(): boolean;
3760
- isFinalized: boolean;
3761
- finalizeRenderer(): boolean;
3762
- /**
3763
- * Gets the top padding for the main content of the renderer.
3764
- * Can be used to specify where i.E. the score lines of the notation start.
3765
- * @returns
3766
- */
3767
- topPadding: number;
3768
- /**
3769
- * Gets the bottom padding for the main content of the renderer.
3770
- * Can be used to specify where i.E. the score lines of the notation end.
3771
- */
3772
- bottomPadding: number;
3773
- doLayout(): void;
3774
- protected hasVoiceContainer(voice: Voice): boolean;
3775
- protected updateSizes(): void;
3776
- protected addPreBeatGlyph(g: Glyph): void;
3777
- protected addBeatGlyph(g: BeatContainerGlyph): void;
3778
- protected getVoiceContainer(voice: Voice): VoiceContainerGlyph | undefined;
3779
- getBeatContainer(beat: Beat): BeatContainerGlyph | undefined;
3780
- getPreNotesGlyphForBeat(beat: Beat): BeatGlyphBase | undefined;
3781
- getOnNotesGlyphForBeat(beat: Beat): BeatOnNoteGlyphBase | undefined;
3782
- paint(cx: number, cy: number, canvas: ICanvas): void;
3783
- protected paintBackground(cx: number, cy: number, canvas: ICanvas): void;
3784
- buildBoundingsLookup(masterBarBounds: MasterBarBounds, cx: number, cy: number): void;
3785
- protected addPostBeatGlyph(g: Glyph): void;
3786
- protected createPreBeatGlyphs(): void;
3787
- protected createBeatGlyphs(): void;
3788
- protected createVoiceGlyphs(_v: Voice): void;
3789
- protected createPostBeatGlyphs(): void;
3790
- get beatGlyphsStart(): number;
3791
- get postBeatGlyphsStart(): number;
3792
- getBeatX(beat: Beat, requestedPosition?: BeatXPosition): number;
3793
- getRatioPositionX(ticks: number): number;
3794
- getNoteX(note: Note, requestedPosition: NoteXPosition): number;
3795
- getNoteY(note: Note, requestedPosition: NoteYPosition): number;
3796
- reLayout(): void;
3797
- protected recreatePreBeatGlyphs(): void;
3798
- protected paintSimileMark(cx: number, cy: number, canvas: ICanvas): void;
3799
- completeBeamingHelper(_helper: BeamingHelper): void;
3800
- getBeatDirection(beat: Beat): BeamDirection;
3801
- }
3802
-
3803
- /**
3804
- * This is the base public class for creating factories providing BarRenderers
3805
- */
3806
- declare abstract class BarRendererFactory {
3807
- isInsideBracket: boolean;
3808
- isRelevantForBoundsLookup: boolean;
3809
- hideOnMultiTrack: boolean;
3810
- hideOnPercussionTrack: boolean;
3811
- abstract get staffId(): string;
3812
- abstract getStaffPaddingTop(staff: RenderStaff): number;
3813
- abstract getStaffPaddingBottom(staff: RenderStaff): number;
3814
- canCreate(_track: Track, staff: Staff): boolean;
3815
- abstract create(renderer: ScoreRenderer, bar: Bar): BarRendererBase;
3816
- }
3817
-
3818
3387
  /**
3819
3388
  * Lists all beat barré types.
3389
+ * @public
3820
3390
  */
3821
3391
  declare enum BarreShape {
3822
3392
  /**
@@ -3837,12 +3407,14 @@ declare enum BarreShape {
3837
3407
  * Defines the custom styles for bars.
3838
3408
  * @json
3839
3409
  * @json_strict
3410
+ * @public
3840
3411
  */
3841
3412
  declare class BarStyle extends ElementStyle<BarSubElement> {
3842
3413
  }
3843
3414
 
3844
3415
  /**
3845
3416
  * Lists all graphical sub elements within a {@link Bar} which can be styled via {@link Bar.style}
3417
+ * @public
3846
3418
  */
3847
3419
  declare enum BarSubElement {
3848
3420
  /**
@@ -3943,103 +3515,25 @@ declare enum BarSubElement {
3943
3515
  NumberedStaffLine = 23
3944
3516
  }
3945
3517
 
3518
+ /**
3519
+ * @public
3520
+ */
3946
3521
  declare enum BeamDirection {
3947
3522
  Up = 0,
3948
3523
  Down = 1
3949
3524
  }
3950
3525
 
3951
- /**
3952
- * This public class helps drawing beams and bars for notes.
3953
- */
3954
- declare class BeamingHelper {
3955
- private _staff;
3956
- private _beatLineXPositions;
3957
- private _renderer;
3958
- private _firstNonRestBeat;
3959
- private _lastNonRestBeat;
3960
- voice: Voice | null;
3961
- beats: Beat[];
3962
- shortestDuration: Duration;
3963
- tremoloDuration?: Duration;
3964
- /**
3965
- * an indicator whether any beat has a tuplet on it.
3966
- */
3967
- hasTuplet: boolean;
3968
- slashBeats: Beat[];
3969
- lowestNoteInHelper: Note | null;
3970
- private _lowestNoteCompareValueInHelper;
3971
- highestNoteInHelper: Note | null;
3972
- private _highestNoteCompareValueInHelper;
3973
- invertBeamDirection: boolean;
3974
- preferredBeamDirection: BeamDirection | null;
3975
- graceType: GraceType;
3976
- minRestLine: number | null;
3977
- beatOfMinRestLine: Beat | null;
3978
- maxRestLine: number | null;
3979
- beatOfMaxRestLine: Beat | null;
3980
- get isRestBeamHelper(): boolean;
3981
- hasLine(forceFlagOnSingleBeat: boolean, beat?: Beat): boolean;
3982
- private beatHasLine;
3983
- hasFlag(forceFlagOnSingleBeat: boolean, beat?: Beat): boolean;
3984
- private beatHasFlag;
3985
- constructor(staff: Staff, renderer: BarRendererBase);
3986
- getBeatLineX(beat: Beat, direction?: BeamDirection): number;
3987
- hasBeatLineX(beat: Beat): boolean;
3988
- registerBeatLineX(staffId: string, beat: Beat, up: number, down: number): void;
3989
- private getOrCreateBeatPositions;
3990
- direction: BeamDirection;
3991
- finish(): void;
3992
- private calculateDirection;
3993
- static computeLineHeightsForRest(duration: Duration): number[];
3994
- /**
3995
- * Registers a rest beat within the accidental helper so the rest
3996
- * symbol is considered properly during beaming.
3997
- * @param beat The rest beat.
3998
- * @param line The line on which the rest symbol is placed
3999
- */
4000
- applyRest(beat: Beat, line: number): void;
4001
- private invert;
4002
- checkBeat(beat: Beat): boolean;
4003
- private checkNote;
4004
- private static canJoin;
4005
- private static canJoinDuration;
4006
- static isFullBarJoin(a: Beat, b: Beat, barIndex: number): boolean;
4007
- get beatOfLowestNote(): Beat;
4008
- get beatOfHighestNote(): Beat;
4009
- /**
4010
- * Returns whether the the position of the given beat, was registered by the staff of the given ID
4011
- * @param staffId
4012
- * @param beat
4013
- * @returns
4014
- */
4015
- isPositionFrom(staffId: string, beat: Beat): boolean;
4016
- drawingInfos: Map<BeamDirection, BeamingHelperDrawInfo>;
4017
- }
4018
-
4019
- declare class BeamingHelperDrawInfo {
4020
- startBeat: Beat | null;
4021
- startX: number;
4022
- startY: number;
4023
- endBeat: Beat | null;
4024
- endX: number;
4025
- endY: number;
4026
- /**
4027
- * calculates the Y-position given a X-pos using the current start end point
4028
- * @param x
4029
- */
4030
- calcY(x: number): number;
4031
- }
4032
-
4033
3526
  /**
4034
3527
  * A beat is a single block within a bar. A beat is a combination
4035
3528
  * of several notes played at the same time.
4036
3529
  * @json
4037
3530
  * @json_strict
4038
3531
  * @cloneable
3532
+ * @public
4039
3533
  */
4040
3534
  declare class Beat {
4041
3535
  private static _globalBeatId;
4042
- /* Excluded from this release type: resetIds */
3536
+
4043
3537
  /**
4044
3538
  * Gets or sets the unique id of this beat.
4045
3539
  * @clone_ignore
@@ -4406,7 +3900,7 @@ declare class Beat {
4406
3900
  removeNote(note: Note): void;
4407
3901
  getAutomation(type: AutomationType): Automation | null;
4408
3902
  getNoteOnString(noteString: number): Note | null;
4409
- private calculateDuration;
3903
+ private _calculateDuration;
4410
3904
  updateDurations(): void;
4411
3905
  finishTuplet(): void;
4412
3906
  finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void;
@@ -4429,6 +3923,7 @@ declare class Beat {
4429
3923
 
4430
3924
  /**
4431
3925
  * Lists the different modes on how beaming for a beat should be done.
3926
+ * @public
4432
3927
  */
4433
3928
  declare enum BeatBeamingMode {
4434
3929
  /**
@@ -4451,6 +3946,7 @@ declare enum BeatBeamingMode {
4451
3946
 
4452
3947
  /**
4453
3948
  * Represents the bounds of a single beat.
3949
+ * @public
4454
3950
  */
4455
3951
  declare class BeatBounds {
4456
3952
  /**
@@ -4496,65 +3992,18 @@ declare class BeatBounds {
4496
3992
  finish(scale?: number): void;
4497
3993
  }
4498
3994
 
4499
- declare class BeatContainerGlyph extends Glyph {
4500
- voiceContainer: VoiceContainerGlyph;
4501
- beat: Beat;
4502
- preNotes: BeatGlyphBase;
4503
- onNotes: BeatOnNoteGlyphBase;
4504
- ties: Glyph[];
4505
- minWidth: number;
4506
- get onTimeX(): number;
4507
- constructor(beat: Beat, voiceContainer: VoiceContainerGlyph);
4508
- addTie(tie: Glyph): void;
4509
- protected drawBeamHelperAsFlags(helper: BeamingHelper): boolean;
4510
- registerLayoutingInfo(layoutings: BarLayoutingInfo): void;
4511
- applyLayoutingInfo(_info: BarLayoutingInfo): void;
4512
- doLayout(): void;
4513
- protected updateWidth(): void;
4514
- scaleToWidth(beatWidth: number): void;
4515
- protected createTies(_n: Note): void;
4516
- static getGroupId(beat: Beat): string;
4517
- paint(cx: number, cy: number, canvas: ICanvas): void;
4518
- buildBoundingsLookup(barBounds: BarBounds, cx: number, cy: number, _isEmptyBar: boolean): void;
4519
- }
4520
-
4521
- declare class BeatGlyphBase extends GlyphGroup {
4522
- private _effectGlyphs;
4523
- private _normalGlyphs;
4524
- container: BeatContainerGlyph;
4525
- computedWidth: number;
4526
- constructor();
4527
- doLayout(): void;
4528
- protected noteLoop(action: (note: Note) => void): void;
4529
- addEffect(g: Glyph): void;
4530
- addNormal(g: Glyph): void;
4531
- protected get effectElement(): BeatSubElement | undefined;
4532
- paint(cx: number, cy: number, canvas: ICanvas): void;
4533
- private paintNormal;
4534
- private paintEffects;
4535
- }
4536
-
4537
- declare class BeatOnNoteGlyphBase extends BeatGlyphBase {
4538
- beamingHelper: BeamingHelper;
4539
- centerX: number;
4540
- updateBeamingHelper(): void;
4541
- buildBoundingsLookup(_beatBounds: BeatBounds, _cx: number, _cy: number): void;
4542
- getNoteX(_note: Note, _requestedPosition: NoteXPosition): number;
4543
- getNoteY(_note: Note, _requestedPosition: NoteYPosition): number;
4544
- getHighestNoteY(): number;
4545
- getLowestNoteY(): number;
4546
- }
4547
-
4548
3995
  /**
4549
3996
  * Defines the custom styles for beats.
4550
3997
  * @json
4551
3998
  * @json_strict
3999
+ * @public
4552
4000
  */
4553
4001
  declare class BeatStyle extends ElementStyle<BeatSubElement> {
4554
4002
  }
4555
4003
 
4556
4004
  /**
4557
4005
  * Lists all graphical sub elements within a {@link Beat} which can be styled via {@link Beat.style}
4006
+ * @public
4558
4007
  */
4559
4008
  declare enum BeatSubElement {
4560
4009
  /**
@@ -4658,6 +4107,7 @@ declare enum BeatSubElement {
4658
4107
 
4659
4108
  /**
4660
4109
  * Represents the time period, for which one or multiple {@link Beat}s are played
4110
+ * @public
4661
4111
  */
4662
4112
  declare class BeatTickLookup {
4663
4113
  private _highlightedBeats;
@@ -4705,6 +4155,7 @@ declare class BeatTickLookup {
4705
4155
 
4706
4156
  /**
4707
4157
  * Represents a beat and when it is actually played according to the generated audio.
4158
+ * @public
4708
4159
  */
4709
4160
  declare class BeatTickLookupItem {
4710
4161
  /**
@@ -4718,43 +4169,13 @@ declare class BeatTickLookupItem {
4718
4169
  constructor(beat: Beat, playbackStart: number);
4719
4170
  }
4720
4171
 
4721
- /**
4722
- * Lists the different position modes for {@link BarRendererBase.getBeatX}
4723
- */
4724
- declare enum BeatXPosition {
4725
- /**
4726
- * Gets the pre-notes position which is located before the accidentals
4727
- */
4728
- PreNotes = 0,
4729
- /**
4730
- * Gets the on-notes position which is located after the accidentals but before the note heads.
4731
- */
4732
- OnNotes = 1,
4733
- /**
4734
- * Gets the middle-notes position which is located after in the middle the note heads.
4735
- */
4736
- MiddleNotes = 2,
4737
- /**
4738
- * Gets position of the stem for this beat
4739
- */
4740
- Stem = 3,
4741
- /**
4742
- * Get the post-notes position which is located at after the note heads.
4743
- */
4744
- PostNotes = 4,
4745
- /**
4746
- * Get the end-beat position which is located at the end of the beat. This position is almost
4747
- * equal to the pre-notes position of the next beat.
4748
- */
4749
- EndBeat = 5
4750
- }
4751
-
4752
4172
  /**
4753
4173
  * A single point of a bending graph. Used to
4754
4174
  * describe WhammyBar and String Bending effects.
4755
4175
  * @cloneable
4756
4176
  * @json
4757
4177
  * @json_strict
4178
+ * @public
4758
4179
  */
4759
4180
  declare class BendPoint {
4760
4181
  static readonly MaxPosition: number;
@@ -4777,6 +4198,7 @@ declare class BendPoint {
4777
4198
 
4778
4199
  /**
4779
4200
  * Lists the different bend styles
4201
+ * @public
4780
4202
  */
4781
4203
  declare enum BendStyle {
4782
4204
  /**
@@ -4795,6 +4217,7 @@ declare enum BendStyle {
4795
4217
 
4796
4218
  /**
4797
4219
  * Lists all types of bends
4220
+ * @public
4798
4221
  */
4799
4222
  declare enum BendType {
4800
4223
  /**
@@ -4841,6 +4264,7 @@ declare enum BendType {
4841
4264
 
4842
4265
  /**
4843
4266
  * Represents a rectangular area within the renderer music notation.
4267
+ * @public
4844
4268
  */
4845
4269
  declare class Bounds {
4846
4270
  /**
@@ -4862,6 +4286,9 @@ declare class Bounds {
4862
4286
  scaleWith(scale: number): void;
4863
4287
  }
4864
4288
 
4289
+ /**
4290
+ * @public
4291
+ */
4865
4292
  declare class BoundsLookup {
4866
4293
  /**
4867
4294
  * @target web
@@ -4874,11 +4301,11 @@ declare class BoundsLookup {
4874
4301
  /**
4875
4302
  * @target web
4876
4303
  */
4877
- private static boundsFromJson;
4304
+ private static _boundsFromJson;
4878
4305
  /**
4879
4306
  * @target web
4880
4307
  */
4881
- private boundsToJson;
4308
+ private _boundsToJson;
4882
4309
  private _beatLookup;
4883
4310
  private _masterBarLookup;
4884
4311
  private _currentStaffSystem;
@@ -4953,6 +4380,7 @@ declare class BoundsLookup {
4953
4380
 
4954
4381
  /**
4955
4382
  * Lists the different modes on how the brackets/braces are drawn and extended.
4383
+ * @public
4956
4384
  */
4957
4385
  declare enum BracketExtendMode {
4958
4386
  /**
@@ -4973,6 +4401,7 @@ declare enum BracketExtendMode {
4973
4401
 
4974
4402
  /**
4975
4403
  * Lists all types of how to brush multiple notes on a beat.
4404
+ * @public
4976
4405
  */
4977
4406
  declare enum BrushType {
4978
4407
  /**
@@ -4997,6 +4426,9 @@ declare enum BrushType {
4997
4426
  ArpeggioDown = 4
4998
4427
  }
4999
4428
 
4429
+ /**
4430
+ * @public
4431
+ */
5000
4432
  declare class ByteBuffer implements IWriteable, IReadable {
5001
4433
  private _buffer;
5002
4434
  length: number;
@@ -5013,7 +4445,7 @@ declare class ByteBuffer implements IWriteable, IReadable {
5013
4445
  read(buffer: Uint8Array, offset: number, count: number): number;
5014
4446
  writeByte(value: number): void;
5015
4447
  write(buffer: Uint8Array, offset: number, count: number): void;
5016
- private ensureCapacity;
4448
+ private _ensureCapacity;
5017
4449
  readAll(): Uint8Array;
5018
4450
  toArray(): Uint8Array;
5019
4451
  copyTo(destination: IWriteable): void;
@@ -5023,6 +4455,7 @@ declare class ByteBuffer implements IWriteable, IReadable {
5023
4455
  * A chord definition.
5024
4456
  * @json
5025
4457
  * @json_strict
4458
+ * @public
5026
4459
  */
5027
4460
  declare class Chord {
5028
4461
  /**
@@ -5066,52 +4499,9 @@ declare class Chord {
5066
4499
  get uniqueId(): string;
5067
4500
  }
5068
4501
 
5069
- declare class ChordDiagramContainerGlyph extends RowContainerGlyph {
5070
- addChord(chord: Chord): void;
5071
- paint(cx: number, cy: number, canvas: ICanvas): void;
5072
- }
5073
-
5074
- /**
5075
- * Represents a fixed size circular sample buffer that can be written to and read from.
5076
- * @csharp_public
5077
- */
5078
- declare class CircularSampleBuffer {
5079
- private _buffer;
5080
- private _writePosition;
5081
- private _readPosition;
5082
- /**
5083
- * Gets the number of samples written to the buffer.
5084
- */
5085
- count: number;
5086
- /**
5087
- * Initializes a new instance of the {@link CircularSampleBuffer} class.
5088
- * @param size The size.
5089
- */
5090
- constructor(size: number);
5091
- /**
5092
- * Clears all samples written to this buffer.
5093
- */
5094
- clear(): void;
5095
- /**
5096
- * Writes the given samples to this buffer.
5097
- * @param data The sample array to read from.
5098
- * @param offset
5099
- * @param count
5100
- * @returns
5101
- */
5102
- write(data: Float32Array, offset: number, count: number): number;
5103
- /**
5104
- * Reads the requested amount of samples from the buffer.
5105
- * @param data The sample array to store the read elements.
5106
- * @param offset The offset within the destination buffer to put the items at.
5107
- * @param count The number of items to read from this buffer.
5108
- * @returns The number of items actually read from the buffer.
5109
- */
5110
- read(data: Float32Array, offset: number, count: number): number;
5111
- }
5112
-
5113
4502
  /**
5114
4503
  * This public enumeration lists all supported Clefs.
4504
+ * @public
5115
4505
  */
5116
4506
  declare enum Clef {
5117
4507
  /**
@@ -5138,6 +4528,7 @@ declare enum Clef {
5138
4528
 
5139
4529
  /**
5140
4530
  * @json_immutable
4531
+ * @public
5141
4532
  */
5142
4533
  declare class Color {
5143
4534
  static readonly BlackRgb: string;
@@ -5173,12 +4564,16 @@ declare class Color {
5173
4564
  * If provided as number a raw RGBA value needs to be used.
5174
4565
  *
5175
4566
  * @target web
4567
+ * @public
5176
4568
  */
5177
4569
  declare type ColorJson = Color | string | number;
5178
4570
 
4571
+ /**
4572
+ * @public
4573
+ */
5179
4574
  export declare class ConsoleLogger implements ILogger {
5180
4575
  static logLevel: LogLevel;
5181
- private static format;
4576
+ private static _format;
5182
4577
  debug(category: string, msg: string, ...details: unknown[]): void;
5183
4578
  warning(category: string, msg: string, ...details: unknown[]): void;
5184
4579
  info(category: string, msg: string, ...details: unknown[]): void;
@@ -5187,6 +4582,7 @@ export declare class ConsoleLogger implements ILogger {
5187
4582
 
5188
4583
  /**
5189
4584
  * Represents the change of a value on a midi controller.
4585
+ * @public
5190
4586
  */
5191
4587
  declare class ControlChangeEvent extends MidiEvent {
5192
4588
  /**
@@ -5209,6 +4605,7 @@ declare class ControlChangeEvent extends MidiEvent {
5209
4605
 
5210
4606
  /**
5211
4607
  * Lists all midi controllers.
4608
+ * @public
5212
4609
  */
5213
4610
  declare enum ControllerType {
5214
4611
  /**
@@ -5295,6 +4692,7 @@ declare enum ControllerType {
5295
4692
  * All main settings of alphaTab controlling rather general aspects of its behavior.
5296
4693
  * @json
5297
4694
  * @json_declaration
4695
+ * @public
5298
4696
  */
5299
4697
  export declare class CoreSettings {
5300
4698
  /**
@@ -5475,6 +4873,7 @@ export declare class CoreSettings {
5475
4873
  * All main settings of alphaTab controlling rather general aspects of its behavior.
5476
4874
  * @json
5477
4875
  * @json_declaration
4876
+ * @public
5478
4877
  * @target web
5479
4878
  */
5480
4879
  declare interface CoreSettingsJson {
@@ -5643,6 +5042,7 @@ declare interface CoreSettingsJson {
5643
5042
 
5644
5043
  /**
5645
5044
  * Lists all Crescendo and Decrescendo types.
5045
+ * @public
5646
5046
  */
5647
5047
  declare enum CrescendoType {
5648
5048
  /**
@@ -5659,17 +5059,9 @@ declare enum CrescendoType {
5659
5059
  Decrescendo = 2
5660
5060
  }
5661
5061
 
5662
- /**
5663
- * This SVG canvas renders the music symbols by adding a CSS class 'at' to all elements.
5664
- */
5665
- declare class CssFontSvgCanvas extends SvgCanvas {
5666
- fillMusicFontSymbol(x: number, y: number, relativeScale: number, symbol: MusicFontSymbol, centerAtPosition?: boolean): void;
5667
- fillMusicFontSymbols(x: number, y: number, relativeScale: number, symbols: MusicFontSymbol[], centerAtPosition?: boolean): void;
5668
- private fillMusicFontSymbolText;
5669
- }
5670
-
5671
5062
  /**
5672
5063
  * This wrapper holds all cursor related elements.
5064
+ * @public
5673
5065
  */
5674
5066
  declare class Cursors {
5675
5067
  /**
@@ -5700,6 +5092,7 @@ declare class Cursors {
5700
5092
 
5701
5093
  /**
5702
5094
  * @deprecated Move to the new concrete Midi Event Types.
5095
+ * @public
5703
5096
  */
5704
5097
  declare class DeprecatedMidiEvent extends MidiEvent {
5705
5098
  constructor();
@@ -5708,6 +5101,7 @@ declare class DeprecatedMidiEvent extends MidiEvent {
5708
5101
 
5709
5102
  /**
5710
5103
  * Lists all directions which can be applied to a masterbar.
5104
+ * @public
5711
5105
  */
5712
5106
  declare enum Direction {
5713
5107
  TargetFine = 0,
@@ -5735,6 +5129,7 @@ declare enum Direction {
5735
5129
  * The display settings control how the general layout and display of alphaTab is done.
5736
5130
  * @json
5737
5131
  * @json_declaration
5132
+ * @public
5738
5133
  */
5739
5134
  export declare class DisplaySettings {
5740
5135
  /**
@@ -6058,6 +5453,7 @@ export declare class DisplaySettings {
6058
5453
  * The display settings control how the general layout and display of alphaTab is done.
6059
5454
  * @json
6060
5455
  * @json_declaration
5456
+ * @public
6061
5457
  * @target web
6062
5458
  */
6063
5459
  declare interface DisplaySettingsJson {
@@ -6380,6 +5776,7 @@ declare interface DisplaySettingsJson {
6380
5776
 
6381
5777
  /**
6382
5778
  * Lists all durations of a beat.
5779
+ * @public
6383
5780
  */
6384
5781
  declare enum Duration {
6385
5782
  /**
@@ -6430,6 +5827,7 @@ declare enum Duration {
6430
5827
 
6431
5828
  /**
6432
5829
  * Lists all dynamics.
5830
+ * @public
6433
5831
  */
6434
5832
  declare enum DynamicValue {
6435
5833
  /**
@@ -6520,30 +5918,9 @@ declare enum DynamicValue {
6520
5918
  SFZP = 25
6521
5919
  }
6522
5920
 
6523
- /**
6524
- * Effect-Glyphs implementing this public interface get notified
6525
- * as they are expanded over multiple beats.
6526
- */
6527
- declare class EffectGlyph extends Glyph {
6528
- /**
6529
- * Gets or sets the beat where the glyph belongs to.
6530
- */
6531
- beat: Beat | null;
6532
- /**
6533
- * Gets or sets the next glyph of the same type in case
6534
- * the effect glyph is expanded when using {@link EffectBarGlyphSizing.groupedOnBeat}.
6535
- */
6536
- nextGlyph: EffectGlyph | null;
6537
- /**
6538
- * Gets or sets the previous glyph of the same type in case
6539
- * the effect glyph is expanded when using {@link EffectBarGlyphSizing.groupedOnBeat}.
6540
- */
6541
- previousGlyph: EffectGlyph | null;
6542
- constructor(x?: number, y?: number);
6543
- }
6544
-
6545
5921
  /**
6546
5922
  * Defines the custom styles for an element in the music sheet (like bars, voices, notes etc).
5923
+ * @public
6547
5924
  */
6548
5925
  declare class ElementStyle<TSubElements extends number> {
6549
5926
  /**
@@ -6556,6 +5933,7 @@ declare class ElementStyle<TSubElements extends number> {
6556
5933
 
6557
5934
  /**
6558
5935
  * Represents the end of the track indicating that no more events for this track follow.
5936
+ * @public
6559
5937
  */
6560
5938
  declare class EndOfTrackEvent extends MidiEvent {
6561
5939
  constructor(track: number, tick: number);
@@ -6583,6 +5961,7 @@ declare class EndOfTrackEvent extends MidiEvent {
6583
5961
  * @json
6584
5962
  * @json_declaration
6585
5963
  * @cloneable
5964
+ * @public
6586
5965
  */
6587
5966
  export declare class EngravingSettings {
6588
5967
  private static _bravuraDefaults?;
@@ -6765,15 +6144,15 @@ export declare class EngravingSettings {
6765
6144
  * @smufl 1.4
6766
6145
  */
6767
6146
  glyphHeights: Map<MusicFontSymbol, number>;
6768
- /* Excluded from this release type: hasSymbol */
6147
+
6769
6148
  /**
6770
6149
  * Fills the engraving settings from the provided smufl metdata.
6771
6150
  * @param smufl The metadata shipped together with the SMuFL fonts.
6772
6151
  * @param musicFontSize The font size to configure in alphaTab for the music font.
6773
6152
  */
6774
6153
  fillFromSmufl(smufl: SmuflMetadata, musicFontSize?: number): void;
6775
- /* Excluded from this release type: smuflNameToGlyphNameMapping */
6776
- private static smuflNameToMusicFontSymbol;
6154
+
6155
+ private static _smuflNameToMusicFontSymbol;
6777
6156
  /**
6778
6157
  * The size of the bars drawn in numbered notation to indicate the durations.
6779
6158
  */
@@ -6982,6 +6361,7 @@ export declare class EngravingSettings {
6982
6361
  * @json
6983
6362
  * @json_declaration
6984
6363
  * @cloneable
6364
+ * @public
6985
6365
  * @target web
6986
6366
  */
6987
6367
  declare interface EngravingSettingsJson {
@@ -7349,6 +6729,7 @@ declare interface EngravingSettingsJson {
7349
6729
  /**
7350
6730
  * @json
7351
6731
  * @json_declaration
6732
+ * @public
7352
6733
  */
7353
6734
  export declare class EngravingStemInfo {
7354
6735
  /**
@@ -7368,6 +6749,7 @@ export declare class EngravingStemInfo {
7368
6749
  /**
7369
6750
  * @json
7370
6751
  * @json_declaration
6752
+ * @public
7371
6753
  * @target web
7372
6754
  */
7373
6755
  declare interface EngravingStemInfoJson {
@@ -7393,21 +6775,22 @@ declare interface EngravingStemInfoJson {
7393
6775
  * alphaTab looks for information like available layout engines
7394
6776
  * staves etc.
7395
6777
  * @partial
6778
+ * @public
7396
6779
  */
7397
6780
  export declare class Environment {
7398
- private static readonly StaffIdBeforeSlashAlways;
7399
- private static readonly StaffIdBeforeScoreAlways;
7400
- private static readonly StaffIdBeforeScoreHideable;
7401
- private static readonly StaffIdBeforeNumberedAlways;
7402
- private static readonly StaffIdBeforeTabAlways;
7403
- private static readonly StaffIdBeforeTabHideable;
7404
- private static readonly StaffIdBeforeEndAlways;
7405
- /* Excluded from this release type: HighDpiFactor */
6781
+ private static readonly _staffIdBeforeSlashAlways;
6782
+ private static readonly _staffIdBeforeScoreAlways;
6783
+ private static readonly _staffIdBeforeScoreHideable;
6784
+ private static readonly _staffIdBeforeNumberedAlways;
6785
+ private static readonly _staffIdBeforeTabAlways;
6786
+ private static readonly _staffIdBeforeTabHideable;
6787
+ private static readonly _staffIdBeforeEndAlways;
6788
+
7406
6789
  /**
7407
6790
  * @target web
7408
6791
  */
7409
6792
  private static _globalThis;
7410
- /* Excluded from this release type: globalThis */
6793
+
7411
6794
  /**
7412
6795
  * @target web
7413
6796
  */
@@ -7436,8 +6819,8 @@ export declare class Environment {
7436
6819
  * @target web
7437
6820
  */
7438
6821
  static get isRunningInAudioWorklet(): boolean;
7439
- /* Excluded from this release type: createWebWorker */
7440
- /* Excluded from this release type: createAudioWorklet */
6822
+
6823
+
7441
6824
  /**
7442
6825
  * @target web
7443
6826
  * @partial
@@ -7446,28 +6829,28 @@ export declare class Environment {
7446
6829
  /**
7447
6830
  * @target web
7448
6831
  */
7449
- private static detectScriptFile;
7450
- /* Excluded from this release type: ensureFullUrl */
7451
- private static appendScriptName;
6832
+ private static _detectScriptFile;
6833
+
6834
+ private static _appendScriptName;
7452
6835
  /**
7453
6836
  * @target web
7454
6837
  */
7455
- private static detectFontDirectory;
6838
+ private static _detectFontDirectory;
7456
6839
  /**
7457
6840
  * @target web
7458
6841
  */
7459
- private static registerJQueryPlugin;
6842
+ private static _registerJQueryPlugin;
7460
6843
  static readonly renderEngines: Map<string, RenderEngineFactory>;
7461
- /* Excluded from this release type: layoutEngines */
7462
- /* Excluded from this release type: staveProfiles */
6844
+
6845
+
7463
6846
  static getRenderEngineFactory(engine: string): RenderEngineFactory;
7464
- /* Excluded from this release type: getLayoutEngineFactory */
6847
+
7465
6848
  /**
7466
6849
  * Gets all default ScoreImporters
7467
6850
  * @returns
7468
6851
  */
7469
6852
  static buildImporters(): ScoreImporter[];
7470
- private static createDefaultRenderEngines;
6853
+ private static _createDefaultRenderEngines;
7471
6854
  /**
7472
6855
  * Enables the usage of alphaSkia as rendering backend.
7473
6856
  * @param musicFontData The raw binary data of the music font.
@@ -7484,16 +6867,16 @@ export declare class Environment {
7484
6867
  * @target web
7485
6868
  * @partial
7486
6869
  */
7487
- private static createPlatformSpecificRenderEngines;
7488
- private static createDefaultRenderers;
7489
- private static createDefaultStaveProfiles;
7490
- private static createDefaultLayoutEngines;
6870
+ private static _createPlatformSpecificRenderEngines;
6871
+ private static _createDefaultRenderers;
6872
+ private static _createDefaultStaveProfiles;
6873
+ private static _createDefaultLayoutEngines;
7491
6874
  /**
7492
6875
  * @target web
7493
6876
  */
7494
6877
  static initializeMain(createWebWorker: (settings: Settings) => Worker, createAudioWorklet: (context: AudioContext, settings: Settings) => Promise<void>): void;
7495
- /* Excluded from this release type: alphaTabWorker */
7496
- /* Excluded from this release type: alphaTabUrl */
6878
+
6879
+
7497
6880
  /**
7498
6881
  * @target web
7499
6882
  */
@@ -7505,15 +6888,15 @@ export declare class Environment {
7505
6888
  /**
7506
6889
  * @target web
7507
6890
  */
7508
- private static detectWebPack;
6891
+ private static _detectWebPack;
7509
6892
  /**
7510
6893
  * @target web
7511
6894
  */
7512
- private static detectVite;
6895
+ private static _detectVite;
7513
6896
  /**
7514
6897
  * @target web
7515
6898
  */
7516
- private static detectWebPlatform;
6899
+ private static _detectWebPlatform;
7517
6900
  /**
7518
6901
  * Prints the environment information for easier troubleshooting.
7519
6902
  * @param force Whether to force printing.
@@ -7523,9 +6906,9 @@ export declare class Environment {
7523
6906
  * @target web
7524
6907
  * @partial
7525
6908
  */
7526
- private static printPlatformInfo;
7527
- /* Excluded from this release type: prepareForPostMessage */
7528
- /* Excluded from this release type: quoteJsonString */
6909
+ private static _printPlatformInfo;
6910
+
6911
+
7529
6912
  }
7530
6913
 
7531
6914
  export declare namespace exporter {
@@ -7540,6 +6923,7 @@ export declare namespace exporter {
7540
6923
  * All settings related to exporters that encode file formats.
7541
6924
  * @json
7542
6925
  * @json_declaration
6926
+ * @public
7543
6927
  */
7544
6928
  export declare class ExporterSettings {
7545
6929
  /**
@@ -7563,6 +6947,7 @@ export declare class ExporterSettings {
7563
6947
  * All settings related to exporters that encode file formats.
7564
6948
  * @json
7565
6949
  * @json_declaration
6950
+ * @public
7566
6951
  * @target web
7567
6952
  */
7568
6953
  declare interface ExporterSettingsJson {
@@ -7585,6 +6970,7 @@ declare interface ExporterSettingsJson {
7585
6970
 
7586
6971
  /**
7587
6972
  * Lists the different fade types.
6973
+ * @public
7588
6974
  */
7589
6975
  declare enum FadeType {
7590
6976
  /**
@@ -7609,6 +6995,7 @@ declare enum FadeType {
7609
6995
  * Represents a fermata.
7610
6996
  * @json
7611
6997
  * @json_strict
6998
+ * @public
7612
6999
  */
7613
7000
  declare class Fermata {
7614
7001
  /**
@@ -7623,6 +7010,7 @@ declare class Fermata {
7623
7010
 
7624
7011
  /**
7625
7012
  * Lists all types of fermatas
7013
+ * @public
7626
7014
  */
7627
7015
  declare enum FermataType {
7628
7016
  /**
@@ -7641,6 +7029,7 @@ declare enum FermataType {
7641
7029
 
7642
7030
  /**
7643
7031
  * @target web
7032
+ * @public
7644
7033
  */
7645
7034
  export declare class FileLoadError extends AlphaTabError {
7646
7035
  xhr: XMLHttpRequest;
@@ -7649,6 +7038,7 @@ export declare class FileLoadError extends AlphaTabError {
7649
7038
 
7650
7039
  /**
7651
7040
  * Lists all modes on how fingerings should be displayed.
7041
+ * @public
7652
7042
  */
7653
7043
  export declare enum FingeringMode {
7654
7044
  /**
@@ -7675,6 +7065,7 @@ export declare enum FingeringMode {
7675
7065
 
7676
7066
  /**
7677
7067
  * Lists all fingers.
7068
+ * @public
7678
7069
  */
7679
7070
  declare enum Fingers {
7680
7071
  /**
@@ -7710,6 +7101,7 @@ declare enum Fingers {
7710
7101
  /**
7711
7102
  * A simple flat sync point for easy persistence separate to the main data model.
7712
7103
  * @record
7104
+ * @public
7713
7105
  */
7714
7106
  declare interface FlatSyncPoint {
7715
7107
  /**
@@ -7733,6 +7125,7 @@ declare interface FlatSyncPoint {
7733
7125
 
7734
7126
  /**
7735
7127
  * @json_immutable
7128
+ * @public
7736
7129
  */
7737
7130
  declare class Font {
7738
7131
  private _css;
@@ -7741,7 +7134,7 @@ declare class Font {
7741
7134
  private _style;
7742
7135
  private _weight;
7743
7136
  private _size;
7744
- private reset;
7137
+ private _reset;
7745
7138
  /**
7746
7139
  * Gets the first font family name.
7747
7140
  * @deprecated Consider using {@link families} for multi font family support.
@@ -7811,6 +7204,7 @@ declare class Font {
7811
7204
  /**
7812
7205
  * Lists the known file formats for font files.
7813
7206
  * @target web
7207
+ * @public
7814
7208
  */
7815
7209
  export declare enum FontFileFormat {
7816
7210
  /**
@@ -7843,6 +7237,7 @@ export declare enum FontFileFormat {
7843
7237
  * Describes a font to be used.
7844
7238
  * If specified as string, a CSS `font` shorthand property compliant value needs to be used.
7845
7239
  * @target web
7240
+ * @public
7846
7241
  */
7847
7242
  declare type FontJson = Font | string | {
7848
7243
  families: string[];
@@ -7851,38 +7246,9 @@ declare type FontJson = Font | string | {
7851
7246
  weight: FontWeight | keyof typeof FontWeight;
7852
7247
  };
7853
7248
 
7854
- /**
7855
- * Describes the sizes of a font for measuring purposes.
7856
- */
7857
- declare class FontSizeDefinition {
7858
- /**
7859
- * The widths of each character starting with the ascii code 0x20 at index 0.
7860
- */
7861
- characterWidths: Uint8Array;
7862
- /**
7863
- * The heights of each character starting with the ascii code 0x20 at index 0.
7864
- */
7865
- characterHeights: Uint8Array;
7866
- constructor(characterWidths: Uint8Array, characterHeights: Uint8Array);
7867
- }
7868
-
7869
- /**
7870
- * This public class stores text widths for several fonts and allows width calculation
7871
- * @partial
7872
- */
7873
- declare class FontSizes {
7874
- static FontSizeLookupTables: Map<string, FontSizeDefinition>;
7875
- static readonly ControlChars: number;
7876
- /**
7877
- * @target web
7878
- * @partial
7879
- */
7880
- static generateFontLookup(family: string): void;
7881
- static measureString(s: string, families: string[], size: number, style: FontStyle, weight: FontWeight): MeasuredText;
7882
- }
7883
-
7884
7249
  /**
7885
7250
  * Lists all flags for font styles.
7251
+ * @public
7886
7252
  */
7887
7253
  declare enum FontStyle {
7888
7254
  /**
@@ -7897,6 +7263,7 @@ declare enum FontStyle {
7897
7263
 
7898
7264
  /**
7899
7265
  * Lists all font weight values.
7266
+ * @public
7900
7267
  */
7901
7268
  declare enum FontWeight {
7902
7269
  /**
@@ -7911,42 +7278,15 @@ declare enum FontWeight {
7911
7278
 
7912
7279
  /**
7913
7280
  * An invalid input format was detected (e.g. invalid setting values, file formats,...)
7281
+ * @public
7914
7282
  */
7915
7283
  export declare class FormatError extends AlphaTabError {
7916
7284
  constructor(message: string);
7917
7285
  }
7918
7286
 
7919
7287
  /**
7920
- * A glyph is a single symbol which can be added to a GlyphBarRenderer for automated
7921
- * layouting and drawing of stacked symbols.
7922
- */
7923
- declare class Glyph {
7924
- x: number;
7925
- y: number;
7926
- width: number;
7927
- height: number;
7928
- renderer: BarRendererBase;
7929
- constructor(x: number, y: number);
7930
- getBoundingBoxTop(): number;
7931
- doLayout(): void;
7932
- paint(_cx: number, _cy: number, _canvas: ICanvas): void;
7933
- }
7934
-
7935
- /**
7936
- * This glyph allows to group several other glyphs to be
7937
- * drawn at the same x position
7938
- */
7939
- declare class GlyphGroup extends Glyph {
7940
- glyphs: Glyph[] | null;
7941
- get isEmpty(): boolean;
7942
- getBoundingBoxTop(): number;
7943
- doLayout(): void;
7944
- addGlyph(g: Glyph): void;
7945
- paint(cx: number, cy: number, canvas: ICanvas): void;
7946
- }
7947
-
7948
- /**
7949
- * Lists all golpe types.
7288
+ * Lists all golpe types.
7289
+ * @public
7950
7290
  */
7951
7291
  declare enum GolpeType {
7952
7292
  /**
@@ -7965,6 +7305,7 @@ declare enum GolpeType {
7965
7305
 
7966
7306
  /**
7967
7307
  * This ScoreExporter can write Guitar Pro 7+ (gp) files.
7308
+ * @public
7968
7309
  */
7969
7310
  declare class Gp7Exporter extends ScoreExporter {
7970
7311
  get name(): string;
@@ -7973,6 +7314,7 @@ declare class Gp7Exporter extends ScoreExporter {
7973
7314
 
7974
7315
  /**
7975
7316
  * Represents a group of grace beats that belong together
7317
+ * @public
7976
7318
  */
7977
7319
  declare class GraceGroup {
7978
7320
  /**
@@ -7998,6 +7340,7 @@ declare class GraceGroup {
7998
7340
 
7999
7341
  /**
8000
7342
  * Lists all types of grace notes
7343
+ * @public
8001
7344
  */
8002
7345
  declare enum GraceType {
8003
7346
  /**
@@ -8020,6 +7363,7 @@ declare enum GraceType {
8020
7363
 
8021
7364
  /**
8022
7365
  * Lists all harmonic types.
7366
+ * @public
8023
7367
  */
8024
7368
  declare enum HarmonicType {
8025
7369
  /**
@@ -8056,6 +7400,7 @@ declare enum HarmonicType {
8056
7400
  * The additional style and display information for header and footer elements.
8057
7401
  * @json
8058
7402
  * @json_strict
7403
+ * @public
8059
7404
  */
8060
7405
  declare class HeaderFooterStyle {
8061
7406
  /**
@@ -8081,121 +7426,12 @@ declare class HeaderFooterStyle {
8081
7426
  textAlign: TextAlign;
8082
7427
  constructor(template?: string, isVisible?: boolean | undefined, textAlign?: TextAlign);
8083
7428
  buildText(score: Score): string;
8084
- private static readonly PlaceholderPattern;
8085
- }
8086
-
8087
- declare class Hydra {
8088
- phdrs: HydraPhdr[];
8089
- pbags: HydraPbag[];
8090
- pmods: HydraPmod[];
8091
- pgens: HydraPgen[];
8092
- insts: HydraInst[];
8093
- ibags: HydraIbag[];
8094
- imods: HydraImod[];
8095
- igens: HydraIgen[];
8096
- sHdrs: HydraShdr[];
8097
- sampleData: Uint8Array;
8098
- private _sampleCache;
8099
- decodeSamples(startByte: number, endByte: number, decompressVorbis: boolean): Float32Array;
8100
- load(readable: IReadable): void;
8101
- }
8102
-
8103
- declare class HydraGenAmount {
8104
- wordAmount: number;
8105
- get shortAmount(): number;
8106
- get lowByteAmount(): number;
8107
- get highByteAmount(): number;
8108
- constructor(reader: IReadable);
8109
- }
8110
-
8111
- declare class HydraIbag {
8112
- static readonly SizeInFile: number;
8113
- instGenNdx: number;
8114
- instModNdx: number;
8115
- constructor(reader: IReadable);
8116
- }
8117
-
8118
- declare class HydraIgen {
8119
- static readonly SizeInFile: number;
8120
- genOper: number;
8121
- genAmount: HydraGenAmount;
8122
- constructor(reader: IReadable);
8123
- }
8124
-
8125
- declare class HydraImod {
8126
- static readonly SizeInFile: number;
8127
- modSrcOper: number;
8128
- modDestOper: number;
8129
- modAmount: number;
8130
- modAmtSrcOper: number;
8131
- modTransOper: number;
8132
- constructor(reader: IReadable);
8133
- }
8134
-
8135
- declare class HydraInst {
8136
- static readonly SizeInFile: number;
8137
- instName: string;
8138
- instBagNdx: number;
8139
- constructor(reader: IReadable);
8140
- }
8141
-
8142
- declare class HydraPbag {
8143
- static readonly SizeInFile: number;
8144
- genNdx: number;
8145
- modNdx: number;
8146
- constructor(reader: IReadable);
8147
- }
8148
-
8149
- declare class HydraPgen {
8150
- static readonly SizeInFile: number;
8151
- static readonly GenInstrument: number;
8152
- static readonly GenKeyRange: number;
8153
- static readonly GenVelRange: number;
8154
- static readonly GenSampleId: number;
8155
- genOper: number;
8156
- genAmount: HydraGenAmount;
8157
- constructor(reader: IReadable);
8158
- }
8159
-
8160
- declare class HydraPhdr {
8161
- static readonly SizeInFile: number;
8162
- presetName: string;
8163
- preset: number;
8164
- bank: number;
8165
- presetBagNdx: number;
8166
- library: number;
8167
- genre: number;
8168
- morphology: number;
8169
- constructor(reader: IReadable);
8170
- }
8171
-
8172
- declare class HydraPmod {
8173
- static readonly SizeInFile: number;
8174
- modSrcOper: number;
8175
- modDestOper: number;
8176
- modAmount: number;
8177
- modAmtSrcOper: number;
8178
- modTransOper: number;
8179
- constructor(reader: IReadable);
8180
- }
8181
-
8182
- declare class HydraShdr {
8183
- static readonly SizeInFile: number;
8184
- sampleName: string;
8185
- start: number;
8186
- end: number;
8187
- startLoop: number;
8188
- endLoop: number;
8189
- sampleRate: number;
8190
- originalPitch: number;
8191
- pitchCorrection: number;
8192
- sampleLink: number;
8193
- sampleType: number;
8194
- constructor(reader: IReadable);
7429
+ private static readonly _placeholderPattern;
8195
7430
  }
8196
7431
 
8197
7432
  /**
8198
7433
  * The public API interface for interacting with the synthesizer.
7434
+ * @public
8199
7435
  */
8200
7436
  declare interface IAlphaSynth {
8201
7437
  /**
@@ -8408,6 +7644,7 @@ declare interface IAlphaSynth {
8408
7644
  /**
8409
7645
  * An audio exporter allowing streaming synthesis of audio samples with a fixed configuration.
8410
7646
  * This is the internal synchronous version of the public {@link IAudioExporter}.
7647
+ * @public
8411
7648
  */
8412
7649
  declare interface IAlphaSynthAudioExporter {
8413
7650
  /**
@@ -8429,6 +7666,7 @@ declare interface IAlphaSynthAudioExporter {
8429
7666
  * A {@link IBackingTrackSynthOutput} which uses a HTMLAudioElement as playback mechanism.
8430
7667
  * Allows the access to the element for further custom usage.
8431
7668
  * @target web
7669
+ * @public
8432
7670
  */
8433
7671
  declare interface IAudioElementBackingTrackSynthOutput extends IBackingTrackSynthOutput {
8434
7672
  /**
@@ -8441,6 +7679,7 @@ declare interface IAudioElementBackingTrackSynthOutput extends IBackingTrackSynt
8441
7679
 
8442
7680
  /**
8443
7681
  * A exporter which can be used to obtain the synthesized audio for custom processing.
7682
+ * @public
8444
7683
  */
8445
7684
  declare interface IAudioExporter extends Disposable {
8446
7685
  /**
@@ -8463,6 +7702,7 @@ declare interface IAudioExporter extends Disposable {
8463
7702
  * This is the internal worker interface implemented by IAudioExporters and consists
8464
7703
  * of the internal APIs needed to spawn new exporters. Its mainly used to simplify
8465
7704
  * the public API visible when using exporters.
7705
+ * @public
8466
7706
  */
8467
7707
  declare interface IAudioExporterWorker extends IAudioExporter {
8468
7708
  /**
@@ -8475,132 +7715,9 @@ declare interface IAudioExporterWorker extends IAudioExporter {
8475
7715
  initialize(options: AudioExportOptions, midi: MidiFile, syncPoints: BackingTrackSyncPoint[], transpositionPitches: Map<number, number>): Promise<void>;
8476
7716
  }
8477
7717
 
8478
- /**
8479
- * Classes implementing this interface can act as main audio synthesis engine
8480
- * within alphaSynth.
8481
- */
8482
- declare interface IAudioSampleSynthesizer {
8483
- /**
8484
- * The master volume to produce.
8485
- */
8486
- masterVolume: number;
8487
- /**
8488
- * The volume of metronome ticks.
8489
- */
8490
- metronomeVolume: number;
8491
- /**
8492
- * The output sample rate which is produced.
8493
- */
8494
- readonly outSampleRate: number;
8495
- /**
8496
- * The current tempo according to the processed midi events (used for metronome event generation)
8497
- */
8498
- readonly currentTempo: number;
8499
- /**
8500
- * The current time signature numerator according to the processed midi events (used for metronome event generation)
8501
- */
8502
- readonly timeSignatureNumerator: number;
8503
- /**
8504
- * The current time signature denominator according to the processed midi events (used for metronome event generation)
8505
- */
8506
- readonly timeSignatureDenominator: number;
8507
- /**
8508
- * The number of voices which are currently active in the syntheiszer and still producing audio.
8509
- */
8510
- readonly activeVoiceCount: number;
8511
- /**
8512
- * Ensures for all active notes a note-off is issued to stop playing the keys.
8513
- * @param immediate Whether the stop should happen immediately or with sustain->release.
8514
- */
8515
- noteOffAll(immediate: boolean): void;
8516
- /**
8517
- * Stop all playing notes immediatly and reset all channel parameters but keeps user
8518
- * defined settings
8519
- */
8520
- resetSoft(): void;
8521
- /**
8522
- * Resets all loaded presets.
8523
- */
8524
- resetPresets(): void;
8525
- /**
8526
- * Loads the presets from the given SoundFont hydra structure.
8527
- * @param hydra The SoundFont hydra structure.
8528
- * @param instrumentPrograms The used instrument programs to load the samples for.
8529
- * @param percussionKeys The instrument keys used.
8530
- * @param append Whether the presets should be appended or whether they should replace all loaded ones.
8531
- */
8532
- loadPresets(hydra: Hydra, instrumentPrograms: Set<number>, percussionKeys: Set<number>, append: boolean): void;
8533
- /**
8534
- * Configures the channel used to generate metronome sounds.
8535
- * @param metronomeVolume The volume for the channel.
8536
- */
8537
- setupMetronomeChannel(metronomeVolume: number): void;
8538
- /**
8539
- * Synthesizes the given number of samples without producing an output (e.g. on seeking)
8540
- * @param sampleCount The number of samples to synthesize.
8541
- */
8542
- synthesizeSilent(sampleCount: number): void;
8543
- /**
8544
- * Processes the given synth event.
8545
- * @param synthEvent The synth event.
8546
- */
8547
- dispatchEvent(synthEvent: SynthEvent): void;
8548
- /**
8549
- * Synthesizes the given number of samples into the provided output buffer.
8550
- * @param buffer The buffer to fill.
8551
- * @param bufferPos The offset in the buffer to start writing into.
8552
- * @param sampleCount The number of samples to synthesize.
8553
- */
8554
- synthesize(buffer: Float32Array, bufferPos: number, sampleCount: number): SynthEvent[];
8555
- /**
8556
- * Applies the given transposition pitches used for general pitch changes that should be applied to the song.
8557
- * Used for general transpositions applied to the file.
8558
- * @param transpositionPitches A map defining for a given list of midi channels the number of semitones that should be adjusted.
8559
- */
8560
- applyTranspositionPitches(transpositionPitches: Map<number, number>): void;
8561
- /**
8562
- * Sets the transposition pitch of a given channel. This pitch is additionally applied beside the
8563
- * ones applied already via {@link applyTranspositionPitches}.
8564
- * @param channel The channel number
8565
- * @param semitones The number of semitones to apply as pitch offset.
8566
- */
8567
- setChannelTranspositionPitch(channel: number, semitones: number): void;
8568
- /**
8569
- * Sets the mute state of a channel.
8570
- * @param channel The channel number
8571
- * @param mute true if the channel should be muted, otherwise false.
8572
- */
8573
- channelSetMute(channel: number, mute: boolean): void;
8574
- /**
8575
- * Gets the solo state of a channel.
8576
- * @param channel The channel number
8577
- * @param solo true if the channel should be played solo, otherwise false.
8578
- */
8579
- channelSetSolo(channel: number, solo: boolean): void;
8580
- /**
8581
- * Resets the mute/solo state of all channels
8582
- */
8583
- resetChannelStates(): void;
8584
- /**
8585
- * Gets or sets the current and initial volume of the given channel.
8586
- * @param channel The channel number.
8587
- * @param volume The volume of of the channel (0.0-1.0)
8588
- */
8589
- channelSetMixVolume(channel: number, volume: number): void;
8590
- /**
8591
- * Checks whether the synth has loaded the samples for a given midi program.
8592
- * @param program The program to check.
8593
- */
8594
- hasSamplesForProgram(program: number): boolean;
8595
- /**
8596
- * Checks whether the synth has loaded the samples for a given percussion key.
8597
- * @param key The midi key defining the percussion instrument.
8598
- */
8599
- hasSamplesForPercussion(key: number): boolean;
8600
- }
8601
-
8602
7718
  /**
8603
7719
  * A synth output for playing backing tracks.
7720
+ * @public
8604
7721
  */
8605
7722
  declare interface IBackingTrackSynthOutput extends ISynthOutput {
8606
7723
  /**
@@ -8633,6 +7750,7 @@ declare interface IBackingTrackSynthOutput extends ISynthOutput {
8633
7750
 
8634
7751
  /**
8635
7752
  * This is the base public interface for canvas implementations on different plattforms.
7753
+ * @public
8636
7754
  */
8637
7755
  declare interface ICanvas {
8638
7756
  settings: Settings;
@@ -8669,6 +7787,7 @@ declare interface ICanvas {
8669
7787
 
8670
7788
  /**
8671
7789
  * This interface represents a container control in the UI layer.
7790
+ * @public
8672
7791
  */
8673
7792
  declare interface IContainer {
8674
7793
  /**
@@ -8738,6 +7857,7 @@ declare interface IContainer {
8738
7857
 
8739
7858
  /**
8740
7859
  * An emitter for an event without any value passed to the listeners.
7860
+ * @public
8741
7861
  */
8742
7862
  export declare interface IEventEmitter {
8743
7863
  /**
@@ -8758,6 +7878,7 @@ export declare interface IEventEmitter {
8758
7878
  /**
8759
7879
  * An emitter for an event with a single parameter passed to the listeners.
8760
7880
  * @partial
7881
+ * @public
8761
7882
  */
8762
7883
  export declare interface IEventEmitterOfT<T> {
8763
7884
  /**
@@ -8777,6 +7898,7 @@ export declare interface IEventEmitterOfT<T> {
8777
7898
 
8778
7899
  /**
8779
7900
  * A custom handler for integrating alphaTab with an external media source.
7901
+ * @public
8780
7902
  */
8781
7903
  declare interface IExternalMediaHandler {
8782
7904
  /**
@@ -8808,6 +7930,7 @@ declare interface IExternalMediaHandler {
8808
7930
 
8809
7931
  /**
8810
7932
  * A output handling the playback via an external media.
7933
+ * @public
8811
7934
  */
8812
7935
  declare interface IExternalMediaSynthOutput extends IBackingTrackSynthOutput {
8813
7936
  /**
@@ -8821,6 +7944,9 @@ declare interface IExternalMediaSynthOutput extends IBackingTrackSynthOutput {
8821
7944
  updatePosition(currentTime: number): void;
8822
7945
  }
8823
7946
 
7947
+ /**
7948
+ * @public
7949
+ */
8824
7950
  export declare interface ILogger {
8825
7951
  debug(category: string, msg: string, ...details: unknown[]): void;
8826
7952
  warning(category: string, msg: string, ...details: unknown[]): void;
@@ -8830,6 +7956,7 @@ export declare interface ILogger {
8830
7956
 
8831
7957
  /**
8832
7958
  * A handler is responsible for writing midi events to a custom structure
7959
+ * @public
8833
7960
  */
8834
7961
  declare interface IMidiFileHandler {
8835
7962
  /**
@@ -8908,6 +8035,7 @@ declare interface IMidiFileHandler {
8908
8035
 
8909
8036
  /**
8910
8037
  * This interface represents the information about a mouse event that occured on the UI.
8038
+ * @public
8911
8039
  */
8912
8040
  declare interface IMouseEventArgs {
8913
8041
  /**
@@ -8936,8 +8064,7 @@ export declare namespace importer {
8936
8064
  export {
8937
8065
  ScoreImporter,
8938
8066
  ScoreLoader,
8939
- UnsupportedFormatError,
8940
- AlphaTexImporter
8067
+ UnsupportedFormatError
8941
8068
  }
8942
8069
  }
8943
8070
 
@@ -8945,6 +8072,7 @@ export declare namespace importer {
8945
8072
  * All settings related to importers that decode file formats.
8946
8073
  * @json
8947
8074
  * @json_declaration
8075
+ * @public
8948
8076
  */
8949
8077
  export declare class ImporterSettings {
8950
8078
  /**
@@ -9009,6 +8137,7 @@ export declare class ImporterSettings {
9009
8137
  * All settings related to importers that decode file formats.
9010
8138
  * @json
9011
8139
  * @json_declaration
8140
+ * @public
9012
8141
  * @target web
9013
8142
  */
9014
8143
  declare interface ImporterSettingsJson {
@@ -9074,6 +8203,7 @@ declare interface ImporterSettingsJson {
9074
8203
  * Describes an instrument articulation which is used for percussions.
9075
8204
  * @json
9076
8205
  * @json_strict
8206
+ * @public
9077
8207
  */
9078
8208
  declare class InstrumentArticulation {
9079
8209
  /**
@@ -9117,24 +8247,6 @@ declare class InstrumentArticulation {
9117
8247
  getSymbol(duration: Duration): MusicFontSymbol;
9118
8248
  }
9119
8249
 
9120
- /**
9121
- * Lists the different modes in which the staves and systems are arranged.
9122
- */
9123
- declare enum InternalSystemsLayoutMode {
9124
- /**
9125
- * Use the automatic alignment system provided by alphaTab (default)
9126
- */
9127
- Automatic = 0,
9128
- /**
9129
- * Use the relative scaling information stored in the score model.
9130
- */
9131
- FromModelWithScale = 1,
9132
- /**
9133
- * Use the absolute size information stored in the score model.
9134
- */
9135
- FromModelWithWidths = 2
9136
- }
9137
-
9138
8250
  export declare namespace io {
9139
8251
  export {
9140
8252
  IWriteable,
@@ -9144,6 +8256,9 @@ export declare namespace io {
9144
8256
  }
9145
8257
  }
9146
8258
 
8259
+ /**
8260
+ * @public
8261
+ */
9147
8262
  declare class IOHelper {
9148
8263
  static readInt32BE(input: IReadable): number;
9149
8264
  static readFloat32BE(readable: IReadable): number;
@@ -9165,7 +8280,7 @@ declare class IOHelper {
9165
8280
  static readInt24(input: Uint8Array, index: number): number;
9166
8281
  static readInt16(input: Uint8Array, index: number): number;
9167
8282
  static toString(data: Uint8Array, encoding: string): string;
9168
- private static detectEncoding;
8283
+ private static _detectEncoding;
9169
8284
  static stringToBytes(str: string): Uint8Array;
9170
8285
  static writeInt32BE(o: IWriteable, v: number): void;
9171
8286
  static writeInt32LE(o: IWriteable, v: number): void;
@@ -9180,6 +8295,7 @@ declare class IOHelper {
9180
8295
 
9181
8296
  /**
9182
8297
  * Represents a stream of binary data that can be read from.
8298
+ * @public
9183
8299
  */
9184
8300
  declare interface IReadable {
9185
8301
  /**
@@ -9221,6 +8337,7 @@ declare interface IReadable {
9221
8337
 
9222
8338
  /**
9223
8339
  * Represents the public interface of the component that can render scores.
8340
+ * @public
9224
8341
  */
9225
8342
  declare interface IScoreRenderer {
9226
8343
  /**
@@ -9368,7 +8485,7 @@ declare interface IScoreRenderer {
9368
8485
  /**
9369
8486
  * This is the base interface for output devices which can
9370
8487
  * request and playback audio samples.
9371
- * @csharp_public
8488
+ * @public
9372
8489
  */
9373
8490
  declare interface ISynthOutput {
9374
8491
  /**
@@ -9439,6 +8556,7 @@ declare interface ISynthOutput {
9439
8556
 
9440
8557
  /**
9441
8558
  * Represents a output device on which the synth can send the audio to.
8559
+ * @public
9442
8560
  */
9443
8561
  declare interface ISynthOutputDevice {
9444
8562
  /**
@@ -9458,6 +8576,7 @@ declare interface ISynthOutputDevice {
9458
8576
  /**
9459
8577
  * This interface represents the UI abstraction between alphaTab and the corresponding UI framework being used.
9460
8578
  * @param <TSettings> The type of that holds the settings passed from the UI layer.
8579
+ * @public
9461
8580
  */
9462
8581
  declare interface IUiFacade<TSettings> {
9463
8582
  /**
@@ -9621,6 +8740,7 @@ declare interface IUiFacade<TSettings> {
9621
8740
 
9622
8741
  /**
9623
8742
  * Represents a writer where binary data can be written to.
8743
+ * @public
9624
8744
  */
9625
8745
  declare interface IWriteable {
9626
8746
  /**
@@ -9663,12 +8783,13 @@ export declare namespace json {
9663
8783
  /**
9664
8784
  * This class can convert a full {@link Score} instance to a simple JavaScript object and back for further
9665
8785
  * JSON serialization.
8786
+ * @public
9666
8787
  */
9667
8788
  declare class JsonConverter {
9668
8789
  /**
9669
8790
  * @target web
9670
8791
  */
9671
- private static jsonReplacer;
8792
+ private static _jsonReplacer;
9672
8793
  /**
9673
8794
  * Converts the given score into a JSON encoded string.
9674
8795
  * @param score The score to serialize.
@@ -9729,7 +8850,7 @@ declare class JsonConverter {
9729
8850
  * @returns The converted MidiFile.
9730
8851
  */
9731
8852
  static jsObjectToMidiFile(jsObject: unknown): MidiFile;
9732
- private static jsObjectToMidiTrack;
8853
+ private static _jsObjectToMidiTrack;
9733
8854
  /**
9734
8855
  * Converts the given JavaScript object into a MidiEvent object.
9735
8856
  * @param jsObject The javascript object to deserialize.
@@ -9742,7 +8863,7 @@ declare class JsonConverter {
9742
8863
  * @returns A serialized MidiFile object without ciruclar dependencies that can be used for further serializations.
9743
8864
  */
9744
8865
  static midiFileToJsObject(midi: MidiFile): Map<string, unknown>;
9745
- private static midiTrackToJsObject;
8866
+ private static _midiTrackToJsObject;
9746
8867
  /**
9747
8868
  * Converts the given MidiEvent object into a serialized JavaScript object.
9748
8869
  * @param midi The midi file to convert.
@@ -9753,6 +8874,7 @@ declare class JsonConverter {
9753
8874
 
9754
8875
  /**
9755
8876
  * This public enumeration lists all available key signatures
8877
+ * @public
9756
8878
  */
9757
8879
  declare enum KeySignature {
9758
8880
  /**
@@ -9819,6 +8941,7 @@ declare enum KeySignature {
9819
8941
 
9820
8942
  /**
9821
8943
  * This public enumeration lists all available types of KeySignatures
8944
+ * @public
9822
8945
  */
9823
8946
  declare enum KeySignatureType {
9824
8947
  /**
@@ -9831,23 +8954,9 @@ declare enum KeySignatureType {
9831
8954
  Minor = 1
9832
8955
  }
9833
8956
 
9834
- /**
9835
- * A factory for custom layout engines.
9836
- */
9837
- declare class LayoutEngineFactory {
9838
- /**
9839
- * Whether the layout is considered "vertical" (affects mainly scrolling behavior).
9840
- */
9841
- readonly vertical: boolean;
9842
- /**
9843
- * Creates a new layout instance.
9844
- */
9845
- readonly createLayout: (renderer: ScoreRenderer) => ScoreLayout;
9846
- constructor(vertical: boolean, createLayout: (renderer: ScoreRenderer) => ScoreLayout);
9847
- }
9848
-
9849
8957
  /**
9850
8958
  * Lists all layout modes that are supported.
8959
+ * @public
9851
8960
  */
9852
8961
  export declare enum LayoutMode {
9853
8962
  /**
@@ -9861,19 +8970,12 @@ export declare enum LayoutMode {
9861
8970
  }
9862
8971
 
9863
8972
  /**
9864
- * @target web
8973
+ * @public
9865
8974
  */
9866
- declare class Lazy<T> {
9867
- private _factory;
9868
- private _value;
9869
- constructor(factory: () => T);
9870
- get value(): T;
9871
- }
9872
-
9873
8975
  export declare class Logger {
9874
8976
  static logLevel: LogLevel;
9875
8977
  static log: ILogger;
9876
- private static shouldLog;
8978
+ private static _shouldLog;
9877
8979
  static debug(category: string, msg: string, ...details: unknown[]): void;
9878
8980
  static warning(category: string, msg: string, ...details: unknown[]): void;
9879
8981
  static info(category: string, msg: string, ...details: unknown[]): void;
@@ -9883,6 +8985,7 @@ export declare class Logger {
9883
8985
  /**
9884
8986
  * Defines all loglevels.
9885
8987
  * @json
8988
+ * @public
9886
8989
  */
9887
8990
  export declare enum LogLevel {
9888
8991
  /**
@@ -9909,15 +9012,16 @@ export declare enum LogLevel {
9909
9012
 
9910
9013
  /**
9911
9014
  * Represents the lyrics of a song.
9015
+ * @public
9912
9016
  */
9913
9017
  declare class Lyrics {
9914
- private static readonly CharCodeLF;
9915
- private static readonly CharCodeTab;
9916
- private static readonly CharCodeCR;
9917
- private static readonly CharCodeSpace;
9918
- private static readonly CharCodeBrackedClose;
9919
- private static readonly CharCodeBrackedOpen;
9920
- private static readonly CharCodeDash;
9018
+ private static readonly _charCodeLF;
9019
+ private static readonly _charCodeTab;
9020
+ private static readonly _charCodeCR;
9021
+ private static readonly _charCodeSpace;
9022
+ private static readonly _charCodeBrackedClose;
9023
+ private static readonly _charCodeBrackedOpen;
9024
+ private static readonly _charCodeDash;
9921
9025
  /**
9922
9026
  * Gets or sets he start bar on which the lyrics should begin.
9923
9027
  */
@@ -9932,9 +9036,9 @@ declare class Lyrics {
9932
9036
  */
9933
9037
  chunks: string[];
9934
9038
  finish(skipEmptyEntries?: boolean): void;
9935
- private parse;
9936
- private addChunk;
9937
- private prepareChunk;
9039
+ private _parse;
9040
+ private _addChunk;
9041
+ private _prepareChunk;
9938
9042
  }
9939
9043
 
9940
9044
  /**
@@ -9942,6 +9046,7 @@ declare class Lyrics {
9942
9046
  * all tracks.
9943
9047
  * @json
9944
9048
  * @json_strict
9049
+ * @public
9945
9050
  */
9946
9051
  declare class MasterBar {
9947
9052
  static readonly MaxAlternateEndings: number;
@@ -10111,6 +9216,7 @@ declare class MasterBar {
10111
9216
 
10112
9217
  /**
10113
9218
  * Represents the boundaries of a list of bars related to a single master bar.
9219
+ * @public
10114
9220
  */
10115
9221
  declare class MasterBarBounds {
10116
9222
  /**
@@ -10168,23 +9274,9 @@ declare class MasterBarBounds {
10168
9274
  addBeat(bounds: BeatBounds): void;
10169
9275
  }
10170
9276
 
10171
- /**
10172
- * This container represents a single column of bar renderers independent from any staves.
10173
- * This container can be used to reorganize renderers into a new staves.
10174
- */
10175
- declare class MasterBarsRenderers {
10176
- width: number;
10177
- isLinkedToPrevious: boolean;
10178
- canWrap: boolean;
10179
- masterBar: MasterBar;
10180
- additionalMultiBarRestIndexes: number[] | null;
10181
- get lastMasterBarIndex(): number;
10182
- renderers: BarRendererBase[];
10183
- layoutingInfo: BarLayoutingInfo;
10184
- }
10185
-
10186
9277
  /**
10187
9278
  * Represents the time period, for which all bars of a {@link MasterBar} are played.
9279
+ * @public
10188
9280
  */
10189
9281
  declare class MasterBarTickLookup {
10190
9282
  /**
@@ -10222,14 +9314,14 @@ declare class MasterBarTickLookup {
10222
9314
  * @param currentBeat The item in which to insert the new item afterwards
10223
9315
  * @param newBeat The new item to insert
10224
9316
  */
10225
- private insertAfter;
9317
+ private _insertAfter;
10226
9318
  /**
10227
9319
  * Inserts `newNextBeat` before `currentBeat` in the linked list of items and updates.
10228
9320
  * the `firstBeat` and `lastBeat` respectively too.
10229
9321
  * @param currentBeat The item in which to insert the new item afterwards
10230
9322
  * @param newBeat The new item to insert
10231
9323
  */
10232
- private insertBefore;
9324
+ private _insertBefore;
10233
9325
  /**
10234
9326
  * Gets or sets the {@link MasterBarTickLookup} of the next masterbar in the {@link Score}
10235
9327
  */
@@ -10252,6 +9344,7 @@ declare class MasterBarTickLookup {
10252
9344
  /**
10253
9345
  * Represents a single point in time defining the tempo of a {@link MasterBarTickLookup}.
10254
9346
  * This is typically the initial tempo of a master bar or a tempo change.
9347
+ * @public
10255
9348
  */
10256
9349
  declare class MasterBarTickLookupTempoChange {
10257
9350
  /**
@@ -10267,6 +9360,7 @@ declare class MasterBarTickLookupTempoChange {
10267
9360
 
10268
9361
  /**
10269
9362
  * The MeasuredText class represents the dimensions of a piece of text in the canvas;
9363
+ * @public
10270
9364
  */
10271
9365
  declare class MeasuredText {
10272
9366
  /**
@@ -10280,15 +9374,9 @@ declare class MeasuredText {
10280
9374
  constructor(width: number, height: number);
10281
9375
  }
10282
9376
 
10283
- export declare class meta {
10284
- static readonly version: string;
10285
- static readonly date: string;
10286
- static readonly commit: string;
10287
- static print(print: (message: string) => void): void;
10288
- }
10289
-
10290
9377
  /**
10291
9378
  * @deprecated Move to the new concrete Midi Event Types.
9379
+ * @public
10292
9380
  */
10293
9381
  declare class MetaDataEvent extends MetaEvent {
10294
9382
  data: Uint8Array;
@@ -10296,6 +9384,7 @@ declare class MetaDataEvent extends MetaEvent {
10296
9384
 
10297
9385
  /**
10298
9386
  * @deprecated Move to the new concrete Midi Event Types.
9387
+ * @public
10299
9388
  */
10300
9389
  declare class MetaEvent extends DeprecatedMidiEvent {
10301
9390
  get metaStatus(): MetaEventType;
@@ -10303,6 +9392,7 @@ declare class MetaEvent extends DeprecatedMidiEvent {
10303
9392
 
10304
9393
  /**
10305
9394
  * @deprecated Move to the new concrete Midi Event Types.
9395
+ * @public
10306
9396
  */
10307
9397
  declare enum MetaEventType {
10308
9398
  SequenceNumber = 0,
@@ -10327,6 +9417,7 @@ declare enum MetaEventType {
10327
9417
 
10328
9418
  /**
10329
9419
  * @deprecated Move to the new concrete Midi Event Types.
9420
+ * @public
10330
9421
  */
10331
9422
  declare class MetaNumberEvent extends MetaEvent {
10332
9423
  value: number;
@@ -10378,6 +9469,7 @@ export declare namespace midi {
10378
9469
 
10379
9470
  /**
10380
9471
  * @deprecated Move to the new concrete Midi Event Types.
9472
+ * @public
10381
9473
  */
10382
9474
  declare class Midi20PerNotePitchBendEvent extends DeprecatedMidiEvent {
10383
9475
  noteKey: number;
@@ -10386,6 +9478,7 @@ declare class Midi20PerNotePitchBendEvent extends DeprecatedMidiEvent {
10386
9478
 
10387
9479
  /**
10388
9480
  * Represents a midi event.
9481
+ * @public
10389
9482
  */
10390
9483
  declare abstract class MidiEvent {
10391
9484
  /**
@@ -10435,6 +9528,7 @@ declare abstract class MidiEvent {
10435
9528
 
10436
9529
  /**
10437
9530
  * Represents the info when the synthesizer played certain midi events.
9531
+ * @public
10438
9532
  */
10439
9533
  declare class MidiEventsPlayedEventArgs {
10440
9534
  /**
@@ -10450,6 +9544,7 @@ declare class MidiEventsPlayedEventArgs {
10450
9544
 
10451
9545
  /**
10452
9546
  * Lists all midi event types. Based on the type the instance is a specific subclass.
9547
+ * @public
10453
9548
  */
10454
9549
  declare enum MidiEventType {
10455
9550
  TimeSignature = 88,// 0xFF _0x58_ in Midi 1.0
@@ -10479,6 +9574,7 @@ declare enum MidiEventType {
10479
9574
 
10480
9575
  /**
10481
9576
  * Represents a midi file with a single track that can be played via {@link AlphaSynth}
9577
+ * @public
10482
9578
  */
10483
9579
  declare class MidiFile {
10484
9580
  /**
@@ -10497,7 +9593,7 @@ declare class MidiFile {
10497
9593
  * Gets a list of midi tracks.
10498
9594
  */
10499
9595
  readonly tracks: MidiTrack[];
10500
- private ensureTracks;
9596
+ private _ensureTracks;
10501
9597
  /**
10502
9598
  * Adds the given midi event a the correct time position into the file.
10503
9599
  */
@@ -10517,6 +9613,7 @@ declare class MidiFile {
10517
9613
 
10518
9614
  /**
10519
9615
  * Lists the different midi file formats which are supported for export.
9616
+ * @public
10520
9617
  */
10521
9618
  declare enum MidiFileFormat {
10522
9619
  /**
@@ -10531,10 +9628,11 @@ declare enum MidiFileFormat {
10531
9628
 
10532
9629
  /**
10533
9630
  * This generator creates a midi file using a score.
9631
+ * @public
10534
9632
  */
10535
9633
  declare class MidiFileGenerator {
10536
- private static readonly DefaultDurationDead;
10537
- private static readonly DefaultDurationPalmMute;
9634
+ private static readonly _defaultDurationDead;
9635
+ private static readonly _defaultDurationPalmMute;
10538
9636
  private readonly _score;
10539
9637
  private _settings;
10540
9638
  private _handler;
@@ -10569,11 +9667,11 @@ declare class MidiFileGenerator {
10569
9667
  * Starts the generation of the midi file.
10570
9668
  */
10571
9669
  generate(): void;
10572
- private generateTrack;
10573
- private addProgramChange;
10574
- private addBankChange;
9670
+ private _generateTrack;
9671
+ private _addProgramChange;
9672
+ private _addBankChange;
10575
9673
  static buildTranspositionPitches(score: Score, settings: Settings): Map<number, number>;
10576
- private generateChannel;
9674
+ private _generateChannel;
10577
9675
  /**
10578
9676
  * Generates the sync points for the given score without re-generating the midi itself.
10579
9677
  * @remarks
@@ -10585,24 +9683,24 @@ declare class MidiFileGenerator {
10585
9683
  * @returns The generated sync points for usage in the backing track playback.
10586
9684
  */
10587
9685
  static generateSyncPoints(score: Score, createNew?: boolean): BackingTrackSyncPoint[];
10588
- /* Excluded from this release type: buildModifiedTempoLookup */
10589
- private static playThroughSong;
10590
- private static processBarTime;
10591
- private static processBarTimeWithNewSyncPoints;
10592
- private static processBarTimeWithSyncPoints;
10593
- private static processBarTimeNoSyncPoints;
10594
- private static toChannelShort;
10595
- private generateMasterBar;
10596
- private generateBar;
10597
- private getPlaybackBar;
10598
- private generateVoice;
9686
+
9687
+ private static _playThroughSong;
9688
+ private static _processBarTime;
9689
+ private static _processBarTimeWithNewSyncPoints;
9690
+ private static _processBarTimeWithSyncPoints;
9691
+ private static _processBarTimeNoSyncPoints;
9692
+ private static _toChannelShort;
9693
+ private _generateMasterBar;
9694
+ private _generateBar;
9695
+ private _getPlaybackBar;
9696
+ private _generateVoice;
10599
9697
  private _currentTripletFeel;
10600
- private generateBeat;
10601
- private static calculateTripletFeelInfo;
10602
- private generateDeadSlap;
10603
- private needsSecondaryChannel;
10604
- private determineChannel;
10605
- private generateNote;
9698
+ private _generateBeat;
9699
+ private static _calculateTripletFeelInfo;
9700
+ private _generateDeadSlap;
9701
+ private _needsSecondaryChannel;
9702
+ private _determineChannel;
9703
+ private _generateNote;
10606
9704
  /**
10607
9705
  * For every note within the octave, the number of keys to go up when playing ornaments.
10608
9706
  * For white keys this is the next white key,
@@ -10610,152 +9708,64 @@ declare class MidiFileGenerator {
10610
9708
  *
10611
9709
  * Ornaments are not really a strictly defined element, alphaTab is using shipping some default.
10612
9710
  */
10613
- private static readonly OrnamentKeysUp;
9711
+ private static readonly _ornamentKeysUp;
10614
9712
  /**
10615
9713
  * For every note within the octave, the number of keys to go down when playing ornaments.
10616
9714
  * This is typically only a key down.
10617
9715
  *
10618
9716
  * Ornaments are not really a strictly defined element, alphaTab is using shipping some default.
10619
9717
  */
10620
- private static readonly OrnamentKeysDown;
10621
- private generateOrnament;
10622
- private getNoteDuration;
10623
- private applyStaticDuration;
10624
- private static getNoteVelocity;
10625
- private generateFade;
10626
- private generateFadeSteps;
10627
- private generateVibrato;
9718
+ static readonly ornamentKeysDown: number[];
9719
+ private _generateOrnament;
9720
+ private _getNoteDuration;
9721
+ private _applyStaticDuration;
9722
+ private static _getNoteVelocity;
9723
+ private _generateFade;
9724
+ private _generateFadeSteps;
9725
+ private _generateVibrato;
10628
9726
  vibratoResolution: number;
10629
- private generateVibratorWithParams;
9727
+ private _generateVibratorWithParams;
10630
9728
  /**
10631
9729
  * Maximum semitones that are supported in bends in one direction (up or down)
10632
9730
  * GP has 8 full tones on whammys.
10633
9731
  */
10634
- private static readonly PitchBendRangeInSemitones;
9732
+ private static readonly _pitchBendRangeInSemitones;
10635
9733
  /**
10636
9734
  * The value on how many pitch-values are used for one semitone
10637
9735
  */
10638
- private static readonly PitchValuePerSemitone;
9736
+ private static readonly _pitchValuePerSemitone;
10639
9737
  /**
10640
9738
  * The minimum number of breakpoints generated per semitone bend.
10641
9739
  */
10642
- private static readonly MinBreakpointsPerSemitone;
9740
+ private static readonly _minBreakpointsPerSemitone;
10643
9741
  /**
10644
9742
  * How long until a new breakpoint is generated for a bend.
10645
9743
  */
10646
- private static readonly MillisecondsPerBreakpoint;
9744
+ private static readonly _millisecondsPerBreakpoint;
10647
9745
  /**
10648
9746
  * Calculates the midi pitch wheel value for the give bend value.
10649
9747
  */
10650
9748
  static getPitchWheel(bendValue: number): number;
10651
- private generateSlide;
10652
- private generateBend;
10653
- private generateSongBookWhammyOrBend;
10654
- private generateWhammy;
10655
- private generateWhammyOrBend;
10656
- private generateBendValues;
10657
- private generateRasgueado;
10658
- private generateTrill;
10659
- private generateTremoloPicking;
10660
- private static readonly RasgueadoDirections;
10661
- private static readonly RasgueadoDurations;
10662
- private getRasgueadoInfo;
10663
- private getBrushInfo;
10664
- private fillBrushInfo;
10665
- private generateNonTempoAutomation;
9749
+ private _generateSlide;
9750
+ private _generateBend;
9751
+ private _generateSongBookWhammyOrBend;
9752
+ private _generateWhammy;
9753
+ private _generateWhammyOrBend;
9754
+ private _generateBendValues;
9755
+ private _generateRasgueado;
9756
+ private _generateTrill;
9757
+ private _generateTremoloPicking;
9758
+ private static readonly _rasgueadoDirections;
9759
+ private static readonly _rasgueadoDurations;
9760
+ private _getRasgueadoInfo;
9761
+ private _getBrushInfo;
9762
+ private _fillBrushInfo;
9763
+ private _generateNonTempoAutomation;
10666
9764
  prepareSingleBeat(beat: Beat): number;
10667
9765
  generateSingleBeat(beat: Beat): void;
10668
9766
  generateSingleNote(note: Note): void;
10669
9767
  }
10670
9768
 
10671
- /**
10672
- * This sequencer dispatches midi events to the synthesizer based on the current
10673
- * synthesize position. The sequencer does not consider the playback speed.
10674
- */
10675
- declare class MidiFileSequencer {
10676
- private _synthesizer;
10677
- private _currentState;
10678
- private _mainState;
10679
- private _oneTimeState;
10680
- private _countInState;
10681
- get isPlayingMain(): boolean;
10682
- get isPlayingOneTimeMidi(): boolean;
10683
- get isPlayingCountIn(): boolean;
10684
- constructor(synthesizer: IAudioSampleSynthesizer);
10685
- get mainPlaybackRange(): PlaybackRange | null;
10686
- set mainPlaybackRange(value: PlaybackRange | null);
10687
- isLooping: boolean;
10688
- get currentTime(): number;
10689
- /**
10690
- * Gets the duration of the song in ticks.
10691
- */
10692
- get currentEndTick(): number;
10693
- get currentEndTime(): number;
10694
- get currentTempo(): number;
10695
- get modifiedTempo(): number;
10696
- get syncPointTempo(): number;
10697
- get currentSyncPoints(): BackingTrackSyncPoint[];
10698
- /**
10699
- * Gets or sets the playback speed.
10700
- */
10701
- playbackSpeed: number;
10702
- mainSeek(timePosition: number): void;
10703
- private mainSilentProcess;
10704
- loadOneTimeMidi(midiFile: MidiFile): void;
10705
- instrumentPrograms: Set<number>;
10706
- percussionKeys: Set<number>;
10707
- loadMidi(midiFile: MidiFile): void;
10708
- createStateFromFile(midiFile: MidiFile): MidiSequencerState;
10709
- fillMidiEventQueue(): boolean;
10710
- fillMidiEventQueueToEndTime(endTime: number): boolean;
10711
- private fillMidiEventQueueLimited;
10712
- mainTickPositionToTimePosition(tickPosition: number): number;
10713
- mainUpdateSyncPoints(syncPoints: BackingTrackSyncPoint[]): void;
10714
- currentTimePositionToTickPosition(timePosition: number): number;
10715
- currentUpdateCurrentTempo(timePosition: number): void;
10716
- private updateCurrentTempo;
10717
- currentUpdateSyncPoints(timePosition: number): void;
10718
- private updateSyncPoints;
10719
- mainTimePositionFromBackingTrack(timePosition: number, backingTrackLength: number): number;
10720
- mainTimePositionToBackingTrack(timePosition: number, backingTrackLength: number): number;
10721
- private tickPositionToTimePositionWithSpeed;
10722
- private get internalEndTime();
10723
- get isFinished(): boolean;
10724
- stop(): void;
10725
- resetOneTimeMidi(): void;
10726
- resetCountIn(): void;
10727
- startCountIn(): void;
10728
- generateCountInMidi(): void;
10729
- }
10730
-
10731
- declare class MidiFileSequencerTempoChange {
10732
- bpm: number;
10733
- ticks: number;
10734
- time: number;
10735
- constructor(bpm: number, ticks: number, time: number);
10736
- }
10737
-
10738
- declare class MidiSequencerState {
10739
- tempoChanges: MidiFileSequencerTempoChange[];
10740
- tempoChangeIndex: number;
10741
- syncPoints: BackingTrackSyncPoint[];
10742
- firstProgramEventPerChannel: Map<number, SynthEvent>;
10743
- firstTimeSignatureNumerator: number;
10744
- firstTimeSignatureDenominator: number;
10745
- synthData: SynthEvent[];
10746
- division: number;
10747
- eventIndex: number;
10748
- currentTime: number;
10749
- syncPointIndex: number;
10750
- playbackRange: PlaybackRange | null;
10751
- playbackRangeStartTime: number;
10752
- playbackRangeEndTime: number;
10753
- endTick: number;
10754
- endTime: number;
10755
- currentTempo: number;
10756
- syncPointTempo: number;
10757
- }
10758
-
10759
9769
  /**
10760
9770
  * This class holds all information about when {@link MasterBar}s and {@link Beat}s are played.
10761
9771
  *
@@ -10788,10 +9798,11 @@ declare class MidiSequencerState {
10788
9798
  * Lookup L1 alone to determine the start and end of the beat cursor. In this case we will derive a
10789
9799
  * MidiTickLookupFindBeatResult which holds for Time 01 the lookup L1 as start and L3 as end. This will be used
10790
9800
  * both for the cursor and beat highlighting.
9801
+ * @public
10791
9802
  */
10792
9803
  declare class MidiTickLookup {
10793
9804
  private _currentMasterBar;
10794
- /* Excluded from this release type: masterBarLookup */
9805
+
10795
9806
  /**
10796
9807
  * A list of all {@link MasterBarTickLookup} sorted by time.
10797
9808
  */
@@ -10810,14 +9821,14 @@ declare class MidiTickLookup {
10810
9821
  * @returns The information about the current beat or null if no beat could be found.
10811
9822
  */
10812
9823
  findBeat(trackLookup: Set<number>, tick: number, currentBeatHint?: MidiTickLookupFindBeatResult | null): MidiTickLookupFindBeatResult | null;
10813
- private findBeatFast;
10814
- private fillNextBeatMultiBarRest;
10815
- private fillNextBeat;
10816
- private fillNextBeatDefault;
10817
- private isMultiBarRestResult;
10818
- private internalIsMultiBarRestResult;
10819
- private findBeatSlow;
10820
- private firstBeatInMasterBar;
9824
+ private _findBeatFast;
9825
+ private _fillNextBeatMultiBarRest;
9826
+ private _fillNextBeat;
9827
+ private _fillNextBeatDefault;
9828
+ private _isMultiBarRestResult;
9829
+ private _internalIsMultiBarRestResult;
9830
+ private _findBeatSlow;
9831
+ private _firstBeatInMasterBar;
10821
9832
  /**
10822
9833
  * Finds the beat at a given tick position within the known master bar.
10823
9834
  * @param masterBar
@@ -10827,9 +9838,9 @@ declare class MidiTickLookup {
10827
9838
  * @param isNextSearch
10828
9839
  * @returns
10829
9840
  */
10830
- private findBeatInMasterBar;
10831
- private createResult;
10832
- private findMasterBar;
9841
+ private _findBeatInMasterBar;
9842
+ private _createResult;
9843
+ private _findMasterBar;
10833
9844
  /**
10834
9845
  * Gets the {@link MasterBarTickLookup} for a given masterbar at which the masterbar is played the first time.
10835
9846
  * @param bar The masterbar to find the time period for.
@@ -10858,7 +9869,8 @@ declare class MidiTickLookup {
10858
9869
 
10859
9870
  /**
10860
9871
  * Represents the results of searching the currently played beat.
10861
- * @see MidiTickLookup.FindBeat
9872
+ * @see MidiTickLookup.findBeat
9873
+ * @public
10862
9874
  */
10863
9875
  declare class MidiTickLookupFindBeatResult {
10864
9876
  /**
@@ -10898,6 +9910,7 @@ declare class MidiTickLookupFindBeatResult {
10898
9910
 
10899
9911
  /**
10900
9912
  * Describes how a cursor should be moving.
9913
+ * @public
10901
9914
  */
10902
9915
  declare enum MidiTickLookupFindBeatResultCursorMode {
10903
9916
  /**
@@ -10914,6 +9927,9 @@ declare enum MidiTickLookupFindBeatResultCursorMode {
10914
9927
  ToEndOfBar = 2
10915
9928
  }
10916
9929
 
9930
+ /**
9931
+ * @public
9932
+ */
10917
9933
  declare class MidiTrack {
10918
9934
  /**
10919
9935
  * Gets a list of midi events sorted by time.
@@ -11023,6 +10039,7 @@ export declare namespace model {
11023
10039
  /**
11024
10040
  * Lists all music font symbols used within alphaTab. The names
11025
10041
  * and values are aligned with the SMuFL standard.
10042
+ * @public
11026
10043
  */
11027
10044
  declare enum MusicFontSymbol {
11028
10045
  None = -1,
@@ -11313,6 +10330,7 @@ declare enum MusicFontSymbol {
11313
10330
  * Lists all major music notation elements that are part
11314
10331
  * of the music sheet and can be dynamically controlled to be shown
11315
10332
  * or hidden.
10333
+ * @public
11316
10334
  */
11317
10335
  export declare enum NotationElement {
11318
10336
  /**
@@ -11526,6 +10544,7 @@ export declare enum NotationElement {
11526
10544
 
11527
10545
  /**
11528
10546
  * Lists all modes on how alphaTab can handle the display and playback of music notation.
10547
+ * @public
11529
10548
  */
11530
10549
  export declare enum NotationMode {
11531
10550
  /**
@@ -11556,6 +10575,7 @@ export declare enum NotationMode {
11556
10575
  * The notation settings control how various music notation elements are shown and behaving
11557
10576
  * @json
11558
10577
  * @json_declaration
10578
+ * @public
11559
10579
  */
11560
10580
  export declare class NotationSettings {
11561
10581
  /**
@@ -11773,6 +10793,7 @@ export declare class NotationSettings {
11773
10793
  * The notation settings control how various music notation elements are shown and behaving
11774
10794
  * @json
11775
10795
  * @json_declaration
10796
+ * @public
11776
10797
  * @target web
11777
10798
  */
11778
10799
  declare interface NotationSettingsJson {
@@ -11982,10 +11003,11 @@ declare interface NotationSettingsJson {
11982
11003
  * @cloneable
11983
11004
  * @json
11984
11005
  * @json_strict
11006
+ * @public
11985
11007
  */
11986
11008
  declare class Note {
11987
- /* Excluded from this release type: GlobalNoteId */
11988
- /* Excluded from this release type: resetIds */
11009
+
11010
+
11989
11011
  /**
11990
11012
  * Gets or sets the unique id of this note.
11991
11013
  * @clone_ignore
@@ -12379,19 +11401,20 @@ declare class Note {
12379
11401
  get hasQuarterToneOffset(): boolean;
12380
11402
  addBendPoint(point: BendPoint): void;
12381
11403
  finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void;
12382
- private static readonly MaxOffsetForSameLineSearch;
11404
+ private static readonly _maxOffsetForSameLineSearch;
12383
11405
  static nextNoteOnSameLine(note: Note): Note | null;
12384
11406
  static findHammerPullDestination(note: Note): Note | null;
12385
11407
  static findTieOrigin(note: Note): Note | null;
12386
- private static NoteIdLookupKey;
11408
+ private static _noteIdLookupKey;
12387
11409
  private _noteIdBag;
12388
11410
  chain(sharedDataBag?: Map<string, unknown> | null): void;
12389
- /* Excluded from this release type: toJson */
12390
- /* Excluded from this release type: setProperty */
11411
+
11412
+
12391
11413
  }
12392
11414
 
12393
11415
  /**
12394
11416
  * Lists the modes how accidentals are handled for notes
11417
+ * @public
12395
11418
  */
12396
11419
  declare enum NoteAccidentalMode {
12397
11420
  /**
@@ -12426,6 +11449,7 @@ declare enum NoteAccidentalMode {
12426
11449
 
12427
11450
  /**
12428
11451
  * Represents a single note pitch bend change.
11452
+ * @public
12429
11453
  */
12430
11454
  declare class NoteBendEvent extends MidiEvent {
12431
11455
  /**
@@ -12446,6 +11470,7 @@ declare class NoteBendEvent extends MidiEvent {
12446
11470
 
12447
11471
  /**
12448
11472
  * Represents the bounds of a single note
11473
+ * @public
12449
11474
  */
12450
11475
  declare class NoteBounds {
12451
11476
  /**
@@ -12468,6 +11493,7 @@ declare class NoteBounds {
12468
11493
 
12469
11494
  /**
12470
11495
  * The base class for note related events.
11496
+ * @public
12471
11497
  */
12472
11498
  declare abstract class NoteEvent extends MidiEvent {
12473
11499
  /**
@@ -12489,6 +11515,7 @@ declare abstract class NoteEvent extends MidiEvent {
12489
11515
 
12490
11516
  /**
12491
11517
  * Represents a note stop being played.
11518
+ * @public
12492
11519
  */
12493
11520
  declare class NoteOffEvent extends NoteEvent {
12494
11521
  constructor(track: number, tick: number, channel: number, noteKey: number, noteVelocity: number);
@@ -12497,6 +11524,7 @@ declare class NoteOffEvent extends NoteEvent {
12497
11524
 
12498
11525
  /**
12499
11526
  * Represents a note being played
11527
+ * @public
12500
11528
  */
12501
11529
  declare class NoteOnEvent extends NoteEvent {
12502
11530
  constructor(track: number, tick: number, channel: number, noteKey: number, noteVelocity: number);
@@ -12505,6 +11533,7 @@ declare class NoteOnEvent extends NoteEvent {
12505
11533
 
12506
11534
  /**
12507
11535
  * Lists all note ornaments.
11536
+ * @public
12508
11537
  */
12509
11538
  declare enum NoteOrnament {
12510
11539
  None = 0,
@@ -12518,6 +11547,7 @@ declare enum NoteOrnament {
12518
11547
  * Defines the custom styles for notes.
12519
11548
  * @json
12520
11549
  * @json_strict
11550
+ * @public
12521
11551
  */
12522
11552
  declare class NoteStyle extends ElementStyle<NoteSubElement> {
12523
11553
  /**
@@ -12532,6 +11562,7 @@ declare class NoteStyle extends ElementStyle<NoteSubElement> {
12532
11562
 
12533
11563
  /**
12534
11564
  * Lists all graphical sub elements within a {@link Note} which can be styled via {@link Note.style}
11565
+ * @public
12535
11566
  */
12536
11567
  declare enum NoteSubElement {
12537
11568
  /**
@@ -12585,60 +11616,9 @@ declare enum NoteSubElement {
12585
11616
  NumberedEffects = 10
12586
11617
  }
12587
11618
 
12588
- /**
12589
- * Lists the different position modes for {@link BarRendererBase.getNoteX}
12590
- */
12591
- declare enum NoteXPosition {
12592
- /**
12593
- * Gets the note x-position on left of the note head or tab number.
12594
- */
12595
- Left = 0,
12596
- /**
12597
- * Gets the note x-position on the center of the note head or tab number.
12598
- */
12599
- Center = 1,
12600
- /**
12601
- * Gets the note x-position on the right of the note head or tab number.
12602
- */
12603
- Right = 2
12604
- }
12605
-
12606
- /**
12607
- * Lists the different position modes for {@link BarRendererBase.getNoteY}
12608
- */
12609
- declare enum NoteYPosition {
12610
- /**
12611
- * Gets the note y-position on top of the note stem or tab number.
12612
- */
12613
- TopWithStem = 0,
12614
- /**
12615
- * Gets the note y-position on top of the note head or tab number.
12616
- */
12617
- Top = 1,
12618
- /**
12619
- * Gets the note y-position on the center of the note head or tab number.
12620
- */
12621
- Center = 2,
12622
- /**
12623
- * Gets the note y-position on the bottom of the note head or tab number.
12624
- */
12625
- Bottom = 3,
12626
- /**
12627
- * Gets the note y-position on the bottom of the note stem or tab number.
12628
- */
12629
- BottomWithStem = 4,
12630
- /**
12631
- * The position where the upwards stem should be placed.
12632
- */
12633
- StemUp = 5,
12634
- /**
12635
- * The position where the downwards stem should be placed.
12636
- */
12637
- StemDown = 6
12638
- }
12639
-
12640
11619
  /**
12641
11620
  * Lists all ottavia.
11621
+ * @public
12642
11622
  */
12643
11623
  declare enum Ottavia {
12644
11624
  /**
@@ -12665,6 +11645,7 @@ declare enum Ottavia {
12665
11645
 
12666
11646
  /**
12667
11647
  * Lists all types of pick strokes.
11648
+ * @public
12668
11649
  */
12669
11650
  declare enum PickStroke {
12670
11651
  /**
@@ -12683,6 +11664,7 @@ declare enum PickStroke {
12683
11664
 
12684
11665
  /**
12685
11666
  * Represents a change of the pitch bend (aka. pitch wheel) on a specific channel.
11667
+ * @public
12686
11668
  */
12687
11669
  declare class PitchBendEvent extends MidiEvent {
12688
11670
  /**
@@ -12708,11 +11690,7 @@ export declare namespace platform {
12708
11690
  MeasuredText,
12709
11691
  IContainer,
12710
11692
  IMouseEventArgs,
12711
- IUiFacade,
12712
- CssFontSvgCanvas,
12713
- FontSizes,
12714
- FontSizeDefinition,
12715
- SvgCanvas
11693
+ IUiFacade
12716
11694
  }
12717
11695
  }
12718
11696
 
@@ -12721,6 +11699,7 @@ export declare namespace platform {
12721
11699
  * for playback.
12722
11700
  * @json
12723
11701
  * @json_strict
11702
+ * @public
12724
11703
  */
12725
11704
  declare class PlaybackInformation {
12726
11705
  /**
@@ -12763,6 +11742,7 @@ declare class PlaybackInformation {
12763
11742
 
12764
11743
  /**
12765
11744
  * Represents a range of the song that should be played.
11745
+ * @public
12766
11746
  */
12767
11747
  declare class PlaybackRange {
12768
11748
  /**
@@ -12777,6 +11757,7 @@ declare class PlaybackRange {
12777
11757
 
12778
11758
  /**
12779
11759
  * Represents the info when the playback range changed.
11760
+ * @public
12780
11761
  */
12781
11762
  declare class PlaybackRangeChangedEventArgs {
12782
11763
  /**
@@ -12792,6 +11773,7 @@ declare class PlaybackRangeChangedEventArgs {
12792
11773
 
12793
11774
  /**
12794
11775
  * Lists the different modes how the internal alphaTab player (and related cursor behavior) is working.
11776
+ * @public
12795
11777
  */
12796
11778
  export declare enum PlayerMode {
12797
11779
  /**
@@ -12822,6 +11804,7 @@ export declare enum PlayerMode {
12822
11804
  /**
12823
11805
  * Lists the different modes how alphaTab will play the generated audio.
12824
11806
  * @target web
11807
+ * @public
12825
11808
  */
12826
11809
  export declare enum PlayerOutputMode {
12827
11810
  /**
@@ -12839,6 +11822,7 @@ export declare enum PlayerOutputMode {
12839
11822
  * The player settings control how the audio playback and UI is behaving.
12840
11823
  * @json
12841
11824
  * @json_declaration
11825
+ * @public
12842
11826
  */
12843
11827
  export declare class PlayerSettings {
12844
11828
  /**
@@ -13109,6 +12093,7 @@ export declare class PlayerSettings {
13109
12093
  * The player settings control how the audio playback and UI is behaving.
13110
12094
  * @json
13111
12095
  * @json_declaration
12096
+ * @public
13112
12097
  * @target web
13113
12098
  */
13114
12099
  declare interface PlayerSettingsJson {
@@ -13378,6 +12363,7 @@ declare interface PlayerSettingsJson {
13378
12363
 
13379
12364
  /**
13380
12365
  * Lists the different states of the player
12366
+ * @public
13381
12367
  */
13382
12368
  declare enum PlayerState {
13383
12369
  /**
@@ -13392,6 +12378,7 @@ declare enum PlayerState {
13392
12378
 
13393
12379
  /**
13394
12380
  * Represents the info when the player state changes.
12381
+ * @public
13395
12382
  */
13396
12383
  declare class PlayerStateChangedEventArgs {
13397
12384
  /**
@@ -13412,6 +12399,7 @@ declare class PlayerStateChangedEventArgs {
13412
12399
 
13413
12400
  /**
13414
12401
  * Represents the info when the time in the synthesizer changes.
12402
+ * @public
13415
12403
  */
13416
12404
  declare class PositionChangedEventArgs {
13417
12405
  /**
@@ -13456,6 +12444,7 @@ declare class PositionChangedEventArgs {
13456
12444
 
13457
12445
  /**
13458
12446
  * Represents the change of the midi program on a channel.
12447
+ * @public
13459
12448
  */
13460
12449
  declare class ProgramChangeEvent extends MidiEvent {
13461
12450
  /**
@@ -13473,6 +12462,7 @@ declare class ProgramChangeEvent extends MidiEvent {
13473
12462
 
13474
12463
  /**
13475
12464
  * Represents the progress of any data being loaded.
12465
+ * @public
13476
12466
  */
13477
12467
  export declare class ProgressEventArgs {
13478
12468
  /**
@@ -13491,18 +12481,9 @@ export declare class ProgressEventArgs {
13491
12481
  constructor(loaded: number, total: number);
13492
12482
  }
13493
12483
 
13494
- declare class Queue<T> {
13495
- private _head?;
13496
- private _tail?;
13497
- get isEmpty(): boolean;
13498
- clear(): void;
13499
- enqueue(item: T): void;
13500
- peek(): T | undefined;
13501
- dequeue(): T | undefined;
13502
- }
13503
-
13504
12484
  /**
13505
12485
  * Lists all Rasgueado types.
12486
+ * @public
13506
12487
  */
13507
12488
  declare enum Rasgueado {
13508
12489
  None = 0,
@@ -13530,6 +12511,7 @@ declare enum Rasgueado {
13530
12511
  * A factory for custom render engines.
13531
12512
  * Note for Web: To use a custom engine in workers you have to ensure the engine and registration to the environment are
13532
12513
  * also done in the background worker files (e.g. when bundling)
12514
+ * @public
13533
12515
  */
13534
12516
  export declare class RenderEngineFactory {
13535
12517
  /**
@@ -13543,6 +12525,7 @@ export declare class RenderEngineFactory {
13543
12525
  /**
13544
12526
  * This eventargs define the details about the rendering and layouting process and are
13545
12527
  * provided whenever a part of of the music sheet is rendered.
12528
+ * @public
13546
12529
  */
13547
12530
  declare class RenderFinishedEventArgs {
13548
12531
  /**
@@ -13607,11 +12590,12 @@ export declare namespace rendering {
13607
12590
  * This public class contains central definitions for controlling the visual appearance.
13608
12591
  * @json
13609
12592
  * @json_declaration
12593
+ * @public
13610
12594
  */
13611
12595
  export declare class RenderingResources {
13612
- private static sansFont;
13613
- private static serifFont;
13614
- /* Excluded from this release type: smuflFontFamilyName */
12596
+ private static _sansFont;
12597
+ private static _serifFont;
12598
+
13615
12599
  /**
13616
12600
  * The SMuFL Metrics to use for rendering music symbols.
13617
12601
  * @defaultValue `alphaTab`
@@ -13752,17 +12736,18 @@ export declare class RenderingResources {
13752
12736
  * @since 0.9.6
13753
12737
  */
13754
12738
  scoreInfoColor: Color;
13755
- /* Excluded from this release type: getFontForElement */
12739
+
13756
12740
  }
13757
12741
 
13758
12742
  /**
13759
12743
  * This public class contains central definitions for controlling the visual appearance.
13760
12744
  * @json
13761
12745
  * @json_declaration
12746
+ * @public
13762
12747
  * @target web
13763
12748
  */
13764
12749
  declare interface RenderingResourcesJson {
13765
- /* Excluded from this release type: smuflFontFamilyName */
12750
+
13766
12751
  /**
13767
12752
  * The SMuFL Metrics to use for rendering music symbols.
13768
12753
  * @defaultValue `alphaTab`
@@ -13905,75 +12890,12 @@ declare interface RenderingResourcesJson {
13905
12890
  scoreInfoColor?: ColorJson;
13906
12891
  }
13907
12892
 
13908
- /**
13909
- * A Staff represents a single line within a StaffSystem.
13910
- * It stores BarRenderer instances created from a given factory.
13911
- */
13912
- declare class RenderStaff {
13913
- private _factory;
13914
- private _sharedLayoutData;
13915
- staffTrackGroup: StaffTrackGroup;
13916
- system: StaffSystem;
13917
- barRenderers: BarRendererBase[];
13918
- x: number;
13919
- y: number;
13920
- height: number;
13921
- index: number;
13922
- staffIndex: number;
13923
- isFirstInSystem: boolean;
13924
- /**
13925
- * This is the index of the track being rendered. This is not the index of the track within the model,
13926
- * but the n-th track being rendered. It is the index of the {@link ScoreRenderer.tracks} array defining
13927
- * which tracks should be rendered.
13928
- * For single-track rendering this will always be zero.
13929
- */
13930
- trackIndex: number;
13931
- modelStaff: Staff;
13932
- get staffId(): string;
13933
- /**
13934
- * This is the visual offset from top where the
13935
- * Staff contents actually start. Used for grouping
13936
- * using a accolade
13937
- */
13938
- staveTop: number;
13939
- topSpacing: number;
13940
- bottomSpacing: number;
13941
- /**
13942
- * This is the visual offset from top where the
13943
- * Staff contents actually ends. Used for grouping
13944
- * using a accolade
13945
- */
13946
- staveBottom: number;
13947
- get contentTop(): number;
13948
- get contentBottom(): number;
13949
- constructor(trackIndex: number, staff: Staff, factory: BarRendererFactory);
13950
- getSharedLayoutData<T>(key: string, def: T): T;
13951
- setSharedLayoutData<T>(key: string, def: T): void;
13952
- get isInsideBracket(): boolean;
13953
- get isRelevantForBoundsLookup(): boolean;
13954
- registerStaffTop(offset: number): void;
13955
- registerStaffBottom(offset: number): void;
13956
- addBarRenderer(renderer: BarRendererBase): void;
13957
- addBar(bar: Bar, layoutingInfo: BarLayoutingInfo, additionalMultiBarsRestBars: Bar[] | null): void;
13958
- revertLastBar(): BarRendererBase;
13959
- scaleToWidth(width: number): void;
13960
- get topOverflow(): number;
13961
- get bottomOverflow(): number;
13962
- /**
13963
- * Performs an early calculation of the expected staff height for the size calculation in the
13964
- * accolade (e.g. for braces). This typically happens after the first bar renderers were created
13965
- * and we can do an early placement of the render staffs.
13966
- */
13967
- calculateHeightForAccolade(): void;
13968
- finalizeStaff(): void;
13969
- paint(cx: number, cy: number, canvas: ICanvas, startIndex: number, count: number): void;
13970
- }
13971
-
13972
12893
  /**
13973
12894
  * This class represents the rendering stylesheet.
13974
12895
  * It contains settings which control the display of the score when rendered.
13975
12896
  * @json
13976
12897
  * @json_strict
12898
+ * @public
13977
12899
  */
13978
12900
  declare class RenderStylesheet {
13979
12901
  /**
@@ -14040,6 +12962,7 @@ declare class RenderStylesheet {
14040
12962
 
14041
12963
  /**
14042
12964
  * This public class can store the information about a group of measures which are repeated
12965
+ * @public
14043
12966
  */
14044
12967
  declare class RepeatGroup {
14045
12968
  /**
@@ -14070,23 +12993,9 @@ declare class RepeatGroup {
14070
12993
  addMasterBar(masterBar: MasterBar): void;
14071
12994
  }
14072
12995
 
14073
- declare class ReservedLayoutArea {
14074
- beat: Beat;
14075
- topY: number;
14076
- bottomY: number;
14077
- slots: ReservedLayoutAreaSlot[];
14078
- constructor(beat: Beat);
14079
- addSlot(topY: number, bottomY: number): void;
14080
- }
14081
-
14082
- declare class ReservedLayoutAreaSlot {
14083
- topY: number;
14084
- bottomY: number;
14085
- constructor(topY: number, bottomY: number);
14086
- }
14087
-
14088
12996
  /**
14089
12997
  * Represents the information related to a resize event.
12998
+ * @public
14090
12999
  */
14091
13000
  export declare class ResizeEventArgs {
14092
13001
  /**
@@ -14101,16 +13010,6 @@ export declare class ResizeEventArgs {
14101
13010
  * Gets the settings currently used for rendering.
14102
13011
  */
14103
13012
  settings: Settings | null;
14104
- core(): CoreSettings;
14105
- private causeIssue;
14106
- }
14107
-
14108
- declare class RowContainerGlyph extends GlyphGroup {
14109
- private _rows;
14110
- private _align;
14111
- constructor(x: number, y: number, align?: TextAlign);
14112
- doLayout(): void;
14113
- paint(cx: number, cy: number, canvas: ICanvas): void;
14114
13013
  }
14115
13014
 
14116
13015
  /**
@@ -14119,6 +13018,7 @@ declare class RowContainerGlyph extends GlyphGroup {
14119
13018
  * a song and stores the sub components.
14120
13019
  * @json
14121
13020
  * @json_strict
13021
+ * @public
14122
13022
  */
14123
13023
  declare class Score {
14124
13024
  private _currentRepeatGroup;
@@ -14214,7 +13114,7 @@ declare class Score {
14214
13114
  * Adds the given bar correctly into the current repeat group setup.
14215
13115
  * @param bar
14216
13116
  */
14217
- private addMasterBarToRepeatGroups;
13117
+ private _addMasterBarToRepeatGroups;
14218
13118
  addTrack(track: Track): void;
14219
13119
  finish(settings: Settings): void;
14220
13120
  /**
@@ -14233,6 +13133,7 @@ declare class Score {
14233
13133
  /**
14234
13134
  * This is the base class for creating new song exporters which
14235
13135
  * enable writing scores to a binary datasink.
13136
+ * @public
14236
13137
  */
14237
13138
  declare abstract class ScoreExporter {
14238
13139
  protected data: IWriteable;
@@ -14259,6 +13160,7 @@ declare abstract class ScoreExporter {
14259
13160
  /**
14260
13161
  * This is the base public class for creating new song importers which
14261
13162
  * enable reading scores from any binary datasource
13163
+ * @public
14262
13164
  */
14263
13165
  declare abstract class ScoreImporter {
14264
13166
  protected data: IReadable;
@@ -14275,52 +13177,10 @@ declare abstract class ScoreImporter {
14275
13177
  abstract readScore(): Score;
14276
13178
  }
14277
13179
 
14278
- /**
14279
- * This is the base class for creating new layouting engines for the score renderer.
14280
- */
14281
- declare abstract class ScoreLayout {
14282
- private _barRendererLookup;
14283
- protected pagePadding: number[] | null;
14284
- abstract get name(): string;
14285
- renderer: ScoreRenderer;
14286
- width: number;
14287
- height: number;
14288
- multiBarRestInfo: Map<number, number[]> | null;
14289
- get scaledWidth(): number;
14290
- protected headerGlyphs: Map<ScoreSubElement, TextGlyph>;
14291
- protected footerGlyphs: Map<ScoreSubElement, TextGlyph>;
14292
- protected chordDiagrams: ChordDiagramContainerGlyph | null;
14293
- protected tuningGlyph: TuningContainerGlyph | null;
14294
- systemsLayoutMode: InternalSystemsLayoutMode;
14295
- constructor(renderer: ScoreRenderer);
14296
- abstract get firstBarX(): number;
14297
- abstract get supportsResize(): boolean;
14298
- resize(): void;
14299
- abstract doResize(): void;
14300
- layoutAndRender(): void;
14301
- private _lazyPartials;
14302
- protected registerPartial(args: RenderFinishedEventArgs, callback: (canvas: ICanvas) => void): void;
14303
- private internalRenderLazyPartial;
14304
- renderLazyPartial(resultId: string): void;
14305
- protected abstract doLayoutAndRender(): void;
14306
- protected static HeaderElements: Lazy<Map<ScoreSubElement, NotationElement | undefined>>;
14307
- protected static FooterElements: Lazy<Map<ScoreSubElement, NotationElement | undefined>>;
14308
- private createHeaderFooterGlyph;
14309
- private createScoreInfoGlyphs;
14310
- firstBarIndex: number;
14311
- lastBarIndex: number;
14312
- protected createEmptyStaffSystem(): StaffSystem;
14313
- registerBarRenderer(key: string, renderer: BarRendererBase): void;
14314
- unregisterBarRenderer(key: string, renderer: BarRendererBase): void;
14315
- getRendererForBar(key: string, bar: Bar): BarRendererBase | null;
14316
- protected layoutAndRenderBottomScoreInfo(y: number): number;
14317
- protected alignScoreInfoGlyph(glyph: TextGlyph): void;
14318
- layoutAndRenderAnnotation(y: number): number;
14319
- }
14320
-
14321
13180
  /**
14322
13181
  * The ScoreLoader enables you easy loading of Scores using all
14323
13182
  * available importers
13183
+ * @public
14324
13184
  */
14325
13185
  declare class ScoreLoader {
14326
13186
  /**
@@ -14351,6 +13211,7 @@ declare class ScoreLoader {
14351
13211
  /**
14352
13212
  * This is the main wrapper of the rendering engine which
14353
13213
  * can render a single track of a score object into a notation sheet.
13214
+ * @public
14354
13215
  */
14355
13216
  declare class ScoreRenderer implements IScoreRenderer {
14356
13217
  private _currentLayoutMode;
@@ -14359,7 +13220,7 @@ declare class ScoreRenderer implements IScoreRenderer {
14359
13220
  canvas: ICanvas | null;
14360
13221
  score: Score | null;
14361
13222
  tracks: Track[] | null;
14362
- /* Excluded from this release type: layout */
13223
+
14363
13224
  settings: Settings;
14364
13225
  boundsLookup: BoundsLookup | null;
14365
13226
  width: number;
@@ -14369,8 +13230,8 @@ declare class ScoreRenderer implements IScoreRenderer {
14369
13230
  */
14370
13231
  constructor(settings: Settings);
14371
13232
  destroy(): void;
14372
- private recreateCanvas;
14373
- private recreateLayout;
13233
+ private _recreateCanvas;
13234
+ private _recreateLayout;
14374
13235
  renderScore(score: Score | null, trackIndexes: number[] | null): void;
14375
13236
  /**
14376
13237
  * Initiates rendering fof the given tracks.
@@ -14381,20 +13242,21 @@ declare class ScoreRenderer implements IScoreRenderer {
14381
13242
  renderResult(resultId: string): void;
14382
13243
  render(): void;
14383
13244
  resizeRender(): void;
14384
- private layoutAndRender;
13245
+ private _layoutAndRender;
14385
13246
  readonly preRender: IEventEmitterOfT<boolean>;
14386
13247
  readonly renderFinished: IEventEmitterOfT<RenderFinishedEventArgs>;
14387
13248
  readonly partialRenderFinished: IEventEmitterOfT<RenderFinishedEventArgs>;
14388
13249
  readonly partialLayoutFinished: IEventEmitterOfT<RenderFinishedEventArgs>;
14389
13250
  readonly postRenderFinished: IEventEmitter;
14390
13251
  readonly error: IEventEmitterOfT<Error>;
14391
- private onRenderFinished;
13252
+ private _onRenderFinished;
14392
13253
  }
14393
13254
 
14394
13255
  /**
14395
13256
  * Defines the custom styles for Scores.
14396
13257
  * @json
14397
13258
  * @json_strict
13259
+ * @public
14398
13260
  */
14399
13261
  declare class ScoreStyle extends ElementStyle<ScoreSubElement> {
14400
13262
  /**
@@ -14409,6 +13271,7 @@ declare class ScoreStyle extends ElementStyle<ScoreSubElement> {
14409
13271
 
14410
13272
  /**
14411
13273
  * Lists all graphical sub elements within a {@link Score} which can be styled via {@link Score.style}
13274
+ * @public
14412
13275
  */
14413
13276
  declare enum ScoreSubElement {
14414
13277
  /**
@@ -14459,6 +13322,7 @@ declare enum ScoreSubElement {
14459
13322
 
14460
13323
  /**
14461
13324
  * Lists all modes how alphaTab can scroll the container during playback.
13325
+ * @public
14462
13326
  */
14463
13327
  export declare enum ScrollMode {
14464
13328
  /**
@@ -14480,6 +13344,7 @@ export declare enum ScrollMode {
14480
13344
  * section within a song. It acts like a marker.
14481
13345
  * @json
14482
13346
  * @json_strict
13347
+ * @public
14483
13348
  */
14484
13349
  declare class Section {
14485
13350
  /**
@@ -14496,7 +13361,7 @@ declare class Section {
14496
13361
  * This public class contains instance specific settings for alphaTab
14497
13362
  * @json
14498
13363
  * @json_declaration
14499
- * @public_api
13364
+ * @public
14500
13365
  */
14501
13366
  export declare class Settings {
14502
13367
  /**
@@ -14538,14 +13403,14 @@ export declare class Settings {
14538
13403
  * @target web
14539
13404
  */
14540
13405
  fillFromJson(json: SettingsJson): void;
14541
- /* Excluded from this release type: handleBackwardsCompatibility */
13406
+
14542
13407
  }
14543
13408
 
14544
13409
  /**
14545
13410
  * This public class contains instance specific settings for alphaTab
14546
13411
  * @json
14547
13412
  * @json_declaration
14548
- * @public_api
13413
+ * @public
14549
13414
  * @target web
14550
13415
  */
14551
13416
  declare interface SettingsJson {
@@ -14586,6 +13451,7 @@ declare interface SettingsJson {
14586
13451
 
14587
13452
  /**
14588
13453
  * Lists all simile mark types as they are assigned to bars.
13454
+ * @public
14589
13455
  */
14590
13456
  declare enum SimileMark {
14591
13457
  /**
@@ -14610,6 +13476,7 @@ declare enum SimileMark {
14610
13476
 
14611
13477
  /**
14612
13478
  * This public enum lists all different types of finger slide-ins on a string.
13479
+ * @public
14613
13480
  */
14614
13481
  declare enum SlideInType {
14615
13482
  /**
@@ -14628,6 +13495,7 @@ declare enum SlideInType {
14628
13495
 
14629
13496
  /**
14630
13497
  * This public enum lists all different types of finger slide-outs on a string.
13498
+ * @public
14631
13499
  */
14632
13500
  declare enum SlideOutType {
14633
13501
  /**
@@ -14664,6 +13532,7 @@ declare enum SlideOutType {
14664
13532
  * This object defines the details on how to generate the slide effects.
14665
13533
  * @json
14666
13534
  * @json_declaration
13535
+ * @public
14667
13536
  */
14668
13537
  export declare class SlidePlaybackSettings {
14669
13538
  /**
@@ -14694,6 +13563,7 @@ export declare class SlidePlaybackSettings {
14694
13563
  * This object defines the details on how to generate the slide effects.
14695
13564
  * @json
14696
13565
  * @json_declaration
13566
+ * @public
14697
13567
  * @target web
14698
13568
  */
14699
13569
  declare interface SlidePlaybackSettingsJson {
@@ -14724,6 +13594,7 @@ declare interface SlidePlaybackSettingsJson {
14724
13594
  /**
14725
13595
  * https://w3c.github.io/smufl/latest/specification/engravingdefaults.html
14726
13596
  * @record
13597
+ * @public
14727
13598
  */
14728
13599
  export declare interface SmuflEngravingDefaults {
14729
13600
  arrowShaftThickness: number;
@@ -14759,6 +13630,7 @@ export declare interface SmuflEngravingDefaults {
14759
13630
  /**
14760
13631
  * https://w3c.github.io/smufl/latest/specification/glyphbboxes.html
14761
13632
  * @record
13633
+ * @public
14762
13634
  */
14763
13635
  export declare interface SmuflGlyphBoundingBox {
14764
13636
  bBoxNE: [number, number];
@@ -14768,6 +13640,7 @@ export declare interface SmuflGlyphBoundingBox {
14768
13640
  /**
14769
13641
  * https://w3c.github.io/smufl/latest/specification/glyphswithanchors.html#glyphswithanchors
14770
13642
  * @record
13643
+ * @public
14771
13644
  */
14772
13645
  export declare interface SmuflGlyphWithAnchor {
14773
13646
  splitStemUpSE?: [number, number];
@@ -14798,6 +13671,7 @@ export declare interface SmuflGlyphWithAnchor {
14798
13671
  * The SmuFL Metadata object describing the structure needed by alphaTab.
14799
13672
  * https://w3c.github.io/smufl/latest/specification/font-specific-metadata.html
14800
13673
  * @record
13674
+ * @public
14801
13675
  */
14802
13676
  export declare interface SmuflMetadata {
14803
13677
  engravingDefaults: SmuflEngravingDefaults;
@@ -14805,25 +13679,12 @@ export declare interface SmuflMetadata {
14805
13679
  glyphsWithAnchors: Record<string, SmuflGlyphWithAnchor>;
14806
13680
  }
14807
13681
 
14808
- declare class Spring {
14809
- timePosition: number;
14810
- longestDuration: number;
14811
- smallestDuration: number;
14812
- force: number;
14813
- springConstant: number;
14814
- get springWidth(): number;
14815
- preBeatWidth: number;
14816
- graceBeatWidth: number;
14817
- postSpringWidth: number;
14818
- get preSpringWidth(): number;
14819
- allDurations: Set<number>;
14820
- }
14821
-
14822
13682
  /**
14823
13683
  * This class describes a single staff within a track. There are instruments like pianos
14824
13684
  * where a single track can contain multiple staves.
14825
13685
  * @json
14826
13686
  * @json_strict
13687
+ * @public
14827
13688
  */
14828
13689
  declare class Staff {
14829
13690
  static readonly DefaultStandardNotationLineCount = 5;
@@ -14914,63 +13775,9 @@ declare class Staff {
14914
13775
  addBar(bar: Bar): void;
14915
13776
  }
14916
13777
 
14917
- /**
14918
- * A StaffSystem consists of a list of different staves and groups
14919
- * them using an accolade.
14920
- */
14921
- declare class StaffSystem {
14922
- private _allStaves;
14923
- private _firstStaffInBrackets;
14924
- private _lastStaffInBrackets;
14925
- private _accoladeSpacingCalculated;
14926
- private _brackets;
14927
- private _hasSystemSeparator;
14928
- x: number;
14929
- y: number;
14930
- index: number;
14931
- /**
14932
- * The width of the whole accolade inclusive text and bar.
14933
- */
14934
- accoladeWidth: number;
14935
- /**
14936
- * Indicates whether this line is full or not. If the line is full the
14937
- * bars can be aligned to the maximum width. If the line is not full
14938
- * the bars will not get stretched.
14939
- */
14940
- isFull: boolean;
14941
- /**
14942
- * The width that the content bars actually need
14943
- */
14944
- width: number;
14945
- computedWidth: number;
14946
- totalBarDisplayScale: number;
14947
- isLast: boolean;
14948
- masterBarsRenderers: MasterBarsRenderers[];
14949
- staves: StaffTrackGroup[];
14950
- layout: ScoreLayout;
14951
- topPadding: number;
14952
- bottomPadding: number;
14953
- constructor(layout: ScoreLayout);
14954
- get firstBarIndex(): number;
14955
- get lastBarIndex(): number;
14956
- addMasterBarRenderers(tracks: Track[], renderers: MasterBarsRenderers): MasterBarsRenderers | null;
14957
- addBars(tracks: Track[], barIndex: number, additionalMultiBarRestIndexes: number[] | null): MasterBarsRenderers;
14958
- revertLastBar(): MasterBarsRenderers | null;
14959
- private updateWidthFromLastBar;
14960
- private calculateAccoladeSpacing;
14961
- private getStaffTrackGroup;
14962
- addStaff(track: Track, staff: RenderStaff): void;
14963
- get height(): number;
14964
- scaleToWidth(width: number): void;
14965
- paint(cx: number, cy: number, canvas: ICanvas): void;
14966
- paintPartial(cx: number, cy: number, canvas: ICanvas, startIndex: number, count: number): void;
14967
- finalizeSystem(): void;
14968
- buildBoundingsLookup(cx: number, cy: number): void;
14969
- getBarX(index: number): number;
14970
- }
14971
-
14972
13778
  /**
14973
13779
  * Represents the bounds of a staff system.
13780
+ * @public
14974
13781
  */
14975
13782
  declare class StaffSystemBounds {
14976
13783
  /**
@@ -15011,25 +13818,9 @@ declare class StaffSystemBounds {
15011
13818
  findBarAtPos(x: number): MasterBarBounds | null;
15012
13819
  }
15013
13820
 
15014
- /**
15015
- * Represents the group of rendered staves belonging to an individual track.
15016
- * This includes staves like effects, notation representations (numbered, tabs,..) and multiple
15017
- * staffs (grand staff).
15018
- */
15019
- declare class StaffTrackGroup {
15020
- track: Track;
15021
- staffSystem: StaffSystem;
15022
- staves: RenderStaff[];
15023
- stavesRelevantForBoundsLookup: RenderStaff[];
15024
- firstStaffInBracket: RenderStaff | null;
15025
- lastStaffInBracket: RenderStaff | null;
15026
- bracket: SystemBracket | null;
15027
- constructor(staffSystem: StaffSystem, track: Track);
15028
- addStaff(staff: RenderStaff): void;
15029
- }
15030
-
15031
13821
  /**
15032
13822
  * Lists all stave profiles controlling which staves are shown.
13823
+ * @public
15033
13824
  */
15034
13825
  export declare enum StaveProfile {
15035
13826
  /**
@@ -15059,6 +13850,7 @@ export declare enum StaveProfile {
15059
13850
  * A marker on whether a sustain pedal starts or ends.
15060
13851
  * @json
15061
13852
  * @json_strict
13853
+ * @public
15062
13854
  */
15063
13855
  declare class SustainPedalMarker {
15064
13856
  /**
@@ -15090,6 +13882,7 @@ declare class SustainPedalMarker {
15090
13882
 
15091
13883
  /**
15092
13884
  * The different pedal marker types.
13885
+ * @public
15093
13886
  */
15094
13887
  declare enum SustainPedalMarkerType {
15095
13888
  /**
@@ -15106,55 +13899,13 @@ declare enum SustainPedalMarkerType {
15106
13899
  Up = 2
15107
13900
  }
15108
13901
 
15109
- /**
15110
- * A canvas implementation storing SVG data
15111
- */
15112
- declare abstract class SvgCanvas implements ICanvas {
15113
- protected buffer: string;
15114
- private _currentPath;
15115
- private _currentPathIsEmpty;
15116
- scale: number;
15117
- color: Color;
15118
- lineWidth: number;
15119
- font: Font;
15120
- textAlign: TextAlign;
15121
- textBaseline: TextBaseline;
15122
- settings: Settings;
15123
- destroy(): void;
15124
- beginRender(width: number, height: number): void;
15125
- beginGroup(identifier: string): void;
15126
- endGroup(): void;
15127
- endRender(): unknown;
15128
- fillRect(x: number, y: number, w: number, h: number): void;
15129
- strokeRect(x: number, y: number, w: number, h: number): void;
15130
- beginPath(): void;
15131
- closePath(): void;
15132
- moveTo(x: number, y: number): void;
15133
- lineTo(x: number, y: number): void;
15134
- quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void;
15135
- bezierCurveTo(cp1X: number, cp1Y: number, cp2X: number, cp2Y: number, x: number, y: number): void;
15136
- fillCircle(x: number, y: number, radius: number): void;
15137
- strokeCircle(x: number, y: number, radius: number): void;
15138
- fill(): void;
15139
- stroke(): void;
15140
- fillText(text: string, x: number, y: number): void;
15141
- private static escapeText;
15142
- protected getSvgTextAlignment(textAlign: TextAlign): string;
15143
- protected getSvgBaseLine(): string;
15144
- measureText(text: string): MeasuredText;
15145
- abstract fillMusicFontSymbol(x: number, y: number, relativeScale: number, symbol: MusicFontSymbol, centerAtPosition?: boolean): void;
15146
- abstract fillMusicFontSymbols(x: number, y: number, relativeScale: number, symbols: MusicFontSymbol[], centerAtPosition?: boolean): void;
15147
- onRenderFinished(): unknown;
15148
- beginRotate(centerX: number, centerY: number, angle: number): void;
15149
- endRotate(): void;
15150
- }
15151
-
15152
13902
  /**
15153
13903
  * Represents the data of a sync point for synchronizing the internal time axis with
15154
13904
  * an external audio file.
15155
13905
  * @cloneable
15156
13906
  * @json
15157
13907
  * @json_strict
13908
+ * @public
15158
13909
  */
15159
13910
  declare class SyncPointData {
15160
13911
  /**
@@ -15173,7 +13924,6 @@ export declare namespace synth {
15173
13924
  AlphaSynthBase,
15174
13925
  AlphaSynth,
15175
13926
  IAlphaSynthAudioExporter,
15176
- CircularSampleBuffer,
15177
13927
  PlaybackRange,
15178
13928
  ISynthOutput,
15179
13929
  ISynthOutputDevice,
@@ -15186,10 +13936,6 @@ export declare namespace synth {
15186
13936
  PositionChangedEventArgs,
15187
13937
  MidiEventsPlayedEventArgs,
15188
13938
  ActiveBeatsChangedEventArgs,
15189
- AlphaSynthWebWorkerApi,
15190
- AlphaSynthWebAudioOutputBase,
15191
- AlphaSynthScriptProcessorOutput,
15192
- AlphaSynthAudioWorkletOutput,
15193
13939
  IAudioElementBackingTrackSynthOutput,
15194
13940
  IExternalMediaHandler,
15195
13941
  IExternalMediaSynthOutput,
@@ -15200,34 +13946,16 @@ export declare namespace synth {
15200
13946
  }
15201
13947
  }
15202
13948
 
15203
- declare class SynthEvent {
15204
- eventIndex: number;
15205
- event: MidiEvent;
15206
- readonly isMetronome: boolean;
15207
- time: number;
15208
- constructor(eventIndex: number, e: MidiEvent);
15209
- static newMetronomeEvent(eventIndex: number, tick: number, counter: number, durationInTicks: number, durationInMillis: number): SynthEvent;
15210
- }
15211
-
15212
- declare abstract class SystemBracket {
15213
- firstStaffInBracket: RenderStaff | null;
15214
- lastStaffInBracket: RenderStaff | null;
15215
- drawAsBrace: boolean;
15216
- braceScale: number;
15217
- width: number;
15218
- index: number;
15219
- abstract includesStaff(s: RenderStaff): boolean;
15220
- finalizeBracket(smuflMetrics: EngravingSettings): void;
15221
- }
15222
-
15223
13949
  /**
15224
13950
  * @deprecated Move to the new concrete Midi Event Types.
13951
+ * @public
15225
13952
  */
15226
13953
  declare class SystemCommonEvent extends DeprecatedMidiEvent {
15227
13954
  }
15228
13955
 
15229
13956
  /**
15230
13957
  * @deprecated Move to the new concrete Midi Event Types.
13958
+ * @public
15231
13959
  */
15232
13960
  declare enum SystemCommonType {
15233
13961
  SystemExclusive = 240,
@@ -15240,6 +13968,7 @@ declare enum SystemCommonType {
15240
13968
 
15241
13969
  /**
15242
13970
  * @deprecated Move to the new concrete Midi Event Types.
13971
+ * @public
15243
13972
  */
15244
13973
  declare class SystemExclusiveEvent extends SystemCommonEvent {
15245
13974
  static readonly AlphaTabManufacturerId = 125;
@@ -15254,6 +13983,7 @@ declare class SystemExclusiveEvent extends SystemCommonEvent {
15254
13983
 
15255
13984
  /**
15256
13985
  * Lists the different modes in which the staves and systems are arranged.
13986
+ * @public
15257
13987
  */
15258
13988
  export declare enum SystemsLayoutMode {
15259
13989
  /**
@@ -15268,6 +13998,7 @@ export declare enum SystemsLayoutMode {
15268
13998
 
15269
13999
  /**
15270
14000
  * Lists the different modes on how rhythm notation is shown on the tab staff.
14001
+ * @public
15271
14002
  */
15272
14003
  export declare enum TabRhythmMode {
15273
14004
  /**
@@ -15291,6 +14022,7 @@ export declare enum TabRhythmMode {
15291
14022
 
15292
14023
  /**
15293
14024
  * This public enum lists all base line modes
14025
+ * @public
15294
14026
  */
15295
14027
  declare enum TechniqueSymbolPlacement {
15296
14028
  /**
@@ -15313,6 +14045,7 @@ declare enum TechniqueSymbolPlacement {
15313
14045
 
15314
14046
  /**
15315
14047
  * Represents a change of the tempo in the song.
14048
+ * @public
15316
14049
  */
15317
14050
  declare class TempoChangeEvent extends MidiEvent {
15318
14051
  /**
@@ -15333,6 +14066,7 @@ declare class TempoChangeEvent extends MidiEvent {
15333
14066
 
15334
14067
  /**
15335
14068
  * This public enum lists all different text alignments
14069
+ * @public
15336
14070
  */
15337
14071
  declare enum TextAlign {
15338
14072
  /**
@@ -15341,14 +14075,17 @@ declare enum TextAlign {
15341
14075
  Left = 0,
15342
14076
  /**
15343
14077
  * Text is centered.
15344
- */ Center = 1,
14078
+ */
14079
+ Center = 1,
15345
14080
  /**
15346
14081
  * Text is right aligned.
15347
- */ Right = 2
14082
+ */
14083
+ Right = 2
15348
14084
  }
15349
14085
 
15350
14086
  /**
15351
14087
  * This public enum lists all base line modes
14088
+ * @public
15352
14089
  */
15353
14090
  declare enum TextBaseline {
15354
14091
  /**
@@ -15369,20 +14106,9 @@ declare enum TextBaseline {
15369
14106
  Alphabetic = 3
15370
14107
  }
15371
14108
 
15372
- declare class TextGlyph extends EffectGlyph {
15373
- private _lines;
15374
- private _lineHeights;
15375
- font: Font;
15376
- textAlign: TextAlign;
15377
- textBaseline: TextBaseline | null;
15378
- colorOverride?: Color;
15379
- constructor(x: number, y: number, text: string, font: Font, textAlign?: TextAlign, testBaseline?: TextBaseline | null, color?: Color);
15380
- doLayout(): void;
15381
- paint(cx: number, cy: number, canvas: ICanvas): void;
15382
- }
15383
-
15384
14109
  /**
15385
14110
  * Represents a time signature change event.
14111
+ * @public
15386
14112
  */
15387
14113
  declare class TimeSignatureEvent extends MidiEvent {
15388
14114
  /**
@@ -15411,9 +14137,10 @@ declare class TimeSignatureEvent extends MidiEvent {
15411
14137
  * It is primarily a list of staves containing individual music notation kinds.
15412
14138
  * @json
15413
14139
  * @json_strict
14140
+ * @public
15414
14141
  */
15415
14142
  declare class Track {
15416
- private static readonly ShortNameMaxLength;
14143
+ private static readonly _shortNameMaxLength;
15417
14144
  /**
15418
14145
  * Gets or sets the zero-based index of this track.
15419
14146
  * @json_ignore
@@ -15493,6 +14220,7 @@ declare class Track {
15493
14220
 
15494
14221
  /**
15495
14222
  * Lists the different modes what text to display for track names.
14223
+ * @public
15496
14224
  */
15497
14225
  declare enum TrackNameMode {
15498
14226
  /**
@@ -15507,6 +14235,7 @@ declare enum TrackNameMode {
15507
14235
 
15508
14236
  /**
15509
14237
  * Lists the different orientations modes how to render the track names.
14238
+ * @public
15510
14239
  */
15511
14240
  declare enum TrackNameOrientation {
15512
14241
  /**
@@ -15521,6 +14250,7 @@ declare enum TrackNameOrientation {
15521
14250
 
15522
14251
  /**
15523
14252
  * Lists the different policies on how to display the track names.
14253
+ * @public
15524
14254
  */
15525
14255
  declare enum TrackNamePolicy {
15526
14256
  /**
@@ -15541,12 +14271,14 @@ declare enum TrackNamePolicy {
15541
14271
  * Defines the custom styles for tracks.
15542
14272
  * @json
15543
14273
  * @json_strict
14274
+ * @public
15544
14275
  */
15545
14276
  declare class TrackStyle extends ElementStyle<TrackSubElement> {
15546
14277
  }
15547
14278
 
15548
14279
  /**
15549
14280
  * Lists all graphical sub elements within a {@link Track} which can be styled via {@link Track.style}
14281
+ * @public
15550
14282
  */
15551
14283
  declare enum TrackSubElement {
15552
14284
  /**
@@ -15570,6 +14302,7 @@ declare enum TrackSubElement {
15570
14302
 
15571
14303
  /**
15572
14304
  * This public enumeration lists all feels of triplets.
14305
+ * @public
15573
14306
  */
15574
14307
  declare enum TripletFeel {
15575
14308
  /**
@@ -15606,6 +14339,7 @@ declare enum TripletFeel {
15606
14339
  * This public class represents a predefined string tuning.
15607
14340
  * @json
15608
14341
  * @json_strict
14342
+ * @public
15609
14343
  */
15610
14344
  declare class Tuning {
15611
14345
  private static _sevenStrings;
@@ -15661,23 +14395,20 @@ declare class Tuning {
15661
14395
  finish(): void;
15662
14396
  }
15663
14397
 
15664
- declare class TuningContainerGlyph extends RowContainerGlyph {
15665
- constructor(x: number, y: number);
15666
- }
15667
-
15668
14398
  /**
15669
14399
  * Represents a list of beats that are grouped within the same tuplet.
14400
+ * @public
15670
14401
  */
15671
14402
  declare class TupletGroup {
15672
- private static readonly HalfTicks;
15673
- private static readonly QuarterTicks;
15674
- private static readonly EighthTicks;
15675
- private static readonly SixteenthTicks;
15676
- private static readonly ThirtySecondTicks;
15677
- private static readonly SixtyFourthTicks;
15678
- private static readonly OneHundredTwentyEighthTicks;
15679
- private static readonly TwoHundredFiftySixthTicks;
15680
- private static AllTicks;
14403
+ private static readonly _halfTicks;
14404
+ private static readonly _quarterTicks;
14405
+ private static readonly _eighthTicks;
14406
+ private static readonly _sixteenthTicks;
14407
+ private static readonly _thirtySecondTicks;
14408
+ private static readonly _sixtyFourthTicks;
14409
+ private static readonly _oneHundredTwentyEighthTicks;
14410
+ private static readonly _twoHundredFiftySixthTicks;
14411
+ private static _allTicks;
15681
14412
  private _isEqualLengthTuplet;
15682
14413
  totalDuration: number;
15683
14414
  /**
@@ -15703,6 +14434,7 @@ declare class TupletGroup {
15703
14434
  /**
15704
14435
  * The exception thrown by a {@link ScoreImporter} in case the
15705
14436
  * binary data does not contain a reader compatible structure.
14437
+ * @public
15706
14438
  */
15707
14439
  declare class UnsupportedFormatError extends AlphaTabError {
15708
14440
  constructor(message?: string | null, inner?: Error);
@@ -15712,6 +14444,7 @@ declare class UnsupportedFormatError extends AlphaTabError {
15712
14444
  * This object defines the details on how to generate the vibrato effects.
15713
14445
  * @json
15714
14446
  * @json_declaration
14447
+ * @public
15715
14448
  */
15716
14449
  export declare class VibratoPlaybackSettings {
15717
14450
  /**
@@ -15760,6 +14493,7 @@ export declare class VibratoPlaybackSettings {
15760
14493
  * This object defines the details on how to generate the vibrato effects.
15761
14494
  * @json
15762
14495
  * @json_declaration
14496
+ * @public
15763
14497
  * @target web
15764
14498
  */
15765
14499
  declare interface VibratoPlaybackSettingsJson {
@@ -15807,6 +14541,7 @@ declare interface VibratoPlaybackSettingsJson {
15807
14541
 
15808
14542
  /**
15809
14543
  * This public enum lists all vibrato types that can be performed.
14544
+ * @public
15810
14545
  */
15811
14546
  declare enum VibratoType {
15812
14547
  /**
@@ -15828,13 +14563,14 @@ declare enum VibratoType {
15828
14563
  * that can be played during a bar.
15829
14564
  * @json
15830
14565
  * @json_strict
14566
+ * @public
15831
14567
  */
15832
14568
  declare class Voice {
15833
14569
  private _beatLookup;
15834
14570
  private _isEmpty;
15835
14571
  private _isRestOnly;
15836
14572
  private static _globalVoiceId;
15837
- /* Excluded from this release type: resetIds */
14573
+
15838
14574
  /**
15839
14575
  * Gets or sets the unique id of this bar.
15840
14576
  */
@@ -15862,49 +14598,32 @@ declare class Voice {
15862
14598
  * The style customizations for this item.
15863
14599
  */
15864
14600
  style?: VoiceStyle;
15865
- /* Excluded from this release type: forceNonEmpty */
14601
+
15866
14602
  /**
15867
14603
  * Gets or sets a value indicating whether this voice is empty.
15868
14604
  */
15869
14605
  get isRestOnly(): boolean;
15870
14606
  insertBeat(after: Beat, newBeat: Beat): void;
15871
14607
  addBeat(beat: Beat): void;
15872
- private chain;
14608
+ private _chain;
15873
14609
  addGraceBeat(beat: Beat): void;
15874
14610
  getBeatAtPlaybackStart(playbackStart: number): Beat | null;
15875
14611
  finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void;
15876
14612
  calculateDuration(): number;
15877
14613
  }
15878
14614
 
15879
- /**
15880
- * This glyph acts as container for handling
15881
- * multiple voice rendering
15882
- */
15883
- declare class VoiceContainerGlyph extends GlyphGroup {
15884
- static readonly KeySizeBeat: string;
15885
- beatGlyphs: BeatContainerGlyph[];
15886
- voice: Voice;
15887
- tupletGroups: TupletGroup[];
15888
- constructor(x: number, y: number, voice: Voice);
15889
- scaleToWidth(width: number): void;
15890
- private scaleToForce;
15891
- registerLayoutingInfo(info: BarLayoutingInfo): void;
15892
- applyLayoutingInfo(info: BarLayoutingInfo): void;
15893
- addGlyph(g: Glyph): void;
15894
- doLayout(): void;
15895
- paint(cx: number, cy: number, canvas: ICanvas): void;
15896
- }
15897
-
15898
14615
  /**
15899
14616
  * Defines the custom styles for voices.
15900
14617
  * @json
15901
14618
  * @json_strict
14619
+ * @public
15902
14620
  */
15903
14621
  declare class VoiceStyle extends ElementStyle<VoiceSubElement> {
15904
14622
  }
15905
14623
 
15906
14624
  /**
15907
14625
  * Lists all graphical sub elements within a {@link Voice} which can be styled via {@link Voice.style}
14626
+ * @public
15908
14627
  */
15909
14628
  declare enum VoiceSubElement {
15910
14629
  /**
@@ -15915,6 +14634,7 @@ declare enum VoiceSubElement {
15915
14634
 
15916
14635
  /**
15917
14636
  * Lists all wah pedal modes.
14637
+ * @public
15918
14638
  */
15919
14639
  declare enum WahPedal {
15920
14640
  None = 0,
@@ -15925,6 +14645,7 @@ declare enum WahPedal {
15925
14645
  /**
15926
14646
  * Lists all web specific platforms alphaTab might run in
15927
14647
  * like browser, nodejs.
14648
+ * @public
15928
14649
  */
15929
14650
  export declare enum WebPlatform {
15930
14651
  Browser = 0,
@@ -15934,6 +14655,7 @@ export declare enum WebPlatform {
15934
14655
 
15935
14656
  /**
15936
14657
  * Lists all types of whammy bars
14658
+ * @public
15937
14659
  */
15938
14660
  declare enum WhammyType {
15939
14661
  /**