@libraz/libcantus - v1.1.0
    Preparing search index...

    Type Alias Vocabulary<T>

    One remembered figure, together with the conditions it fits.

    The optional conditions are read as "no restriction" when absent: an entry with no sections fits every section, one with no tempoRange fits every tempo. Vocabulary.difficulty is on the same 1..5 scale as the playability report, and is compared against the difficulty ceiling: an entry harder than the ceiling is rejected, never simplified in place.

    type Vocabulary<T> = {
        id: string;
        genre: Genre;
        material: T;
        articulations: Articulation[];
        fitsOver?: ChordQuality[];
        sections?: Section[];
        tempoRange?: [number, number];
        ts?: TimeSignature;
        difficulty: number;
        provenance: Provenance;
    }

    Type Parameters

    • T

      The material this kind of figure is made of: chord-relative degrees for a bass lick, voices on a grid for a drum pattern.

    Index
    id: string

    Stable identifier; a caller entry with the same id replaces a built-in.

    genre: Genre
    material: T

    The figure itself.

    articulations: Articulation[]

    How the figure is played, over and above the material's own strokes.

    These are requirements, not decoration: where a query names the techniques the instrument can produce, an entry asking for one the instrument does not have is not offered. A kit with no flam is never handed flam material.

    fitsOver?: ChordQuality[]

    Chord qualities the figure works over; absent means any chord.

    sections?: Section[]

    Sections the figure suits; absent means any section.

    tempoRange?: [number, number]

    Inclusive tempo band in BPM; absent means any tempo.

    Time signature the figure is written in; absent means any.

    difficulty: number

    How hard the figure is to play, from 1 to 5.

    provenance: Provenance

    Why this figure may be published; see the module documentation.