alphaTab.model.Tuning

This public class represents a predefined string tuning.

 class Tuning

Properties

isStandard

Gets or sets whether this is the standard tuning for this number of strings.

JavaScript

isStandard: boolean;

C#

bool IsStandard { get; set; }

Kotlin

var isStandard: Boolean

name

Gets or sets the name of the tuning.

JavaScript

name: string;

C#

string Name { get; set; }

Kotlin

var name: String

noteNames

(no description)

JavaScript

static readonly noteNames: string[];

C#

static IList<string> NoteNames { get; }

Kotlin

companion object { val noteNames:  }

tunings

Gets or sets the values for each string of the instrument.

JavaScript

tunings: number[];

C#

IList<double> Tunings { get; set; }

Kotlin

var tunings: alphaTab.collections.DoubleList

Methods

findTuning

Tries to find a known tuning by a given list of tuning values.

JavaScript

static findTuning(strings: number[]): Tuning | null

C#

static Tuning? FindTuning(IList<double> strings)

Kotlin

fun findTuning(strings: alphaTab.collections.DoubleList): Tuning?

Parameter	Summary
stringsAll	The values defining the tuning.

Returns

The known tuning.

finish

Tries to detect the name and standard flag of the tuning from a known tuning list based on the string values.

JavaScript

finish(): void

C#

void Finish()

Kotlin

fun finish(): Unit

getDefaultTuningFor

Gets the default tuning for the given string count.

JavaScript

static getDefaultTuningFor(stringCount: number): Tuning | null

C#

static Tuning? GetDefaultTuningFor(double stringCount)

Kotlin

fun getDefaultTuningFor(stringCount: Double): Tuning?

Parameter	Summary
stringCountAll	The string count.

Returns

The tuning for the given string count or null if the string count is not defined.

getPresetsFor

Gets a list of all tuning presets for a given stirng count.

JavaScript

static getPresetsFor(stringCount: number): Tuning[]

C#

static IList<Tuning> GetPresetsFor(double stringCount)

Kotlin

fun getPresetsFor(stringCount: Double): alphaTab.collections.List<Tuning>

Parameter	Summary
stringCountAll	The string count.

Returns

The list of known tunings for the given string count or an empty list if the string count is not defined.

getTextForTuning

(no description)

JavaScript

static getTextForTuning(tuning: number, includeOctave: boolean): string

C#

static string GetTextForTuning(double tuning, bool includeOctave)

Kotlin

fun getTextForTuning(tuning: Double, includeOctave: Boolean): String

Parameter	Summary
tuningAll	(no description)
includeOctaveAll	(no description)

getTextPartsForTuning

(no description)

JavaScript

static getTextPartsForTuning(tuning: number, octaveShift?: number): string[]

C#

static IList<string> GetTextPartsForTuning(double tuning, double? octaveShift)

Kotlin

fun getTextPartsForTuning(tuning: Double, octaveShift: Double?): 

Parameter	Summary
tuningAll	(no description)
octaveShiftAll	(no description)

initialize

(no description)

JavaScript

static initialize(): void

C#

static void Initialize()

Kotlin

fun initialize(): Unit

reset

(no description)

JavaScript

reset(): void

C#

void Reset()

Kotlin

fun reset(): Unit