player.vibrato

since 0.9.6

player.vibratoJavaScriptplayer.vibratoJSONPlayer.Vibrato.netplayer.vibratoAndroid

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

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

 class VibratoPlaybackSettings

Properties

beatSlightAmplitude

The amplitude for the beat-slight vibrato in semitones.

JavaScript

beatSlightAmplitude: number = 2;

C#

double BeatSlightAmplitude { get; set; } = 2

Kotlin

var beatSlightAmplitude: Double = 2

beatSlightLength

The wavelength of the beat-slight vibrato in midi ticks.

JavaScript

beatSlightLength: number = 480;

C#

double BeatSlightLength { get; set; } = 480

Kotlin

var beatSlightLength: Double = 480

beatWideAmplitude

The amplitude for the beat-wide vibrato in semitones.

JavaScript

beatWideAmplitude: number = 2;

C#

double BeatWideAmplitude { get; set; } = 2

Kotlin

var beatWideAmplitude: Double = 2

beatWideLength

The wavelength of the beat-wide vibrato in midi ticks.

JavaScript

beatWideLength: number = 480;

C#

double BeatWideLength { get; set; } = 480

Kotlin

var beatWideLength: Double = 480

noteSlightAmplitude

The amplitude for the note-slight vibrato in semitones.

JavaScript

noteSlightAmplitude: number = 0.5;

C#

double NoteSlightAmplitude { get; set; } = 0.5

Kotlin

var noteSlightAmplitude: Double = 0.5

noteSlightLength

The wavelength of the note-slight vibrato in midi ticks.

JavaScript

noteSlightLength: number = 360;

C#

double NoteSlightLength { get; set; } = 360

Kotlin

var noteSlightLength: Double = 360

noteWideAmplitude

The amplitude for the note-wide vibrato in semitones.

JavaScript

noteWideAmplitude: number = 1;

C#

double NoteWideAmplitude { get; set; } = 1

Kotlin

var noteWideAmplitude: Double = 1

noteWideLength

The wavelength of the note-wide vibrato in midi ticks.

JavaScript

noteWideLength: number = 240;

C#

double NoteWideLength { get; set; } = 240

Kotlin

var noteWideLength: Double = 240