kiteplayer-audioviz/io.github.yuroyami.kiteplayer.audioviz/KeyEstimate

KeyEstimate

A key estimated from pitched audio. Unknown keys are null, never a guess with low confidence. Confidence and correlation are scores against published key profiles, not probabilities.

Properties

confidence

val confidence: Float

Support for this key in 0..1, from its correlation and its lead over the next key.

correlation

val correlation: Float

Correlation of the pitch-class profile with this key's profile, -1..1.

hue

val hue: Float

The key on the circle of fifths, 0..1, for colour. A minor key sits at its relative major, so keys that share most of their notes sit next to each other.

lead

val lead: Float

How far this key's correlation leads the best different key.

mode

val mode: KeyMode

tonic

val tonic: Int

Tonic pitch class, 0 for C up to 11 for B.

tuningCents

val tuningCents: Float

Estimated tuning offset from A4 = 440 Hz, in cents, -50..50.

window

val window: AnalysisWindow

The long window whose analysis last supported this estimate.