Skip to main content

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
errorAll
postRenderFinishedAll
renderFinishedAll
renderStartedAll
resizeAll
scoreLoadedAll
Events - Player
activeBeatsChangedAll
beatMouseDownAll
beatMouseMoveAll
beatMouseUpAll
midiEventsPlayedAll
midiLoadAll
midiLoadedAll
noteMouseDownAll
noteMouseMoveAll
noteMouseUpAll
playbackRangeChangedAll
playedBeatChangedAll
playerFinishedAll
playerPositionChangedAll
playerReadyAll
playerStateChangedAll
soundFontLoadJavaScript
soundFontLoadedAll
Methods - Core
destroyAll
downloadMidiJavaScript
printJavaScript
renderAll
renderScoreAll
renderTracksAll
texAll
updateSettingsAll
Methods - Player
changeTrackMuteAll
changeTrackSoloAll
changeTrackTranspositionPitchAll
changeTrackVolumeAll
enumerateOutputDevicesAll
getOutputDeviceAll
loadAll
loadSoundFontAll
loadSoundFontFromUrlJavaScript
pauseAll
playAll
playBeatAll
playNoteAll
playPauseAll
resetSoundFontsAll
scrollToCursorAll
setOutputDeviceAll
stopAll
Properties - Core
boundsLookupAll
canvasElementAll
containerAll
rendererAll
scoreAll
settingsAll
tracksAll
uiFacadeAll
Properties - Player
countInVolumeAll
isLoopingAll
isReadyForPlaybackAll
masterVolumeAll
metronomeVolumeAll
midiEventsPlayedFilterAll
playbackRangeAll
playbackSpeedAll
playerAll
playerStateAll
tickCacheAll
tickPositionAll
timePositionAll