alphaTab.model.Score

The score is the root node of the complete model. It stores the basic information of a song and stores the sub components.

 class Score

Properties

album

The album of this song.

JavaScript

album: string;

C#

string Album { get; set; }

Kotlin

var album: String

artist

The artist who performs this song.

JavaScript

artist: string;

C#

string Artist { get; set; }

Kotlin

var artist: String

backingTrack

Information about the backing track that can be used instead of the synthesized audio.

JavaScript

backingTrack: BackingTrack | undefined;

C#

BackingTrack? BackingTrack { get; set; }

Kotlin

var backingTrack: BackingTrack?

copyright

The owner of the copyright of this song.

JavaScript

copyright: string;

C#

string Copyright { get; set; }

Kotlin

var copyright: String

defaultSystemsLayout

Defines how many bars are placed into the systems (rows) when displaying multiple tracks unless a value is set in the systemsLayout.

JavaScript

defaultSystemsLayout: number;

C#

double DefaultSystemsLayout { get; set; }

Kotlin

var defaultSystemsLayout: Double

instructions

Additional instructions

JavaScript

instructions: string;

C#

string Instructions { get; set; }

Kotlin

var instructions: String

masterBars

Gets or sets a list of all masterbars contained in this song.

JavaScript

masterBars: MasterBar[];

C#

IList<MasterBar> MasterBars { get; set; }

Kotlin

var masterBars: alphaTab.collections.List<MasterBar>

music

The author of the music.

JavaScript

music: string;

C#

string Music { get; set; }

Kotlin

var music: String

notices

Some additional notes about the song.

JavaScript

notices: string;

C#

string Notices { get; set; }

Kotlin

var notices: String

style

The style customizations for this item.

JavaScript

style?: ScoreStyle;

C#

ScoreStyle Style { get; set; }

Kotlin

var style: ScoreStyle

stylesheet

Gets or sets the rendering stylesheet for this song.

JavaScript

stylesheet: RenderStylesheet;

C#

RenderStylesheet Stylesheet { get; set; }

Kotlin

var stylesheet: RenderStylesheet

subTitle

The subtitle of the song.

JavaScript

subTitle: string;

C#

string SubTitle { get; set; }

Kotlin

var subTitle: String

systemsLayout

Defines how many bars are placed into the systems (rows) when displaying multiple tracks.

JavaScript

systemsLayout: number[];

C#

IList<double> SystemsLayout { get; set; }

Kotlin

var systemsLayout: alphaTab.collections.DoubleList

tab

The author of this tablature.

JavaScript

tab: string;

C#

string Tab { get; set; }

Kotlin

var tab: String

tempo

The initial tempo of the song in BPM. The tempo might change via tempoAutomations .

JavaScript

readonly tempo: number;

C#

double Tempo { get; }

Kotlin

val tempo: Double

tempoLabel

The name/label of the initial tempo.

JavaScript

readonly tempoLabel: string;

C#

string TempoLabel { get; }

Kotlin

val tempoLabel: String

title

The title of the song.

JavaScript

title: string;

C#

string Title { get; set; }

Kotlin

var title: String

tracks

Gets or sets a list of all tracks contained in this song.

JavaScript

tracks: Track[];

C#

IList<Track> Tracks { get; set; }

Kotlin

var tracks: alphaTab.collections.List<Track>

words

The author of the song lyrics

JavaScript

words: string;

C#

string Words { get; set; }

Kotlin

var words: String

Methods

addMasterBar

(no description)

JavaScript

addMasterBar(bar: MasterBar): void

C#

void AddMasterBar(MasterBar bar)

Kotlin

fun addMasterBar(bar: MasterBar): Unit

Parameter	Summary
barAll	(no description)

addTrack

(no description)

JavaScript

addTrack(track: Track): void

C#

void AddTrack(Track track)

Kotlin

fun addTrack(track: Track): Unit

Parameter	Summary
trackAll	(no description)

applyFlatSyncPoints

Applies the given list of FlatSyncPoint to this song.

JavaScript

applyFlatSyncPoints(syncPoints: FlatSyncPoint[]): void

C#

void ApplyFlatSyncPoints(IList<FlatSyncPoint> syncPoints)

Kotlin

fun applyFlatSyncPoints(syncPoints: alphaTab.collections.List<FlatSyncPoint>): Unit

Parameter	Summary
syncPointsAll	The list of sync points to apply.

exportFlatSyncPoints

Exports all sync points in this song to a FlatSyncPoint list.

JavaScript

exportFlatSyncPoints(): FlatSyncPoint[]

C#

IList<FlatSyncPoint> ExportFlatSyncPoints()

Kotlin

fun exportFlatSyncPoints(): alphaTab.collections.List<FlatSyncPoint>

finish

(no description)

JavaScript

finish(settings: Settings): void

C#

void Finish(Settings settings)

Kotlin

fun finish(settings: Settings): Unit

Parameter	Summary
settingsAll	(no description)

rebuildRepeatGroups

(no description)

JavaScript

rebuildRepeatGroups(): void

C#

void RebuildRepeatGroups()

Kotlin

fun rebuildRepeatGroups(): Unit

resetIds

Resets all internal ID generators.

JavaScript

static resetIds(): void

C#

static void ResetIds()

Kotlin

fun resetIds(): Unit