API

On many platforms an alphaTab API object can be used to bootstrap alphaTab within your UI. It takes over all responsibilities of linking your actions to the UI. Namely this object is called AlphaTabApi (Web) or AlphaTabApiBase<> (.net). This page describes all methods, properties and events exposed by this API object.

NameSummary
Events - Core
errorJavaScript
alphaTab.errorjQuery
alphaTab.errorHTML
Error.net
This event is fired when an error within alphatab occurred.
postRenderFinishedJavaScript
alphaTab.postRenderFinishedjQuery
alphaTab.postRenderFinishedHTML
PostRenderFinished.net
This event is fired when the rendering of the whole music sheet is finished, and all handlers of RenderFinished ran.
renderFinishedJavaScript
alphaTab.renderFinishedjQuery
alphaTab.renderFinishedHTML
RenderFinished.net
This event is fired when the rendering of the whole music sheet is finished.
renderStartedJavaScript
alphaTab.renderStartedjQuery
alphaTab.renderStartedHTML
RenderStarted.net
This event is fired when the rendering of the whole music sheet is starting.
resizeJavaScript
alphaTab.resizejQuery
alphaTab.resizeHTML
Resize.net
This event is fired when alphaTab was resized and is about to rerender the music notation.
scoreLoadedJavaScript
alphaTab.scoreLoadedjQuery
alphaTab.scoreLoadedHTML
ScoreLoaded.net
This event is fired whenever a new song is loaded
Events - Player
beatMouseDownJavaScript
alphaTab.beatMouseDownjQuery
alphaTab.beatMouseDownHTML
BeatMouseDown.net
This event is fired whenever a the user presses the mouse button on a beat.
beatMouseMoveJavaScript
alphaTab.beatMouseMovejQuery
alphaTab.beatMouseMoveHTML
BeatMouseMove.net
This event is fired whenever the user moves the mouse over a beat after the user already pressed the button on a beat.
beatMouseUpJavaScript
alphaTab.beatMouseUpjQuery
alphaTab.beatMouseUpHTML
BeatMouseUp.net
This event is fired whenever the user releases the mouse after a mouse press on a beat.
midiLoadedJavaScript
alphaTab.midiLoadedjQuery
alphaTab.midiLoadedHTML
MidiLoaded.net
This event is fired when the Midi file needed for playback was loaded.
playedBeatChangedJavaScript
alphaTab.playedBeatChangedjQuery
alphaTab.playedBeatChangedHTML
PlayedBeatChanged.net
This event is fired when the played beat changed.
playerFinishedJavaScript
alphaTab.playerFinishedjQuery
alphaTab.playerFinishedHTML
PlayerFinished.net
This event is fired when the playback of the whole song finished.
playerPositionChangedJavaScript
alphaTab.playerPositionChangedjQuery
alphaTab.playerPositionChangedHTML
PlayerPositionChanged.net
This event is fired when the playback state changed.
playerReadyJavaScript
alphaTab.playerReadyjQuery
alphaTab.playerReadyHTML
PlayerReady.net
This event is fired when all required data for playback is loaded and ready.
playerStateChangedJavaScript
alphaTab.playerStateChangedjQuery
alphaTab.playerStateChangedHTML
PlayerStateChanged.net
This event is fired when the playback state changed.
soundFontLoadJavaScript
alphaTab.soundFontLoadjQuery
alphaTab.soundFontLoadHTML
SoundFontLoad.net
This event is fired when the SoundFont is being loaded.
soundFontLoadedJavaScript
alphaTab.soundFontLoadedjQuery
alphaTab.soundFontLoadedHTML
SoundFontLoaded.net
This event is fired when the SoundFont needed for playback was loaded.
Methods - Core
AlphaTabApi()JavaScript
alphaTab()jQuery
Initializes AlphaTab.
destroy()JavaScript
alphaTab('destroy')jQuery
Destroy().net
Destroys the alphaTab control and restores the initial state of the UI.
load()JavaScript
alphaTab('load')jQuery
Load().net
Initiates a load of the score using the given data.
print()JavaScript
alphaTab('print')jQuery
Opens a popup window with the rendered music notation for printing.
render()JavaScript
alphaTab('render')jQuery
Render().net
Initiates a re-rendering of the current setup.
renderScore()JavaScript
alphaTab('renderScore')jQuery
RenderScore().net
Initiates a rendering of the given score.
renderTracks()JavaScript
alphaTab('renderTracks')jQuery
RenderTracks().net
Initiates a rendering of the given tracks.
tex()JavaScript
alphaTab('tex')jQuery
Tex().net
Tells alphaTab to render the given alphaTex.
updateSettings()JavaScript
alphaTab('updateSettings')jQuery
UpdateSettings().net
Applies any changes that were done to the settings object and informs the Renderer about any new values to consider.
Methods - Player
changeTrackMute()JavaScript
alphaTab('muteTracks')jQuery
ChangeTrackMute().net
Changes the given tracks to be muted or not.
changeTrackSolo()JavaScript
alphaTab('soloTracks')jQuery
ChangeTrackSolo().net
Changes the given tracks to be played solo or not.
changeTrackVolume()JavaScript
alphaTab('trackVolume')jQuery
ChangeTrackVolume().net
Changes the volume of the given tracks.
loadSoundFont()JavaScript
alphaTab('loadSoundFont')jQuery
LoadSoundFont().net
Triggers a load of the soundfont from the given data.
pause()JavaScript
alphaTab('pause')jQuery
Pause().net
Pauses the playback of the current song.
play()JavaScript
alphaTab('play')jQuery
Play().net
Starts the playback of the current song.
playPause()JavaScript
alphaTab('playPause')jQuery
PlayPause().net
Toggles between play/pause depending on the current player state.
resetSoundFonts()JavaScript
alphaTab('resetSoundFonts')jQuery
ResetSoundFonts().net
Unloads all presets from previously loaded SoundFonts.
stop()JavaScript
alphaTab('stop')jQuery
Stop().net
Stops the playback of the current song, and moves the playback position back to the start.
Properties - Core
containerJavaScript
alphaTab('container')jQuery
Container.net
The UI container that holds the whole alphaTab control.
rendererJavaScript
alphaTab('renderer')jQuery
Renderer.net
The score renderer used for rendering the music sheet. This is the low-level API responsible for the actual rendering chain.
scoreJavaScript
alphaTab('score')jQuery
Score.net
The score holding all information about the song being rendered
settingsJavaScript
alphaTab('settings')jQuery
Settings.net
The settings that are used for rendering the music notation
thisJavaScript
alphaTab('this')jQuery
Returns the underlying API object.
tracksJavaScript
alphaTab('tracks')jQuery
Tracks.net
A list of the tracks that should be rendered based on the Score and TrackIndexes properties
Properties - Player
isLoopingJavaScript
alphaTab('looping')jQuery
IsLooping.net
Whether the playback should automatically restart after it finished
isReadyForPlaybackJavaScript
alphaTab('isReadyForPlayback')jQuery
IsReadyForPlayback.net
Whether the player is ready for starting the playback.
masterVolumeJavaScript
alphaTab('masterVolume')jQuery
MasterVolume.net
The current master volume as percentage
metronomeVolumeJavaScript
alphaTab('metronomeVolume')jQuery
MetronomeVolume.net
The metronome volume as percentage
playbackRangeJavaScript
alphaTab('playbackRange')jQuery
PlaybackRange.net
The range of the song that should be played
playbackSpeedJavaScript
alphaTab('playbackSpeed')jQuery
PlaybackSpeed.net
The current playback speed as percentage
playerJavaScript
alphaTab('player')jQuery
Player.net
The alphaSynth player used for playback. This is the low-level API to the Midi synthesizer used for playback.
playerStateJavaScript
alphaTab('playerState')jQuery
PlayerState.net
The current player state
tickPositionJavaScript
alphaTab('tickPosition')jQuery
TickPosition.net
The position within the song in midi ticks
timePositionJavaScript
alphaTab('timePosition')jQuery
TimePosition.net
The position within the song in milliseconds