VoxaTrace/com.musicmuni.voxatrace.common.model/ShrutiOption

ShrutiOption

data class ShrutiOption(val hz: Float, val pitchClassIndex: Int, val pitchClassName: String, val noteLabel: String, val shiftSemitones: Float)

One viable shruti option for the student to pick from.

Options are produced by com.musicmuni.voxatrace.common.MusicTheory.alignShruti as part of ShrutiAlignmentResult.options. They span the range [-maxFineTuneSemitones, +maxFineTuneSemitones] of pitch class shifts relative to the lesson's reference key. Each option's hz is computed at the octave nearest to the student's anchor shruti, so the chips stay in the student's vocal range regardless of which key the lesson is in.

Constructors

ShrutiOption

constructor(hz: Float, pitchClassIndex: Int, pitchClassName: String, noteLabel: String, shiftSemitones: Float)

Properties

val hz: Float

The shruti frequency in Hz at the octave nearest to the student's anchor.

noteLabel

val noteLabel: String

Pitch class plus octave (e.g., "C4", "G#3"), suitable for displaying to the student.

pitchClassIndex

val pitchClassIndex: Int

Chromatic index of the pitch class (0..11), where 0 = C, 1 = C#, ..., 11 = B.

pitchClassName

val pitchClassName: String

Pitch class name in Western notation (e.g., "C", "C#", "D"). One of com.musicmuni.voxatrace.common.MusicTheory.NOTE_NAMES.

shiftSemitones

val shiftSemitones: Float

The audio shift (in semitones) that would be applied if this option is chosen. Equal to the index offset from the reference pitch class (-maxFineTuneSemitones..+maxFineTuneSemitones). Pass to SonixPlayerConfig.Builder().pitch(shiftSemitones) to build a player config that transposes the lesson audio to this option's pitch class.