alphaTab.model.Beat

Description

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`
`absolutePlaybackStart`
`automations`	Gets or sets a list of all automations on this beat.
`barreFret`	The fret of a barré being played on this beat.
`barreShape`	The shape how the barre should be played on this beat.
`beamingMode`	Gets or sets how the beaming should be done for this beat.
`brushDuration`	Gets or sets the duration of the brush between the notes in midi ticks.
`brushType`	Gets or sets the brush type applied to the notes of this beat.
`chord`
`chordId`	Gets or sets the ID of the chord used on this beat.
`crescendo`	Gets or sets whether a crescendo/decrescendo is applied on this beat.
`deadSlapped`	Whether this beat should rendered and played as "dead slapped".
`displayDuration`	Gets or sets the duration that is used for the display of this beat. It defines the size/width of the beat in
`displayStart`	The timeline position of the voice within the current bar as it is displayed. (unit: midi ticks)
`dots`	Gets or sets the number of dots applied to the duration of this beat.
`duration`	Gets or sets the duration of this beat.
`dynamics`	Gets or sets the dynamics applied to this beat.
`effectSlurDestination`
`effectSlurOrigin`
`fade`	Gets or sets a value indicating whether this beat is fade-in.
`fadeIn`	Gets a value indicating whether this beat is fade-in.
`fermata`	Gets or sets the fermata applied to this beat.
`golpe`	The type of golpe to play.
`graceGroup`	Gets or sets the grace group this beat belongs to.
`graceIndex`	Gets or sets the index of this beat within the grace group if
`graceType`	Gets or sets the grace style of this beat.
`hasChord`
`hasRasgueado`	Gets or sets a value indicating whether the beat is played in rasgueado style.
`hasTuplet`
`hasWhammyBar`
`id`	Gets or sets the unique id of this beat.
`index`	Gets or sets the zero-based index of this beat within the voice.
`invertBeamDirection`	Gets or sets a value indicating whether the beam direction should be inverted.
`isBarre`	Gets a value indicating whether the beat should be played as Barré
`isContinuedWhammy`	Gets or sets whether this beat continues a whammy effect.
`isEffectSlurDestination`
`isEffectSlurOrigin`
`isEmpty`	Gets or sets a value indicating whether this beat is considered empty.
`isFullBarRest`	Gets a value indicating whether this beat is a full bar rest.
`isLastOfVoice`
`isLegatoDestination`
`isLegatoOrigin`	Gets a value indicating whether this beat starts a legato slur.
`isLetRing`	Gets or sets whether any note in this beat has a let-ring applied.
`isPalmMute`	Gets or sets whether any note in this beat has a palm-mute paplied.
`isRest`
`isTremolo`
`lyrics`	Gets or sets the lyrics shown on this beat.
`maxNote`	Gets or sets the note with the highest pitch in this beat. Only visible notes are considered.
`maxStringNote`	Gets or sets the note with the highest string number in this beat. Only visible notes are considered.
`maxWhammyPoint`	Gets or sets the highest point with for the highest whammy bar value.
`minNote`	Gets or sets the note with the lowest pitch in this beat. Only visible notes are considered.
`minStringNote`	Gets or sets the note with the lowest string number in this beat. Only visible notes are considered.
`minWhammyPoint`	Gets or sets the highest point with for the lowest whammy bar value.
`nextBeat`	Gets or sets the next beat within the whole song.
`notes`	Gets or sets the list of notes contained in this beat.
`noteStringLookup`	Gets the lookup where the notes per string are registered.
`noteValueLookup`	Gets the lookup where the notes per value are registered.
`ottava`	Gets or sets the ottava applied to this beat.
`pickStroke`	Gets or sets the pickstroke applied on this beat.
`playbackDuration`	Gets or sets the duration that the note is played during the audio generation.
`playbackStart`	The timeline position of the voice within the current bar as it is played. (unit: midi ticks)
`pop`	Gets or sets a value indicating whether the notes on this beat are played with a pop-style (bass).
`preferredBeamDirection`	Gets or sets the preferred beam direction as specified in the input source.
`previousBeat`	Gets or sets the previous beat within the whole song.
`rasgueado`	The Rasgueado pattern to play with this beat.
`showTimer`	Whether to show the time when this beat is played the first time.
`slap`	Gets or sets a value indicating whether the notes on this beat are played with a slap-style (bass).
`slashed`	Gets or sets whether this beat should be rendered as slashed note.
`style`	The style customizations for this item.
`tap`	Gets or sets a value indicating whether the notes on this beat are played with a tap-style (bass).
`text`	Gets or sets the text annotation shown on this beat.
`timer`	The absolute time in milliseconds when this beat will be played the first time.
`tremoloSpeed`	Gets or sets the speed of the tremolo effect.
`tupletDenominator`	Gets or sets the tuplet denominator.
`tupletGroup`
`tupletNumerator`	Gets or sets the tuplet numerator.
`vibrato`	Gets or sets the vibrato effect used on this beat.
`voice`	Gets or sets the reference to the parent voice this beat belongs to.
`wahPedal`	Whether the wah pedal should be used when playing the beat.
`whammyBarPoints`	Gets or sets the points defining the whammy bar usage.
`whammyBarType`	Gets or sets the whammy bar style of this beat.
`whammyStyle`	Gets or sets which whammy bar style should be used for this bar.

Methods

`addNote(Note)`
`addWhammyBarPoint(BendPoint)`
`chain(Map<string, unknown> \| null)`
`finish(Settings, Map<string, unknown> \| null)`
`finishTuplet()`
`getAutomation(AutomationType)`
`getNoteOnString(number)`
`getNoteWithRealValue(number)`
`hasNoteOnString(number)`
`isAfter(Beat)`	Checks whether the current beat is timewise after the given beat.
`isBefore(Beat)`	Checks whether the current beat is timewise before the given beat.
`removeNote(Note)`
`removeWhammyBarPoint(number)`
`updateDurations()`