alphaTab.AlphaTabApi
Description
(no description)
class AlphaTabApi extends AlphaTabApiBase<SettingsJson | Settings>Properties
boundsLookup | The tick cache allowing lookup of midi ticks to beats. (Inherited from |
canvasElement | The UI container that will hold all rendered results. (Inherited from |
container | The UI container that holds the whole alphaTab control. (Inherited from |
countInVolume | The volume of the count-in metronome ticks. (Inherited from |
isLooping | Whether the playback should automatically restart after it finished. (Inherited from |
isReadyForPlayback | Whether the player is ready for starting the playback. (Inherited from |
masterVolume | The current master volume as percentage (0-1). (Inherited from |
metronomeVolume | The metronome volume as percentage (0-1). (Inherited from |
midiEventsPlayedFilter | The midi events which will trigger the |
playbackRange | The range of the song that should be played. (Inherited from |
playbackSpeed | The current playback speed as percentage (Inherited from |
player | The alphaSynth player used for playback. (Inherited from |
playerState | The current player state. (Inherited from |
renderer | The score renderer used for rendering the music sheet. (Inherited from |
score | The score holding all information about the song being rendered (Inherited from |
settings | The settings that are used for rendering the music notation. (Inherited from |
tickCache | The tick cache allowing lookup of midi ticks to beats. (Inherited from |
tickPosition | The position within the song in midi ticks. (Inherited from |
timePosition | The position within the song in milliseconds (Inherited from |
tracks | The list of the tracks that are currently rendered. (Inherited from |
uiFacade | Gets the UI facade to use for interacting with the user interface. (Inherited from |
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. (Inherited from |
changeTrackVolume(Track[], number) | Changes the volume of the given tracks. |
destroy() | Destroys the alphaTab control and restores the initial state of the UI. (Inherited from |
downloadMidi(MidiFileFormat) | Generates an SMF1.0 file and downloads it |
enumerateOutputDevices() | Loads and lists the available output devices which can be used by the player. (Inherited from |
getOutputDevice() | The currently configured output device if changed via |
load(unknown, number[]) | Initiates a load of the score using the given data. (Inherited from |
loadSoundFont(unknown, boolean) | Triggers a load of the soundfont from the given data. (Inherited from |
loadSoundFontFromUrl(string, boolean) | Triggers a load of the soundfont from the given URL. |
pause() | Pauses the playback of the current song. (Inherited from |
play() | Starts the playback of the current song. (Inherited from |
playBeat(Beat) | Triggers the play of the given beat. (Inherited from |
playNote(Note) | Triggers the play of the given note. (Inherited from |
playPause() | Toggles between play/pause depending on the current player state. (Inherited from |
print(string, unknown) | Opens a popup window with the rendered music notation for printing. |
render() | Initiates a re-rendering of the current setup. (Inherited from |
renderScore(Score, number[]) | Initiates a rendering of the given score. (Inherited from |
renderTracks(Track[]) | Renders the given list of tracks. (Inherited from |
resetSoundFonts() | Unloads all presets from previously loaded SoundFonts. (Inherited from |
scrollToCursor() | Initiates a scroll to the cursor. (Inherited from |
setOutputDevice(ISynthOutputDevice | null) | Changes the output device which should be used for playing the audio (player must be enabled). (Inherited from |
stop() | Stops the playback of the current song, and moves the playback position back to the start. (Inherited from |
tex(string, number[]) | Tells alphaTab to render the given alphaTex. |
updateSettings() | Applies any changes that were done to the settings object. (Inherited from |
Events
activeBeatsChanged | This event is fired when the currently active beats across all tracks change. (Inherited from |
beatMouseDown | This event is fired whenever a the user presses the mouse button on a beat. (Inherited from |
beatMouseMove | This event is fired whenever the user moves the mouse over a beat after the user already pressed the button on a beat. (Inherited from |
beatMouseUp | This event is fired whenever the user releases the mouse after a mouse press on a beat. (Inherited from |
error | This event is fired when an error within alphatab occurred. (Inherited from |
midiEventsPlayed | This event is fired when the synthesizer played certain midi events. (Inherited from |
midiLoad | This event is fired when a Midi file is being loaded. (Inherited from |
midiLoaded | This event is fired when the Midi file needed for playback was loaded. (Inherited from |
noteMouseDown | This event is fired whenever a the user presses the mouse button on a note head/number. (Inherited from |
noteMouseMove | This event is fired whenever the user moves the mouse over a note after the user already pressed the button on a note. (Inherited from |
noteMouseUp | This event is fired whenever the user releases the mouse after a mouse press on a note. (Inherited from |
playbackRangeChanged | This event is fired when the playback range changed. (Inherited from |
playedBeatChanged | This event is fired when the played beat changed. (Inherited from |
playerFinished | This event is fired when the playback of the whole song finished. (Inherited from |
playerPositionChanged | This event is fired when the current playback position of the song changed. (Inherited from |
playerReady | This event is fired when all required data for playback is loaded and ready. (Inherited from |
playerStateChanged | This event is fired when the playback state changed. (Inherited from |
postRenderFinished | This event is fired when the rendering of the whole music sheet is finished, and all handlers of |
renderFinished | This event is fired when the rendering of the whole music sheet is finished. (Inherited from |
renderStarted | This event is fired when the rendering of the whole music sheet is starting. (Inherited from |
resize | This event is fired when alphaTab was resized and is about to rerender the music notation. (Inherited from |
scoreLoaded | This event is fired whenever a new song is loaded. (Inherited from |
soundFontLoad | This event is fired when the SoundFont is being loaded. |
soundFontLoaded | This event is fired when the SoundFont needed for playback was loaded. (Inherited from |