player.vibrato

since 0.9.6

player.vibratoJavaScriptplayer.vibratoJSONPlayer.Vibrato.netplayer.vibratoAndroid

Description

The Vibrato settings allow control how the different vibrato types are generated for audio. AlphaTab supports 4 types of vibratos, for each vibrato the amplitude and the wavelength can be configured. The amplitude controls how many semitones the vibrato changes the pitch up and down while playback. The wavelength controls how many midi ticks it will take to complete one up and down vibrato. The 4 vibrato types are:

1. Beat Slight - A fast vibrato on the whole beat. This vibrato is usually done with the whammy bar.
2. Beat Wide - A slow vibrato on the whole beat. This vibrato is usually done with the whammy bar.
3. Note Slight - A fast vibrato on a single note. This vibrato is usually done with the finger on the fretboard.
4. Note Wide - A slow vibrato on a single note. This vibrato is usually done with the finger on the fretboard.

JavaScript

readonly vibrato: VibratoPlaybackSettings;

C#

VibratoPlaybackSettings Vibrato { get; }

Kotlin

val vibrato: VibratoPlaybackSettings

Vibrato Settings

Description

This object defines the details on how to generate the vibrato effects.

 class VibratoPlaybackSettings

Properties

beatSlightAmplitude	number	`2`	The amplitude for the beat-slight vibrato in semitones.
beatSlightLength	number	`480`	The wavelength of the beat-slight vibrato in midi ticks.
beatWideAmplitude	number	`2`	The amplitude for the beat-wide vibrato in semitones.
beatWideLength	number	`480`	The wavelength of the beat-wide vibrato in midi ticks.
noteSlightAmplitude	number	`0.5`	The amplitude for the note-slight vibrato in semitones.
noteSlightLength	number	`360`	The wavelength of the note-slight vibrato in midi ticks.
noteWideAmplitude	number	`1`	The amplitude for the note-wide vibrato in semitones.
noteWideLength	number	`240`	The wavelength of the note-wide vibrato in midi ticks.