Platforms and packages
alphaTab ships for three ecosystems from one TypeScript source. This page lists every package, what it contains, and which package to install for your runtime.
At a glanceโ
| Package | Runs on | UI control | Render engines | Audio output |
|---|---|---|---|---|
@coderline/alphatab | Evergreen browsers, Node.js | AlphaTabApi on any DOM element | SVG, HTML5 Canvas; alphaSkia in Node.js | Web Audio (browser) |
AlphaTab | .NET Standard 2.0 | โ | Skia, GDI+, SVG | โ |
AlphaTab.Windows | .NET 8 on Windows | WPF and WinForms controls | Skia, GDI+, SVG | NAudio |
net.alphatab:alphaTab-core | JVM 17+ | โ | Skia, SVG | โ |
net.alphatab:alphaTab | Android 8.0+ (API 26) | AlphaTabView | Skia, Android Canvas, SVG | Android AudioTrack |
Packages without a UI control are used through the low-level APIs: load files, render to images or SVG, generate MIDI, synthesize and export audio. Packages without an audio output still run the synthesizer; to play its samples, implement ISynthOutput for the sound API of your platform.
Webโ
@coderline/alphatabcontains everything for the browser and for Node.js, with no runtime dependencies.@coderline/alphatab-webpackand@coderline/alphatab-viteare build plugins that wire up alphaTab's workers, worklets, font and SoundFont in your bundler.@coderline/alphatab-monacoand@coderline/alphatab-language-serveradd alphaTex editing support.@coderline/alphaskiaplus@coderline/alphaskia-windows,-linuxor-macosenable PNG rendering in Node.js; see Node.js headless rendering.
Start with Installation (Web).
.NETโ
AlphaTabtargets .NET Standard 2.0 for console tools, servers and headless rendering.AlphaTab.Windowstargets .NET 8.0 on Windows and adds the WPF and WinForms controls and NAudio playback. It depends onAlphaTab.AlphaSkia.Native.Windows,AlphaSkia.Native.LinuxandAlphaSkia.Native.MacOsprovide the native Skia library per operating system.AlphaTab.Windowsbrings the Windows one.
Start with Installation (.NET).
Kotlinโ
net.alphatab:alphaTab-coreruns on any JVM 17 or newer, on servers, in command-line tools and in desktop applications. It is the platform-independent part of alphaTab for Kotlin and Java code.net.alphatab:alphaTabis the Android library. It adds theAlphaTabView, the Android canvas and audio output, bundles the Bravura font and the default SoundFont, and depends onalphaTab-corein exactly the same version.net.alphatab:alphaSkia-windows,alphaSkia-linuxandalphaSkia-macosprovide the native Skia library on the JVM. The Android library bringsalphaSkia-android.
There is no UI control for desktop JVM toolkits such as Swing or JavaFX, and none is planned.
Start with Installation (Kotlin).