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

    Interface CatchSettings

    How catch cards are made.

    interface CatchSettings {
        byEar?: boolean;
        clef: Clef;
        content: ContentKind;
        count: number;
        distances?: readonly number[];
        highestMidi: number;
        keyboardLowestMidi: number;
        keyboardOctaves: number;
        letters?: readonly Step[];
        letterStart?: Step;
        lowestMidi: number;
        maxAccidentals: number;
        play?: boolean;
        rule: "all" | "one";
        symbols: readonly MusicSymbol[];
        targets: number;
        terms: Readonly<Record<string, MusicTerm>>;
        values: readonly NoteValue[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    byEar?: boolean

    Caught by ear: the targets show nothing and each sings a note when it is heard; the ones to catch sing the note the sign plays, and the others a note distances half steps above or below it, every note between lowestMidi and highestMidi (default: false)

    clef: Clef

    For notes and piano keys

    content: ContentKind
    count: number

    Targets on the screen at once

    distances?: readonly number[]

    With byEar: half steps between the sign's note and a wrong target's, one drawn per target — 12 an octave, 1 a half step (default: 12)

    highestMidi: number
    keyboardLowestMidi: number
    keyboardOctaves: number
    letters?: readonly Step[]

    For letters: the letters to draw from (default: all seven, A to G)

    letterStart?: Step

    For letters: where the musical alphabet starts, so going forwards from 'C' runs C D E F G A B, round from G to A; going backwards (an order descending, a hop descending) runs from it the other way. An order starts from 'A' forwards and 'G' backwards unless told otherwise; a hop along the alphabet starts on a letter drawn from letters

    lowestMidi: number
    maxAccidentals: number

    For key signatures: the most sharps or flats

    play?: boolean

    Played on a keyboard: there is no name to catch — count targets come by, each a note on the staff, a key or a letter (content), and every one is caught by playing its key (default: false)

    rule: "all" | "one"

    'one': one target is right, tap it. 'all': every target of the name asked is right, tap them all

    symbols: readonly MusicSymbol[]

    For symbols

    targets: number

    With 'all', how many targets are right

    terms: Readonly<Record<string, MusicTerm>>

    For terms

    values: readonly NoteValue[]

    For note values