alphaTab.AlphaTabApiBase

Description

This class represents the public API of alphaTab and provides all logic to display a music sheet in any UI using the given IUiFacade

 class AlphaTabApiBase<TSettings>

Properties

`boundsLookup`	The tick cache allowing lookup of midi ticks to beats.
`canvasElement`	The UI container that will hold all rendered results.
`container`	The UI container that holds the whole alphaTab control.
`countInVolume`	The volume of the count-in metronome ticks.
`isLooping`	Whether the playback should automatically restart after it finished.
`isReadyForPlayback`	Whether the player is ready for starting the playback.
`masterVolume`	The current master volume as percentage (0-1).
`metronomeVolume`	The metronome volume as percentage (0-1).
`midiEventsPlayedFilter`	The midi events which will trigger the `midiEventsPlayed` event
`playbackRange`	The range of the song that should be played.
`playbackSpeed`	The current playback speed as percentage
`player`	The alphaSynth player used for playback.
`playerState`	The current player state.
`renderer`	The score renderer used for rendering the music sheet.
`score`	The score holding all information about the song being rendered
`settings`	The settings that are used for rendering the music notation.
`tickCache`	The tick cache allowing lookup of midi ticks to beats.
`tickPosition`	The position within the song in midi ticks.
`timePosition`	The position within the song in milliseconds
`tracks`	The list of the tracks that are currently rendered.
`uiFacade`	Gets the UI facade to use for interacting with the user interface.

Methods

`changeTrackMute(Track[], boolean)`	Changes the given tracks to be muted or not.
`changeTrackSolo(Track[], boolean)`	Changes the given tracks to be played solo or not.
`changeTrackTranspositionPitch(Track[], number)`	Changes the pitch transpose applied to the given tracks.
`changeTrackVolume(Track[], number)`	Changes the volume of the given tracks.
`destroy()`	Destroys the alphaTab control and restores the initial state of the UI.
`enumerateOutputDevices()`	Loads and lists the available output devices which can be used by the player.
`getOutputDevice()`	The currently configured output device if changed via `setOutputDevice`.
`load(unknown, number[])`	Initiates a load of the score using the given data.
`loadSoundFont(unknown, boolean)`	Triggers a load of the soundfont from the given data.
`pause()`	Pauses the playback of the current song.
`play()`	Starts the playback of the current song.
`playBeat(Beat)`	Triggers the play of the given beat.
`playNote(Note)`	Triggers the play of the given note.
`playPause()`	Toggles between play/pause depending on the current player state.
`render()`	Initiates a re-rendering of the current setup.
`renderScore(Score, number[])`	Initiates a rendering of the given score.
`renderTracks(Track[])`	Renders the given list of tracks.
`resetSoundFonts()`	Unloads all presets from previously loaded SoundFonts.
`scrollToCursor()`	Initiates a scroll to the cursor.
`setOutputDevice(ISynthOutputDevice \| null)`	Changes the output device which should be used for playing the audio (player must be enabled).
`stop()`	Stops the playback of the current song, and moves the playback position back to the start.
`tex(string, number[])`	Tells alphaTab to render the given alphaTex.
`updateSettings()`	Applies any changes that were done to the settings object.

Events

`activeBeatsChanged`	This event is fired when the currently active beats across all tracks change.
`beatMouseDown`	This event is fired whenever a the user presses the mouse button on a beat.
`beatMouseMove`	This event is fired whenever the user moves the mouse over a beat after the user already pressed the button on a beat.
`beatMouseUp`	This event is fired whenever the user releases the mouse after a mouse press on a beat.
`error`	This event is fired when an error within alphatab occurred.
`midiEventsPlayed`	This event is fired when the synthesizer played certain midi events.
`midiLoad`	This event is fired when a Midi file is being loaded.
`midiLoaded`	This event is fired when the Midi file needed for playback was loaded.
`noteMouseDown`	This event is fired whenever a the user presses the mouse button on a note head/number.
`noteMouseMove`	This event is fired whenever the user moves the mouse over a note after the user already pressed the button on a note.
`noteMouseUp`	This event is fired whenever the user releases the mouse after a mouse press on a note.
`playbackRangeChanged`	This event is fired when the playback range changed.
`playedBeatChanged`	This event is fired when the played beat changed.
`playerFinished`	This event is fired when the playback of the whole song finished.
`playerPositionChanged`	This event is fired when the current playback position of the song changed.
`playerReady`	This event is fired when all required data for playback is loaded and ready.
`playerStateChanged`	This event is fired when the playback state changed.
`postRenderFinished`	This event is fired when the rendering of the whole music sheet is finished, and all handlers of `renderFinished` ran.
`renderFinished`	This event is fired when the rendering of the whole music sheet is finished.
`renderStarted`	This event is fired when the rendering of the whole music sheet is starting.
`resize`	This event is fired when alphaTab was resized and is about to rerender the music notation.
`scoreLoaded`	This event is fired whenever a new song is loaded.
`soundFontLoaded`	This event is fired when the SoundFont needed for playback was loaded.