load

since 0.9.4

Description

Initiates a load of the score using the given data.

JavaScript

load(scoreData: unknown, trackIndexes?: number[]): boolean

C#

bool Load(object scoreData, IList<double>? trackIndexes)

Kotlin

fun load(scoreData: Any, trackIndexes: alphaTab.collections.DoubleList?): Boolean

Parameter	Summary
scoreDataAll	The data container supported by IUiFacade. The supported types is depending on the platform: A alphaTab.model.Score instance (all platforms) A ArrayBuffer or Uint8Array containing one of the supported file formats (all platforms, native byte array or input streams on other platforms) A url from where to download the binary data of one of the supported file formats (browser only)
trackIndexesAll	The indexes of the tracks from the song that should be rendered. If not provided, the first track of the song will be shown.

Returns

true if the data object is supported and a load was initiated, otherwise false

Examples

JavaScript

const api = new alphaTab.AlphaTabApi(document.querySelector('#alphaTab'));
api.load('/assets/MyFile.gp');

C#

var api = new AlphaTabApi<MyControl>(...);
api.Load(System.IO.File.OpenRead("MyFile.gp"));

Android

val api = AlphaTabApi<MyControl>(...)
contentResolver.openInputStream(uri).use {
    api.load(it)
}