alphaTab.model.SpelledPitch

A pitch as it is written in notation: a diatonic step with an accidental in an octave. Enharmonic spellings like F#3 and Gb3 share the same value but are distinct pitches. Pitches are immutable, in JSON they are written as text like F#3.

 class SpelledPitch

Properties

alter

The accidental of the pitch in semitones: -2 = double flat, -1 = flat, 0 = natural, 1 = sharp, 2 = double sharp.

JavaScript

readonly alter: number;

C#

double Alter { get; }

Kotlin

val alter: Double

chroma

The pitch class of the pitch in the range 0-11 (C = 0, C#/Db = 1 ... B = 11).

JavaScript

readonly chroma: number;

C#

double Chroma { get; }

Kotlin

val chroma: Double

octave

The octave of the written step in scientific pitch notation (C4 is the middle C). The accidental does not change the octave: B#3 sounds like C4 and Cb4 sounds like B3.

JavaScript

readonly octave: number;

C#

double Octave { get; }

Kotlin

val octave: Double

step

The diatonic step (letter) of the pitch: 0 = C, 1 = D, 2 = E, 3 = F, 4 = G, 5 = A, 6 = B.

JavaScript

readonly step: number;

C#

double Step { get; }

Kotlin

val step: Double

value

The MIDI value of the pitch (C4 = 60).

JavaScript

readonly value: number;

C#

double Value { get; }

Kotlin

val value: Double

Methods

toNameString

The written name of the pitch without octave, like C, F# or Bbb.

JavaScript

toNameString(): string

C#

string ToNameString()

Kotlin

fun toNameString(): String

toString

The written name of the pitch with octave, like C4, F#3 or Bbb2.

JavaScript

toString(): string

C#

string ToString()

Kotlin

fun toString(): String