Beat Properties
This page documents the beat property scope โ the properties attached to a beat that render as effects or annotations in the music sheet.
Historically these property names are heavily abbreviated to keep source short. A more verbose alternative will land in a future alphaTab release.
fโ
Scope: Beat property
f ()
Description: Adds a fade-in effect to the beat. Applies to all notes.
Example:
(0.1 2.2 2.3 2.4 0.5).2 { f }
foโ
Scope: Beat property
fo ()
Description: Adds a fade-out effect to the beat. Applies to all notes.
Example:
(0.1 2.2 2.3 2.4 0.5).1 { fo }
vsโ
Scope: Beat property
vs ()
Description: Adds a volume-swell effect to the beat. Applies to all notes.
Example:
(0.1 2.2 2.3 2.4 0.5).1 { vs }
vโ
Scope: Beat property
v ()
Description: Adds a slight vibrato effect to the beat. Applies to all notes.
Example:
(0.1 2.2 2.3 2.4 0.5).1 { v }
vwโ
Scope: Beat property
vw ()
Description: Adds a wide vibrato effect to the beat. Applies to all notes.
Example:
(0.1 2.2 2.3 2.4 0.5).1 { vw }
sโ
Scope: Beat property
s ()
Description: Adds a bass slap annotation to the beat.
Example:
\track {instrument "Electric Bass Finger"}
(3 4) 3.4.8 {s} (5.1 5.2).4 {p} 3.4.8 {s} (5.1 5.2).4 {p}
pโ
Scope: Beat property
p ()
Description: Adds a bass pop annotation to the beat.
Example:
\track {instrument "Electric Bass Finger"}
(3 4) 3.4.8 {s} (5.1 5.2).4 {p} 3.4.8 {s} (5.1 5.2).4 {p}
ttโ
Scope: Beat property
tt ()
Description: Adds a guitar or bass tapping annotation to the beat.
Example:
\track {instrument "Electric Bass Finger"}
:8 {tu 3}
18.1 {tt h} 10.1 {h} 14.1
18.1 {tt h} 10.1 {h} 14.1
18.1 {tt h} 10.1 {h} 14.1
18.1 {tt h} 10.1 {h} 14.1
dโ
Scope: Beat property
d ()
Description: Marks the beat with a single augmentation dot.
Example:
(0.1 2.2 2.3 2.4 0.5).1 { d }
ddโ
Scope: Beat property
dd ()
Description: Marks the beat with a double augmentation dot.
Example:
(0.1 2.2 2.3 2.4 0.5).1 { dd }
suโ
Scope: Beat property
su ()
Description: Adds an upwards pick-stroke annotation to the beat.
Example:
0.1 { su }
sdโ
Scope: Beat property
sd ()
Description: Adds an downwards pick-stroke annotation to the beat.
Example:
0.1 { sd }
creโ
Scope: Beat property
cre ()
Description: Adds a crescendo effect to the beat.
Example:
3.3 { cre } -.3 { cre }
decโ
Scope: Beat property
dec ()
Description: Adds a decrescendo (diminuendo) effect to the beat.
Example:
3.3 { dec } -.3 { dec }
spdโ
Scope: Beat property
spd ()
Description: Add a sustain pedal down-press to the beat.
Example:
C4 {spd} C4 {sph} C4 {sph} C4 {spu} |
C4 {spd} C4 {sph} C4 {sph} C4 {spe}
sphโ
Scope: Beat property
sph ()
Description: Add a sustain pedal hold to the beat.
Example:
C4 {spd} C4 {sph} C4 {sph} C4 {spu} |
C4 {spd} C4 {sph} C4 {sph} C4 {spe}
spuโ
Scope: Beat property
spu ()
Description: Add a sustain pedal up (release) to the beat.
Example:
C4 {spd} C4 {sph} C4 {sph} C4 {spu} |
C4 {spd} C4 {sph} C4 {sph} C4 {spe}
speโ
Scope: Beat property
spe ()
Description: Add a sustain pedal up (release) to the end of the beat.
Example:
C4 {spd} C4 {sph} C4 {sph} C4 {spu} |
C4 {spd} C4 {sph} C4 {sph} C4 {spe}
slashedโ
Scope: Beat property
slashed ()
Description: Marks the beat to be displayed with slash notation.
Example:
(0.1 2.2 2.3 2.4 0.5).2 (0.1 2.2 2.3 2.4 0.5).2 { slashed }
dsโ
Scope: Beat property
ds ()
Description: Marks the beat to be a dead-slap beat.
As no notes should be on such a beat, simply use () to indicate the empty beat which is not a rest.
Example:
().4 {ds} ().4 {ds}
glpfโ
Scope: Beat property
glpf ()
Description: Adds a golpe finger-tap effect to the beat.
Example:
3.3{glpf} 3.3{glpt}
glptโ
Scope: Beat property
glpt ()
Description: Adds a golpe thumb-tap effect to the beat.
Example:
3.3{glpf} 3.3{glpt}
wahoโ
Scope: Beat property
waho ()
Description: Adds a Wah-pedal opening effect to the beat.
Example:
3.3 3.3{waho} 3.3 3.3 {wahc}
wahcโ
Scope: Beat property
wahc ()
Description: Adds a Wah-pedal close effect to the beat.
Example:
3.3 3.3{waho} 3.3 3.3 {wahc}
legatoOriginโ
Scope: Beat property
legatoOrigin ()
Description: Adds a legato from this beat to the next one.
Example:
3.3.4{ legatoOrigin } 10.3.4
timerโ
Scope: Beat property
timer ()
Description: Adds a timestamp marker to the beat.
Timers are showing the exact timestamp when a beat is played the first time (respecting aspects like repeats).
Example:
\tempo 120
3.3.4 { timer } 3.3.4*3 |
\ro 3.3.4 { timer } 3.3.4*3 |
3.3.4 { timer } 3.3.4*3 |
\jump fine 3.3.4 { timer } 3.3.4*3 |
\ae (1) 3.3.4 { timer } 3.3.4*3 |
\ae (2 3) \rc 3 3.3.4 { timer } 3.3.4*3 |
3.3.4 { timer } 3.3.4*3 |
\jump DaCapoAlFine 3.3.4 { timer } 3.3.4*3 |
3.3.4 { timer } 3.3.4*3
tuโ
Scope: Beat property
// [1]:
tu simple
// [2]:
tu (numerator denominator)
Description: Adds a tuplet to the beat duration.
There are some built-in simple tuplet variants or you can specify the exact division.
Parameters:
| Overload | Name | Description | Type | Required |
|---|---|---|---|---|
[1] | simple | The simple tuplet | Number | yes |
[2] | numerator | The tuplet numerator | Number | yes |
[2] | denominator | The tuplet denominator | Number | yes |
Parameter Values:
Following parameters have value limitations
| Overload | Name | Values | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
[1] | simple |
|
Example:
C4 {tu 3} * 3 |
C4 {tu 5} * 5 |
C4 {tu 5 2} * 5
txtโ
Scope: Beat property
txt text
Description: Adds a text annotation to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
text | The text to show above the beat | String | yes |
Example:
C4 {txt "This is a C4 Note"}
lyricsโ
Scope: Beat property
// [1]:
lyrics text
// [2]:
lyrics (line text)
Description: Adds a lyric text to the beat.
This is an alternative way of applying the exact lyrics to beats instead of using the \lyrics metadata where a special syntax is used to spread the text across beats.
Parameters:
| Overload | Name | Description | Type | Required |
|---|---|---|---|---|
[1] | text | The lyrics to show | String | yes |
[2] | line | The line number (e.g. for multiple verses) | Number | yes |
[2] | text | The lyrics to show | String | yes |
Example:
C4 {lyrics "Do"}
D4 {lyrics "Re"}
E4 {lyrics "Mi"}
F4 {lyrics "Fa"} |
G4 {lyrics 0 "So" lyrics 1 "G"}
A4 {lyrics 0 "La" lyrics 1 "A"}
B4 {lyrics 0 "Ti" lyrics 1 "B"}
r
tbโ
Scope: Beat property
// [1]:
tb (values)
// [2]:
tb (type values)
// [3]:
tb (style values)
// [4]:
tb (type style values)
Description: Adds a whammy bar (aka. tremolo bar) effect to the beat.
- The
tbvariant automatically spreads the values across the duration of the beat. - The
tbe(exact) variant allows specifying exactly at which offset a value is placed.
It is recommended to rely on the auto-detection of the type and only specify the type explicitly if something is wrong.
Parameters:
| Overload | Name | Description | Type | Required |
|---|---|---|---|---|
[1] | values | The values of the whammy in quarter-tones relative to the original note, decimals supported | Number[] | no |
[2] | type | The type of whammy (affects the display). | Ident | yes |
[2] | values | The values of the whammy in quarter-tones relative to the original note, decimals supported | Number[] | no |
[3] | style | The style of the whammy play style. | default|gradual|fast | yes |
[3] | values | The values of the whammy in quarter-tones relative to the original note, decimals supported | Number[] | no |
[4] | type | The type of whammy (affects the display). | Ident | yes |
[4] | style | The style of the whammy play style. | default|gradual|fast | yes |
[4] | values | The values of the whammy in quarter-tones relative to the original note, decimals supported | Number[] | no |
Parameter Values:
Following parameters have value limitations
| Overload | Name | Values | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
[2] | type |
| ||||||||||||||
[3] | style |
| ||||||||||||||
[4] | type |
| ||||||||||||||
[4] | style |
|
Example:
3.3.1{tb (0 4 0 8)} | r |
3.3.1{tb (0 -4 0 -8)} | r |
3.3.1{tbe (0 0 5 4 30 8 60 0)}
tbeโ
Scope: Beat property
// [1]:
tbe (valuesAndOffsets)
// [2]:
tbe (type valuesAndOffsets)
// [3]:
tbe (style valuesAndOffsets)
// [4]:
tbe (type style valuesAndOffsets)
Description: Adds a whammy bar (aka. tremolo bar) effect to the beat.
- The
tbvariant automatically spreads the values across the duration of the beat. - The
tbe(exact) variant allows specifying exactly at which offset a value is placed.
It is recommended to rely on the auto-detection of the type and only specify the type explicitly if something is wrong.
Parameters:
| Overload | Name | Description | Type | Required |
|---|---|---|---|---|
[1] | valuesAndOffsets | The offset at which the value becomes valid in range of 0-60 and The value of the whammy in quarter-tones relative to the original note, decimals supported. The offset and value are actually two parameters: 3.3.1{tbe (0 0 5 4 30 8 60 0)} | Number[] | no |
[2] | type | The type of whammy (affects the display). | Ident | yes |
[2] | valuesAndOffsets | The offset at which the value becomes valid in range of 0-60 and The value of the whammy in quarter-tones relative to the original note, decimals supported. The offset and value are actually two parameters: 3.3.1{tbe (0 0 5 4 30 8 60 0)} | Number[] | no |
[3] | style | The style of the whammy. | default|gradual|fast | yes |
[3] | valuesAndOffsets | The offset at which the value becomes valid in range of 0-60 and The value of the whammy in quarter-tones relative to the original note, decimals supported. The offset and value are actually two parameters: 3.3.1{tbe (0 0 5 4 30 8 60 0)} | Number[] | no |
[4] | type | The type of whammy (affects the display). | Ident | yes |
[4] | style | The style of the whammy. | default|gradual|fast | yes |
[4] | valuesAndOffsets | The offset at which the value becomes valid in range of 0-60 and The value of the whammy in quarter-tones relative to the original note, decimals supported. The offset and value are actually two parameters: 3.3.1{tbe (0 0 5 4 30 8 60 0)} | Number[] | no |
Parameter Values:
Following parameters have value limitations
| Overload | Name | Values | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
[2] | type |
| ||||||||||||||
[3] | style |
| ||||||||||||||
[4] | type |
| ||||||||||||||
[4] | style |
|
Example:
3.3.1{tb (0 4 0 8)} | r |
3.3.1{tb (0 -4 0 -8)} | r |
3.3.1{tbe (0 0 5 4 30 8 60 0)}
buโ
Scope: Beat property
bu duration
Description: Adds a brush stroke effect to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
duration | A custom duration of the stroke speed in MIDI ticks | Number | no |
Example:
:2 (0.1 0.2 0.3 2.4 2.5 0.6){bd} (0.1 0.2 0.3 2.4 2.5 0.6){bu} |
(0.1 0.2 0.3 2.4 2.5 0.6){bd 360} (0.1 0.2 0.3 2.4 2.5 0.6){bu 60}
bdโ
Scope: Beat property
bd duration
Description: Adds a brush stroke effect to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
duration | A custom duration of the stroke speed in MIDI ticks | Number | no |
Example:
:2 (0.1 0.2 0.3 2.4 2.5 0.6){bd} (0.1 0.2 0.3 2.4 2.5 0.6){bu} |
(0.1 0.2 0.3 2.4 2.5 0.6){bd 360} (0.1 0.2 0.3 2.4 2.5 0.6){bu 60}
auโ
Scope: Beat property
au duration
Description: Adds an arpeggio effect to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
duration | A custom duration of the stroke speed in MIDI ticks | Number | no |
Example:
(0.1 0.2 0.3 2.4 2.5 0.6){ad} (0.1 0.2 0.3 2.4 2.5 0.6){au} |
adโ
Scope: Beat property
ad duration
Description: Adds an arpeggio effect to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
duration | A custom duration of the stroke speed in MIDI ticks | Number | no |
Example:
(0.1 0.2 0.3 2.4 2.5 0.6){ad} (0.1 0.2 0.3 2.4 2.5 0.6){au} |
chโ
Scope: Beat property
ch chordName
Description: Adds a chord annotation to the beat.
If the staff has a definition for this chord it will be shown in the chord diagram list to indicate its usage. The beat still has to define the notes separately.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
chordName | The name of the chord | String | yes |
Example:
1.1.8{dy ppp} 1.1{dy pp} 1.1{dy p} 1.1{dy mp} 1.1{dy mf} 1.1{dy f} 1.1{dy ff} 1.1{dy fff}
grโ
Scope: Beat property
gr type
Description: Marks the beat as a grace beat holding grace notes.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
type | The type of grace notes | Ident | no bb |
Parameter Values:
Following parameters have value limitations
| Name | Values | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type |
|
Example:
C5
D5 {gr} C5
C5
D5 {gr} C5
|
C5
D5 {gr ob} C5
C5
D5 {gr ob} C5
dyโ
Scope: Beat property
dy dynamic
Description: Defines the play dynamics for this beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
dynamic | The dynamic value to apply | Ident | yes |
Parameter Values:
Following parameters have value limitations
| Name | Values | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
dynamic |
|
Example:
\chord ("C" 0 1 0 2 3 x)
\ts 2 4
(0.1 1.2 0.3 2.4 3.5){ch "C"} (0.1 1.2 0.3 2.4 3.5) |
(0.1 2.2 2.3 2.4 0.5){ch "A"}
tempoโ
Scope: Beat property
// [1]:
tempo (bpm hide)
// [2]:
tempo (bpm label hide)
Description: Add a tempo change to the beat.
Parameters:
| Overload | Name | Description | Type | Required |
|---|---|---|---|---|
[1] | bpm | The new tempo in BPM | Number | yes |
[1] | hide | If specified, the tempo change is not shown in the music sheet | hide | no |
[2] | bpm | The new tempo in BPM | Number | yes |
[2] | label | A textual label for the tempo | String | yes "" |
[2] | hide | If specified, the tempo change is not shown in the music sheet | hide | no |
Parameter Values:
Following parameters have value limitations
| Overload | Name | Values | ||||
|---|---|---|---|---|---|---|
[1] | hide |
| ||||
[2] | hide |
|
Example:
C4 {tempo 120} D4 E4 {tempo 140} F4 | C4.8 {tempo 80} C4 D4 {tempo 100} D4 E4 {tempo 120} E4 F4 {tempo 240} F4
volumeโ
Scope: Beat property
volume value
Description: Add a volume change to the beat.
The change affects all beats after this one.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
value | The absolute volume of the track within the song in the range of 0-16 | Number | yes |
Example:
C4 {volume 8} D4 E4 {tempo 16} F4
balanceโ
Scope: Beat property
balance value
Description: Add a balance (pan) change to the beat.
The change affects all beats after this one.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
value | The new balance where 0 is left, 16 is right, and 8 is centered. | Number | yes |
Example:
C4 {balance 0} D4 E4 {balance 16} F4
tpโ
Scope: Beat property
tp (marks style)
Description: Add a tremolo picking to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
marks | The number of tremolo marks | Number | yes |
style | The tremolo style | default|buzzRoll | no |
Parameter Values:
Following parameters have value limitations
| Name | Values | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
marks |
| ||||||||||||
style |
|
Example:
3.3{tp 1} 3.3{tp 2} 3.3{tp 3}
\title "Buzz Rolls"
3.3{tp (0 buzzRoll)} // no audio
3.3{tp (1 buzzRoll)} // 8th notes tremolo shown as buzzroll
barreโ
Scope: Beat property
barre (fret mode)
Description: Add a barrรฉ chord notation to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
fret | The numeric fret for the barre chord | Number | yes |
mode | The barre mode | full|half | no Full |
Parameter Values:
Following parameters have value limitations
| Name | Values | ||||||
|---|---|---|---|---|---|---|---|
mode |
|
Example:
1.1 {barre 24} 2.1 {barre 24} 3.1 {barre 24} 4.1 |
1.1 {barre 4 half} 2.1 {barre 4 half} 3.1 {barre 4 half} 4.1 {barre 4 half} |
rasgโ
Scope: Beat property
rasg pattern
Description: Add a rasgueado play pattern to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
pattern | The pattern to apply | Ident | yes |
Parameter Values:
Following parameters have value limitations
| Name | Values | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pattern |
|
Example:
(1.1 3.2 2.3 0.4) * 4 {rasg amii}
otโ
Scope: Beat property
ot value
Description: Adds a octave change (ottava) to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
value | The octave shift to apply | Ident | yes |
Parameter Values:
Following parameters have value limitations
| Name | Values | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value |
|
Example:
3.3.4{ ot 15ma } 3.3.4{ ot 8vb }
instrumentโ
Scope: Beat property
// [1]: Set the midi instrument as midi program number
instrument program
// [2]: Set the midi instrument as midi program name
instrument programName
// [3]: Set the instrument to percussion
instrument percussion
Description: Adds a instrument change to the beat.
Parameters:
| Overload | Name | Description | Type | Required |
|---|---|---|---|---|
[1] | program | MIDI program number (0-127) | Number | yes |
[2] | programName | MIDI program name | String | yes |
[3] | percussion | Percussion | percussion | yes |
Parameter Values:
Following parameters have value limitations
| Overload | Name | Values | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
[2] | programName |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[3] | percussion |
|
Example:
3.3.4{ ot 15ma } 3.3.4{ ot 8vb }
bankโ
Scope: Beat property
bank value
Description: Adds a instrument bank change to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
value | The new MIDI bank | Number | yes |
Example:
C4 C4 C4 {instrument 25 bank 2} C4
fermataโ
Scope: Beat property
fermata (type length)
Description: Adds a fermata to the beat.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
type | The fermata type | short|medium|long | yes |
length | The fermata length | Number | no |
Parameter Values:
Following parameters have value limitations
| Name | Values | ||||||||
|---|---|---|---|---|---|---|---|---|---|
type |
|
Example:
G4 G4 G4 { fermata medium 4 }
beamโ
Scope: Beat property
beam type
Description: Changes the beaming and stem direction for the beat. Can be specified multiple times.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
type | The mode to apply | Ident | yes |
Parameter Values:
Following parameters have value limitations
| Name | Values | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type |
|
Example:
:8 3.3{ beam invert } 3.3 |
3.1{ beam up } 3.1 |
3.6{ beam down } 3.6 |
3.3{ beam auto } 3.3 |
3.3{ beam split } 3.3 |
3.3 3.3 { beam merge } 3.3 3.3 |
3.3.16 {beam splitsecondary} 3.3
restDisplayPitchโ
Scope: Beat property
restDisplayPitch pitch
Description: Define the pitch on which the rest symbol should be placed.
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
pitch | The note pitch defining the position, like C4 | Ident | yes |
Example:
r.4{ restDisplayPitch C4 } C4