alphaTab.Environment

This public class represents the global alphaTab environment where alphaTab looks for information like available layout engines staves etc. This public class represents the global alphaTab environment where alphaTab looks for information like available layout engines staves etc.

 class Environment

Properties

fontDirectory

(no description)

static readonly fontDirectory: string | null;

isRunningInAudioWorklet

(no description)

static readonly isRunningInAudioWorklet: boolean;

isRunningInWorker

(no description)

static readonly isRunningInWorker: boolean;

isTurbopackBundled

Whether alphaTab runs inside a bundle created by Turbopack (e.g. Next.js).

static readonly isTurbopackBundled: boolean;

isViteBundled

(no description)

static readonly isViteBundled: boolean;

isWebPackBundled

(no description)

static readonly isWebPackBundled: boolean;

renderEngines

(no description)

JavaScript

static readonly renderEngines: Map<string, RenderEngineFactory>;

C#

static Map<string, RenderEngineFactory> RenderEngines { get; }

Kotlin

companion object { val renderEngines: alphaTab.collections.StringObjectMap<String, RenderEngineFactory> }

scriptFile

(no description)

static readonly scriptFile: string | null;

webPlatform

(no description)

static readonly webPlatform: WebPlatform;

Methods

buildImporters

Gets all default ScoreImporters

JavaScript

static buildImporters(): ScoreImporter[]

C#

static IList<ScoreImporter> BuildImporters()

Kotlin

fun buildImporters(): alphaTab.collections.List<ScoreImporter>

enableAlphaSkia

Enables the usage of alphaSkia as rendering backend.

JavaScript

static enableAlphaSkia(musicFontData: ArrayBuffer, alphaSkia: unknown): void

C#

static void EnableAlphaSkia(ArrayBuffer musicFontData, object alphaSkia)

Kotlin

fun enableAlphaSkia(musicFontData: ArrayBuffer, alphaSkia: Any): Unit

Parameter	Summary
musicFontDataAll	The raw binary data of the music font.
alphaSkiaAll	The alphaSkia module.

getRenderEngineFactory

(no description)

JavaScript

static getRenderEngineFactory(engine: string): RenderEngineFactory

C#

static RenderEngineFactory GetRenderEngineFactory(string engine)

Kotlin

fun getRenderEngineFactory(engine: String): RenderEngineFactory

Parameter	Summary
engineAll	(no description)

initializeAudioWorklet

(no description)

static initializeAudioWorklet(): void

initializeMain

(no description)

static initializeMain(createWebWorker: (settings: Settings, nameHint: string) => Worker, createAudioWorklet: (context: AudioContext, settings: Settings) => Promise<void>): void

Parameter	Summary
createWebWorkerAll	(no description)
createAudioWorkletAll	(no description)

initializeWorker

(no description)

static initializeWorker(): void

printEnvironmentInfo

Prints the environment information for easier troubleshooting.

JavaScript

static printEnvironmentInfo(force?: boolean): void

C#

static void PrintEnvironmentInfo(bool? force)

Kotlin

fun printEnvironmentInfo(force: Boolean?): Unit

Parameter	Summary
forceAll	Whether to force printing.

registerAlphaSkiaCustomFont

Registers a new custom font for the usage in the alphaSkia rendering backend.

JavaScript

static registerAlphaSkiaCustomFont(fontData: Uint8Array): Font

C#

static Font RegisterAlphaSkiaCustomFont(Uint8Array fontData)

Kotlin

fun registerAlphaSkiaCustomFont(fontData: Uint8Array): Font

Parameter	Summary
fontDataAll	The raw binary data of the font.

Returns

The font info under which the font was registered.