alphaTab.model.Beat

A beat is a single block within a bar. A beat is a combination of several notes played at the same time.

 class Beat

Properties

absoluteDisplayStart

(no description)

JavaScript

readonly absoluteDisplayStart: number;

C#

double AbsoluteDisplayStart { get; }

Kotlin

val absoluteDisplayStart: Double

absolutePlaybackStart

(no description)

JavaScript

readonly absolutePlaybackStart: number;

C#

double AbsolutePlaybackStart { get; }

Kotlin

val absolutePlaybackStart: Double

automations

Gets or sets a list of all automations on this beat.

JavaScript

automations: Automation[];

C#

IList<Automation> Automations { get; set; }

Kotlin

var automations: alphaTab.collections.List<Automation>

barreFret

The fret of a barré being played on this beat.

JavaScript

barreFret: number;

C#

double BarreFret { get; set; }

Kotlin

var barreFret: Double

barreShape

The shape how the barre should be played on this beat.

JavaScript

barreShape: BarreShape;

C#

BarreShape BarreShape { get; set; }

Kotlin

var barreShape: BarreShape

beamingMode

Gets or sets how the beaming should be done for this beat.

JavaScript

beamingMode: BeatBeamingMode;

C#

BeatBeamingMode BeamingMode { get; set; }

Kotlin

var beamingMode: BeatBeamingMode

brushDuration

Gets or sets the duration of the brush between the notes in midi ticks.

JavaScript

brushDuration: number;

C#

double BrushDuration { get; set; }

Kotlin

var brushDuration: Double

brushType

Gets or sets the brush type applied to the notes of this beat.

JavaScript

brushType: BrushType;

C#

BrushType BrushType { get; set; }

Kotlin

var brushType: BrushType

chord

(no description)

JavaScript

readonly chord: Chord | null;

C#

Chord? Chord { get; }

Kotlin

val chord: Chord?

chordId

Gets or sets the ID of the chord used on this beat.

JavaScript

chordId: string | null;

C#

string? ChordId { get; set; }

Kotlin

var chordId: String?

crescendo

Gets or sets whether a crescendo/decrescendo is applied on this beat.

JavaScript

crescendo: CrescendoType;

C#

CrescendoType Crescendo { get; set; }

Kotlin

var crescendo: CrescendoType

deadSlapped

Whether this beat should rendered and played as "dead slapped".

JavaScript

deadSlapped: boolean;

C#

bool DeadSlapped { get; set; }

Kotlin

var deadSlapped: Boolean

displayDuration

Gets or sets the duration that is used for the display of this beat. It defines the size/width of the beat in the music sheet. (unit: midi ticks).

JavaScript

displayDuration: number;

C#

double DisplayDuration { get; set; }

Kotlin

var displayDuration: Double

displayEnd

The calculated visual end position of this beat in midi ticks.

JavaScript

readonly displayEnd: number;

C#

double DisplayEnd { get; }

Kotlin

val displayEnd: Double

displayStart

The timeline position of the voice within the current bar as it is displayed. (unit: midi ticks) This might differ from the actual playback time due to special grace types.

JavaScript

displayStart: number;

C#

double DisplayStart { get; set; }

Kotlin

var displayStart: Double

dots

Gets or sets the number of dots applied to the duration of this beat.

JavaScript

dots: number;

C#

double Dots { get; set; }

Kotlin

var dots: Double

duration

Gets or sets the duration of this beat.

JavaScript

duration: Duration;

C#

Duration Duration { get; set; }

Kotlin

var duration: Duration

dynamics

Gets or sets the dynamics applied to this beat.

JavaScript

dynamics: DynamicValue;

C#

DynamicValue Dynamics { get; set; }

Kotlin

var dynamics: DynamicValue

effectSlurDestination

(no description)

JavaScript

effectSlurDestination: Beat | null;

C#

Beat? EffectSlurDestination { get; set; }

Kotlin

var effectSlurDestination: Beat?

effectSlurOrigin

(no description)

JavaScript

effectSlurOrigin: Beat | null;

C#

Beat? EffectSlurOrigin { get; set; }

Kotlin

var effectSlurOrigin: Beat?

fade

Gets or sets a value indicating whether this beat is fade-in.

JavaScript

fade: FadeType;

C#

FadeType Fade { get; set; }

Kotlin

var fade: FadeType

fadeIn

Deprecated

Use fade

Gets a value indicating whether this beat is fade-in.

JavaScript

fadeIn: boolean;

C#

bool FadeIn { get; set; }

Kotlin

var fadeIn: Boolean

fermata

Gets or sets the fermata applied to this beat.

JavaScript

fermata: Fermata | null;

C#

Fermata? Fermata { get; set; }

Kotlin

var fermata: Fermata?

golpe

The type of golpe to play.

JavaScript

golpe: GolpeType;

C#

GolpeType Golpe { get; set; }

Kotlin

var golpe: GolpeType

graceGroup

Gets or sets the grace group this beat belongs to. If this beat is not a grace note, it holds the group which belongs to this beat.

JavaScript

graceGroup: GraceGroup | null;

C#

GraceGroup? GraceGroup { get; set; }

Kotlin

var graceGroup: GraceGroup?

graceIndex

Gets or sets the index of this beat within the grace group if this is a grace beat.

JavaScript

graceIndex: number;

C#

double GraceIndex { get; set; }

Kotlin

var graceIndex: Double

graceType

Gets or sets the grace style of this beat.

JavaScript

graceType: GraceType;

C#

GraceType GraceType { get; set; }

Kotlin

var graceType: GraceType

hasChord

(no description)

JavaScript

readonly hasChord: boolean;

C#

bool HasChord { get; }

Kotlin

val hasChord: Boolean

hasRasgueado

Gets or sets a value indicating whether the beat is played in rasgueado style.

JavaScript

readonly hasRasgueado: boolean;

C#

bool HasRasgueado { get; }

Kotlin

val hasRasgueado: Boolean

hasTuplet

(no description)

JavaScript

readonly hasTuplet: boolean;

C#

bool HasTuplet { get; }

Kotlin

val hasTuplet: Boolean

hasWhammyBar

(no description)

JavaScript

readonly hasWhammyBar: boolean;

C#

bool HasWhammyBar { get; }

Kotlin

val hasWhammyBar: Boolean

id

Gets or sets the unique id of this beat.

JavaScript

id: number;

C#

double Id { get; set; }

Kotlin

var id: Double

index

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

JavaScript

index: number;

C#

double Index { get; set; }

Kotlin

var index: Double

invertBeamDirection

Gets or sets a value indicating whether the beam direction should be inverted.

JavaScript

invertBeamDirection: boolean;

C#

bool InvertBeamDirection { get; set; }

Kotlin

var invertBeamDirection: Boolean

isBarre

Gets a value indicating whether the beat should be played as Barré

JavaScript

readonly isBarre: boolean;

C#

bool IsBarre { get; }

Kotlin

val isBarre: Boolean

isContinuedWhammy

Gets or sets whether this beat continues a whammy effect.

JavaScript

isContinuedWhammy: boolean;

C#

bool IsContinuedWhammy { get; set; }

Kotlin

var isContinuedWhammy: Boolean

isEffectSlurDestination

(no description)

JavaScript

readonly isEffectSlurDestination: boolean;

C#

bool IsEffectSlurDestination { get; }

Kotlin

val isEffectSlurDestination: Boolean

isEffectSlurOrigin

(no description)

JavaScript

isEffectSlurOrigin: boolean;

C#

bool IsEffectSlurOrigin { get; set; }

Kotlin

var isEffectSlurOrigin: Boolean

isEmpty

Gets or sets a value indicating whether this beat is considered empty.

JavaScript

isEmpty: boolean;

C#

bool IsEmpty { get; set; }

Kotlin

var isEmpty: Boolean

isFullBarRest

Gets a value indicating whether this beat is a full bar rest.

JavaScript

readonly isFullBarRest: boolean;

C#

bool IsFullBarRest { get; }

Kotlin

val isFullBarRest: Boolean

isLastOfVoice

(no description)

JavaScript

readonly isLastOfVoice: boolean;

C#

bool IsLastOfVoice { get; }

Kotlin

val isLastOfVoice: Boolean

isLegatoDestination

(no description)

JavaScript

readonly isLegatoDestination: boolean;

C#

bool IsLegatoDestination { get; }

Kotlin

val isLegatoDestination: Boolean

isLegatoOrigin

Gets a value indicating whether this beat starts a legato slur.

JavaScript

isLegatoOrigin: boolean;

C#

bool IsLegatoOrigin { get; set; }

Kotlin

var isLegatoOrigin: Boolean

isLetRing

Gets or sets whether any note in this beat has a let-ring applied.

JavaScript

isLetRing: boolean;

C#

bool IsLetRing { get; set; }

Kotlin

var isLetRing: Boolean

isPalmMute

Gets or sets whether any note in this beat has a palm-mute applied.

JavaScript

isPalmMute: boolean;

C#

bool IsPalmMute { get; set; }

Kotlin

var isPalmMute: Boolean

isRest

(no description)

JavaScript

readonly isRest: boolean;

C#

bool IsRest { get; }

Kotlin

val isRest: Boolean

isTremolo

Whether this beat has a tremolo picking effect.

JavaScript

readonly isTremolo: boolean;

C#

bool IsTremolo { get; }

Kotlin

val isTremolo: Boolean

lyrics

Gets or sets the lyrics shown on this beat.

JavaScript

lyrics: string[] | null;

C#

IList<string>? Lyrics { get; set; }

Kotlin

var lyrics: ?

maxNote

Gets or sets the note with the highest pitch in this beat. Only visible notes are considered.

JavaScript

maxNote: Note | null;

C#

Note? MaxNote { get; set; }

Kotlin

var maxNote: Note?

maxStringNote

Gets or sets the note with the highest string number in this beat. Only visible notes are considered.

JavaScript

maxStringNote: Note | null;

C#

Note? MaxStringNote { get; set; }

Kotlin

var maxStringNote: Note?

maxWhammyPoint

Gets or sets the highest point with for the highest whammy bar value.

JavaScript

maxWhammyPoint: BendPoint | null;

C#

BendPoint? MaxWhammyPoint { get; set; }

Kotlin

var maxWhammyPoint: BendPoint?

minNote

Gets or sets the note with the lowest pitch in this beat. Only visible notes are considered.

JavaScript

minNote: Note | null;

C#

Note? MinNote { get; set; }

Kotlin

var minNote: Note?

minStringNote

Gets or sets the note with the lowest string number in this beat. Only visible notes are considered.

JavaScript

minStringNote: Note | null;

C#

Note? MinStringNote { get; set; }

Kotlin

var minStringNote: Note?

minWhammyPoint

Gets or sets the highest point with for the lowest whammy bar value.

JavaScript

minWhammyPoint: BendPoint | null;

C#

BendPoint? MinWhammyPoint { get; set; }

Kotlin

var minWhammyPoint: BendPoint?

nextBeat

Gets or sets the next beat within the whole song.

JavaScript

nextBeat: Beat | null;

C#

Beat? NextBeat { get; set; }

Kotlin

var nextBeat: Beat?

notes

Gets or sets the list of notes contained in this beat.

JavaScript

notes: Note[];

C#

IList<Note> Notes { get; set; }

Kotlin

var notes: alphaTab.collections.List<Note>

noteStringLookup

Gets the lookup where the notes per string are registered. If this staff contains string based notes this lookup allows fast access.

JavaScript

readonly noteStringLookup: Map<number, Note>;

C#

Map<double, Note> NoteStringLookup { get; }

Kotlin

val noteStringLookup: alphaTab.collections.DoubleObjectMap<Double, Note>

noteValueLookup

Gets the lookup where the notes per value are registered. If this staff contains string based notes this lookup allows fast access.

JavaScript

readonly noteValueLookup: Map<number, Note>;

C#

Map<double, Note> NoteValueLookup { get; }

Kotlin

val noteValueLookup: alphaTab.collections.DoubleObjectMap<Double, Note>

ottava

Gets or sets the ottava applied to this beat.

JavaScript

ottava: Ottavia;

C#

Ottavia Ottava { get; set; }

Kotlin

var ottava: Ottavia

overrideDisplayDuration

The duration in midi ticks to use for this beat on the displayDuration controlling the visual display of the beat. This is used in scenarios where the bar might not have 100% exactly a linear structure between the beats. e.g. in MusicXML when using <forward />.

JavaScript

overrideDisplayDuration?: number;

C#

double OverrideDisplayDuration { get; set; }

Kotlin

var overrideDisplayDuration: Double

pickStroke

Gets or sets the pickstroke applied on this beat.

JavaScript

pickStroke: PickStroke;

C#

PickStroke PickStroke { get; set; }

Kotlin

var pickStroke: PickStroke

playbackDuration

Gets or sets the duration that the note is played during the audio generation.

JavaScript

playbackDuration: number;

C#

double PlaybackDuration { get; set; }

Kotlin

var playbackDuration: Double

playbackStart

The timeline position of the voice within the current bar as it is played. (unit: midi ticks) This might differ from the actual playback time due to special grace types.

JavaScript

playbackStart: number;

C#

double PlaybackStart { get; set; }

Kotlin

var playbackStart: Double

pop

Gets or sets a value indicating whether the notes on this beat are played with a pop-style (bass).

JavaScript

pop: boolean;

C#

bool Pop { get; set; }

Kotlin

var pop: Boolean

preferredBeamDirection

Gets or sets the preferred beam direction as specified in the input source.

JavaScript

preferredBeamDirection: BeamDirection | null;

C#

BeamDirection? PreferredBeamDirection { get; set; }

Kotlin

var preferredBeamDirection: BeamDirection?

previousBeat

Gets or sets the previous beat within the whole song.

JavaScript

previousBeat: Beat | null;

C#

Beat? PreviousBeat { get; set; }

Kotlin

var previousBeat: Beat?

rasgueado

The Rasgueado pattern to play with this beat.

JavaScript

rasgueado: Rasgueado;

C#

Rasgueado Rasgueado { get; set; }

Kotlin

var rasgueado: Rasgueado

restDisplayOctave

Gets or sets the octave at which this rest should be displayed. Only relevant when restDisplayTone is set. NaN means use the default position formula.

JavaScript

restDisplayOctave: number;

C#

double RestDisplayOctave { get; set; }

Kotlin

var restDisplayOctave: Double

restDisplayTone

Gets or sets the chromatic tone value (0–11) of the pitch at which this rest should be displayed. A value of NaN means use the default position formula.

JavaScript

restDisplayTone: number;

C#

double RestDisplayTone { get; set; }

Kotlin

var restDisplayTone: Double

showDynamics

Whether a dynamics marking with the dynamics of this beat is shown. If not set, a marking is shown where the dynamics change. Formats encoding the written markings (e.g. MusicXML) set it, as the dynamics in effect can differ from the shown markings: e.g. a single marking on a piano applies to both staves.

JavaScript

showDynamics?: boolean;

C#

bool ShowDynamics { get; set; }

Kotlin

var showDynamics: Boolean

showTimer

Whether to show the time when this beat is played the first time. (requires that the midi for the song is generated so that times are calculated). If no midi is generated the timer value might be filled from the input file (or manually).

JavaScript

showTimer: boolean;

C#

bool ShowTimer { get; set; }

Kotlin

var showTimer: Boolean

slap

Gets or sets a value indicating whether the notes on this beat are played with a slap-style (bass).

JavaScript

slap: boolean;

C#

bool Slap { get; set; }

Kotlin

var slap: Boolean

slashed

Gets or sets whether this beat should be rendered as slashed note.

JavaScript

slashed: boolean;

C#

bool Slashed { get; set; }

Kotlin

var slashed: Boolean

style

The style customizations for this item.

JavaScript

style?: BeatStyle;

C#

BeatStyle Style { get; set; }

Kotlin

var style: BeatStyle

tap

Gets or sets a value indicating whether the notes on this beat are played with a tap-style (bass).

JavaScript

tap: boolean;

C#

bool Tap { get; set; }

Kotlin

var tap: Boolean

text

Gets or sets the text annotation shown on this beat.

JavaScript

text: string | null;

C#

string? Text { get; set; }

Kotlin

var text: String?

timer

The absolute time in milliseconds when this beat will be played the first time.

JavaScript

timer: number | null;

C#

double? Timer { get; set; }

Kotlin

var timer: Double?

tremoloPicking

The tremolo picking effect.

JavaScript

tremoloPicking?: TremoloPickingEffect;

C#

TremoloPickingEffect TremoloPicking { get; set; }

Kotlin

var tremoloPicking: TremoloPickingEffect

tremoloSpeed

Deprecated

Set tremoloPicking instead.

The speed of the tremolo.

JavaScript

tremoloSpeed: Duration | null;

C#

Duration? TremoloSpeed { get; set; }

Kotlin

var tremoloSpeed: Duration?

tupletDenominator

Gets or sets the tuplet denominator.

JavaScript

tupletDenominator: number;

C#

double TupletDenominator { get; set; }

Kotlin

var tupletDenominator: Double

tupletGroup

(no description)

JavaScript

tupletGroup: TupletGroup | null;

C#

TupletGroup? TupletGroup { get; set; }

Kotlin

var tupletGroup: TupletGroup?

tupletNumerator

Gets or sets the tuplet numerator.

JavaScript

tupletNumerator: number;

C#

double TupletNumerator { get; set; }

Kotlin

var tupletNumerator: Double

vibrato

Gets or sets the vibrato effect used on this beat.

JavaScript

vibrato: VibratoType;

C#

VibratoType Vibrato { get; set; }

Kotlin

var vibrato: VibratoType

voice

Gets or sets the reference to the parent voice this beat belongs to.

JavaScript

voice: Voice;

C#

Voice Voice { get; set; }

Kotlin

var voice: Voice

wahPedal

Whether the wah pedal should be used when playing the beat.

JavaScript

wahPedal: WahPedal;

C#

WahPedal WahPedal { get; set; }

Kotlin

var wahPedal: WahPedal

whammyBarPoints

Gets or sets the points defining the whammy bar usage.

JavaScript

whammyBarPoints: BendPoint[] | null;

C#

IList<BendPoint>? WhammyBarPoints { get; set; }

Kotlin

var whammyBarPoints: alphaTab.collections.List<BendPoint>?

whammyBarType

Gets or sets the whammy bar style of this beat.

JavaScript

whammyBarType: WhammyType;

C#

WhammyType WhammyBarType { get; set; }

Kotlin

var whammyBarType: WhammyType

whammyStyle

Gets or sets which whammy bar style should be used for this bar.

JavaScript

whammyStyle: BendStyle;

C#

BendStyle WhammyStyle { get; set; }

Kotlin

var whammyStyle: BendStyle

Methods

addNote

(no description)

JavaScript

addNote(note: Note): void

C#

void AddNote(Note note)

Kotlin

fun addNote(note: Note): Unit

Parameter	Summary
noteAll	(no description)

addWhammyBarPoint

(no description)

JavaScript

addWhammyBarPoint(point: BendPoint): void

C#

void AddWhammyBarPoint(BendPoint point)

Kotlin

fun addWhammyBarPoint(point: BendPoint): Unit

Parameter	Summary
pointAll	(no description)

chain

(no description)

JavaScript

chain(sharedDataBag?: Map<string, unknown> | null): void

C#

void Chain(Map<string, object>? sharedDataBag)

Kotlin

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

Parameter	Summary
sharedDataBagAll	(no description)

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)

finishTuplet

(no description)

JavaScript

finishTuplet(): void

C#

void FinishTuplet()

Kotlin

fun finishTuplet(): Unit

getAutomation

(no description)

JavaScript

getAutomation(type: AutomationType): Automation | null

C#

Automation? GetAutomation(AutomationType type)

Kotlin

fun getAutomation(type: AutomationType): Automation?

Parameter	Summary
typeAll	(no description)

getNoteOnString

(no description)

JavaScript

getNoteOnString(noteString: number): Note | null

C#

Note? GetNoteOnString(double noteString)

Kotlin

fun getNoteOnString(noteString: Double): Note?

Parameter	Summary
noteStringAll	(no description)

getNoteWithRealValue

(no description)

JavaScript

getNoteWithRealValue(noteRealValue: number): Note | null

C#

Note? GetNoteWithRealValue(double noteRealValue)

Kotlin

fun getNoteWithRealValue(noteRealValue: Double): Note?

Parameter	Summary
noteRealValueAll	(no description)

hasNoteOnString

(no description)

JavaScript

hasNoteOnString(noteString: number): boolean

C#

bool HasNoteOnString(double noteString)

Kotlin

fun hasNoteOnString(noteString: Double): Boolean

Parameter	Summary
noteStringAll	(no description)

isAfter

Checks whether the current beat is timewise after the given beat.

JavaScript

isAfter(beat: Beat): boolean

C#

bool IsAfter(Beat beat)

Kotlin

fun isAfter(beat: Beat): Boolean

Parameter	Summary
beatAll	(no description)

isBefore

Checks whether the current beat is timewise before the given beat.

JavaScript

isBefore(beat: Beat): boolean

C#

bool IsBefore(Beat beat)

Kotlin

fun isBefore(beat: Beat): Boolean

Parameter	Summary
beatAll	(no description)

removeNote

(no description)

JavaScript

removeNote(note: Note): void

C#

void RemoveNote(Note note)

Kotlin

fun removeNote(note: Note): Unit

Parameter	Summary
noteAll	(no description)

removeWhammyBarPoint

(no description)

JavaScript

removeWhammyBarPoint(index: number): void

C#

void RemoveWhammyBarPoint(double index)

Kotlin

fun removeWhammyBarPoint(index: Double): Unit

Parameter	Summary
indexAll	(no description)

updateDurations

(no description)

JavaScript

updateDurations(): void

C#

void UpdateDurations()

Kotlin

fun updateDurations(): Unit