alphaTab.model.MasterBar

The MasterBar stores information about a bar which affects all tracks.

 class MasterBar

Properties

alternateEndings

Gets or sets the bitflag for the alternate endings. Each bit defines for which repeat counts the bar is played.

JavaScript

alternateEndings: number;

C#

double AlternateEndings { get; set; }

Kotlin

var alternateEndings: Double

barNumber

The actual bar number of this masterbar respecting any Pick-Up bars and manually overriden bar numbers. Returns NaN for pick-up bars (see isAnacrusis ) Only available after data model finish. The final bar number is not guaranteed to be unique. using {@see customBarNumber} users might reset or change counting in any custom fashion. Do not rely on the bar number for lookup or indexing.

JavaScript

readonly barNumber: number;

C#

double BarNumber { get; }

Kotlin

val barNumber: Double

barNumberText

Returns the actual text displayed for this master bar respecting any custom overrides and out-of-order numbers. Only available after data model finish.

JavaScript

readonly barNumberText: string;

C#

string BarNumberText { get; }

Kotlin

val barNumberText: String

beamingRules

Defines the custom beaming rules which should be applied to this bar and all bars following.

JavaScript

beamingRules?: BeamingRules;

C#

BeamingRules BeamingRules { get; set; }

Kotlin

var beamingRules: BeamingRules

customBarNumber

A custom bar number affecting this and subsequent bar numbers. e.g. allows setting the initial bar number to 10 and the second will be 11. Any change to customBarNumber requires an additional call to finish to consolidate the counting.

JavaScript

customBarNumber?: number;

C#

double CustomBarNumber { get; set; }

Kotlin

var customBarNumber: Double

customBarNumberText

A custom string to display for the bar number as override. Even with a custom string, this masterbar contributes to the incremental bar numbers across the score. Set the customBarNumber for the next master bar if you want alternative counting.

JavaScript

customBarNumberText?: string;

C#

string CustomBarNumberText { get; set; }

Kotlin

var customBarNumberText: String

directions

The directions applied to this masterbar.

JavaScript

directions: Set<Direction> | null;

C#

Set<Direction>? Directions { get; set; }

Kotlin

var directions: Set<Direction>?

displayScale

Gets a percentual scale for the size of the bars when displayed in a multi-track layout.

JavaScript

displayScale: number;

C#

double DisplayScale { get; set; }

Kotlin

var displayScale: Double

displayWidth

An absolute width of the bar to use when displaying in a multi-track layout.

JavaScript

displayWidth: number;

C#

double DisplayWidth { get; set; }

Kotlin

var displayWidth: Double

fermata

Gets or sets the fermatas for this bar. The key is the offset of the fermata in midi ticks.

JavaScript

fermata: Map<number, Fermata> | null;

C#

Map<double, Fermata>? Fermata { get; set; }

Kotlin

var fermata: alphaTab.collections.DoubleObjectMap<Double, Fermata>?

hasChanges

Whether the masterbar is has any changes applied to it (e.g. tempo changes, time signature changes etc) The first bar is always considered changed due to initial setup of values. It does not consider elements like whether the tempo really changes to the previous bar.

JavaScript

readonly hasChanges: boolean;

C#

bool HasChanges { get; }

Kotlin

val hasChanges: Boolean

index

Gets the zero based index of the masterbar.

JavaScript

index: number;

C#

double Index { get; set; }

Kotlin

var index: Double

isAnacrusis

Gets or sets a value indicating whether the master bar is an anacrusis (aka. pickup bar)

JavaScript

isAnacrusis: boolean;

C#

bool IsAnacrusis { get; set; }

Kotlin

var isAnacrusis: Boolean

isDoubleBar

Deprecated

Use barLineLeft and barLineRight

Gets or sets whether a double bar is shown for this masterbar.

JavaScript

isDoubleBar: boolean;

C#

bool IsDoubleBar { get; set; }

Kotlin

var isDoubleBar: Boolean

isFreeTime

Gets or sets whether the bar indicates a free time playing.

JavaScript

isFreeTime: boolean;

C#

bool IsFreeTime { get; set; }

Kotlin

var isFreeTime: Boolean

isRepeatEnd

(no description)

JavaScript

readonly isRepeatEnd: boolean;

C#

bool IsRepeatEnd { get; }

Kotlin

val isRepeatEnd: Boolean

isRepeatStart

Gets or sets whether a repeat section starts on this masterbar.

JavaScript

isRepeatStart: boolean;

C#

bool IsRepeatStart { get; set; }

Kotlin

var isRepeatStart: Boolean

isSectionStart

(no description)

JavaScript

readonly isSectionStart: boolean;

C#

bool IsSectionStart { get; }

Kotlin

val isSectionStart: Boolean

keySignature

Deprecated

Use key signatures on bar level

The key signature used on all bars.

JavaScript

keySignature: KeySignature;

C#

KeySignature KeySignature { get; set; }

Kotlin

var keySignature: KeySignature

keySignatureType

Deprecated

Use key signatures on bar level

The type of key signature (major/minor)

JavaScript

keySignatureType: KeySignatureType;

C#

KeySignatureType KeySignatureType { get; set; }

Kotlin

var keySignatureType: KeySignatureType

MaxAlternateEndings

(no description)

JavaScript

static readonly MaxAlternateEndings: number;

C#

static double MaxAlternateEndings { get; }

Kotlin

companion object { val MaxAlternateEndings: Double }

nextMasterBar

Gets or sets the next masterbar in the song.

JavaScript

nextMasterBar: MasterBar | null;

C#

MasterBar? NextMasterBar { get; set; }

Kotlin

var nextMasterBar: MasterBar?

previousMasterBar

Gets or sets the next masterbar in the song.

JavaScript

previousMasterBar: MasterBar | null;

C#

MasterBar? PreviousMasterBar { get; set; }

Kotlin

var previousMasterBar: MasterBar?

repeatCount

Gets or sets the number of repeats for the current repeat section.

JavaScript

repeatCount: number;

C#

double RepeatCount { get; set; }

Kotlin

var repeatCount: Double

repeatGroup

Gets or sets the repeat group this bar belongs to.

JavaScript

repeatGroup: RepeatGroup;

C#

RepeatGroup RepeatGroup { get; set; }

Kotlin

var repeatGroup: RepeatGroup

score

Gets or sets the reference to the score this song belongs to.

JavaScript

score: Score;

C#

Score Score { get; set; }

Kotlin

var score: Score

section

Gets or sets the new section information for this bar.

JavaScript

section: Section | null;

C#

Section? Section { get; set; }

Kotlin

var section: Section?

start

The timeline position of the voice within the whole score. (unit: midi ticks)

JavaScript

start: number;

C#

double Start { get; set; }

Kotlin

var start: Double

syncPoints

The sync points for this master bar to synchronize the alphaTab time axis with the external backing track audio.

JavaScript

syncPoints: Automation[] | undefined;

C#

IList<Automation>? SyncPoints { get; set; }

Kotlin

var syncPoints: alphaTab.collections.List<Automation>?

tempoAutomation

Deprecated

Use tempoAutomations .

Gets or sets the first tempo automation for this bar.

JavaScript

readonly tempoAutomation: Automation | null;

C#

Automation? TempoAutomation { get; }

Kotlin

val tempoAutomation: Automation?

tempoAutomations

Gets or sets all tempo automation for this bar.

JavaScript

tempoAutomations: Automation[];

C#

IList<Automation> TempoAutomations { get; set; }

Kotlin

var tempoAutomations: alphaTab.collections.List<Automation>

timeSignatureCommon

Gets or sets whether this is bar has a common time signature.

JavaScript

timeSignatureCommon: boolean;

C#

bool TimeSignatureCommon { get; set; }

Kotlin

var timeSignatureCommon: Boolean

timeSignatureDenominator

Gets or sets the time signature denominiator.

JavaScript

timeSignatureDenominator: number;

C#

double TimeSignatureDenominator { get; set; }

Kotlin

var timeSignatureDenominator: Double

timeSignatureNumerator

Gets or sets the time signature numerator.

JavaScript

timeSignatureNumerator: number;

C#

double TimeSignatureNumerator { get; set; }

Kotlin

var timeSignatureNumerator: Double

tripletFeel

Gets or sets the triplet feel that is valid for this bar.

JavaScript

tripletFeel: TripletFeel;

C#

TripletFeel TripletFeel { get; set; }

Kotlin

var tripletFeel: TripletFeel

Methods

addDirection

Adds a direction to the masterbar.

JavaScript

addDirection(direction: Direction): void

C#

void AddDirection(Direction direction)

Kotlin

fun addDirection(direction: Direction): Unit

Parameter	Summary
directionAll	The direction to add.

addFermata

Adds a fermata to the masterbar.

JavaScript

addFermata(offset: number, fermata: Fermata): void

C#

void AddFermata(double offset, Fermata fermata)

Kotlin

fun addFermata(offset: Double, fermata: Fermata): Unit

Parameter	Summary
offsetAll	The offset of the fermata within the bar in midi ticks.
fermataAll	The fermata.

addSyncPoint

Adds the given sync point to the list of sync points for this bar.

JavaScript

addSyncPoint(syncPoint: Automation): void

C#

void AddSyncPoint(Automation syncPoint)

Kotlin

fun addSyncPoint(syncPoint: Automation): Unit

Parameter	Summary
syncPointAll	The sync point to add.

calculateDuration

Calculates the time spent in this bar. (unit: midi ticks)

JavaScript

calculateDuration(respectAnacrusis?: boolean): number

C#

double CalculateDuration(bool? respectAnacrusis)

Kotlin

fun calculateDuration(respectAnacrusis: Boolean?): Double

Parameter	Summary
respectAnacrusisAll	(no description)

finish

(no description)

JavaScript

finish(sharedDataBag: Map<string, unknown>): void

C#

void Finish(Map<string, object> sharedDataBag)

Kotlin

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

Parameter	Summary
sharedDataBagAll	(no description)

getFermata

Gets the fermata for a given beat.

JavaScript

getFermata(beat: Beat): Fermata | null

C#

Fermata? GetFermata(Beat beat)

Kotlin

fun getFermata(beat: Beat): Fermata?

Parameter	Summary
beatAll	The beat to get the fermata for.