Hiyve Components - v1.0.0
    Preparing search index...

    Interface SightReadingOptions

    interface SightReadingOptions {
        chords?: boolean;
        clef?: SightReadingClef;
        difficulty?: SightReadingDifficulty;
        fifths?: number;
        highestMidi?: number;
        lowestMidi?: number;
        measures?: number;
        mode?: SightReadingMode;
        rhythms?: SightReadingRhythm[];
        seed?: number;
        tempoBpm?: number;
        timeSignature?: SightReadingTimeSignature;
        title?: string;
    }
    Index

    Properties

    chords?: boolean

    Three-note chords under the tune, in close position with the tune on top, on notes of a quarter or longer that sit on the bar's chord. Where they fall follows the difficulty: at 1 on the first beat of each bar, at 2 on the strong beats, from 3 on every such note (default: false)

    Treble, bass, alto or tenor (default: treble)

    1: steps and small leaps, quarters and halves. 2: eighths, dotted notes and rests. 3: busier rhythms, leaps to a fifth. 4: sixteenths, syncopation, leaps to an octave. 5: chromatic neighbour notes too. With chords on, the level also says where they fall. (default: 2)

    fifths?: number

    The key as sharps (positive) or flats (negative), −6 to 6 (default: 0, C)

    highestMidi?: number

    Highest note, MIDI (default: two octaves above the lowest)

    lowestMidi?: number

    Lowest note, MIDI (default: C4 in the treble clef, C2 in the bass, F3 in the alto, D3 in the tenor)

    measures?: number

    Bars, up to 1023 (default: 8)

    rhythms?: SightReadingRhythm[]

    Which rhythms may appear; default: what the difficulty allows

    seed?: number

    The same seed and options make the same exercise (default: 1); the exercise's code carries both

    tempoBpm?: number

    Quarter notes per minute, written on the score (default: 80)

    title?: string

    The title written on the score (default: made from the key and the settings; the code is kept apart, as code)