alphaTab.model.Voice

A voice represents a group of beats that can be played during a bar.

 class Voice

Properties

bar

Gets or sets the reference to the bar this voice belongs to.

JavaScript

bar: Bar;

C#

Bar Bar { get; set; }

Kotlin

var bar: Bar

beats

Gets or sets the list of beats contained in this voice.

JavaScript

beats: Beat[];

C#

IList<Beat> Beats { get; set; }

Kotlin

var beats: alphaTab.collections.List<Beat>

id

Gets or sets the unique id of this bar.

JavaScript

id: number;

C#

double Id { get; set; }

Kotlin

var id: Double

index

Gets or sets the zero-based index of this voice within the bar.

JavaScript

index: number;

C#

double Index { get; set; }

Kotlin

var index: Double

isEmpty

Gets or sets a value indicating whether this voice is empty.

JavaScript

readonly isEmpty: boolean;

C#

bool IsEmpty { get; }

Kotlin

val isEmpty: Boolean

isRestOnly

Gets or sets a value indicating whether this voice is empty.

JavaScript

readonly isRestOnly: boolean;

C#

bool IsRestOnly { get; }

Kotlin

val isRestOnly: Boolean

style

The style customizations for this item.

JavaScript

style?: VoiceStyle;

C#

VoiceStyle Style { get; set; }

Kotlin

var style: VoiceStyle

Methods

addBeat

(no description)

JavaScript

addBeat(beat: Beat): void

C#

void AddBeat(Beat beat)

Kotlin

fun addBeat(beat: Beat): Unit

Parameter	Summary
beatAll	(no description)

addGraceBeat

(no description)

JavaScript

addGraceBeat(beat: Beat): void

C#

void AddGraceBeat(Beat beat)

Kotlin

fun addGraceBeat(beat: Beat): Unit

Parameter	Summary
beatAll	(no description)

calculateDuration

(no description)

JavaScript

calculateDuration(): number

C#

double CalculateDuration()

Kotlin

fun calculateDuration(): Double

finish

(no description)

JavaScript

finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void

C#

void Finish(Settings settings, Map<string, object>? sharedDataBag)

Kotlin

fun finish(settings: Settings, sharedDataBag: alphaTab.collections.StringAnyMap<String, Any>?): Unit

Parameter	Summary
settingsAll	(no description)
sharedDataBagAll	(no description)

getBeatAtPlaybackStart

(no description)

JavaScript

getBeatAtPlaybackStart(playbackStart: number): Beat | null

C#

Beat? GetBeatAtPlaybackStart(double playbackStart)

Kotlin

fun getBeatAtPlaybackStart(playbackStart: Double): Beat?

Parameter	Summary
playbackStartAll	(no description)

insertBeat

(no description)

JavaScript

insertBeat(after: Beat, newBeat: Beat): void

C#

void InsertBeat(Beat after, Beat newBeat)

Kotlin

fun insertBeat(after: Beat, newBeat: Beat): Unit

Parameter	Summary
afterAll	(no description)
newBeatAll	(no description)