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

    Type Alias ReferenceProfileOptions

    Options for analyzeReference.

    type ReferenceProfileOptions = {
        ts?: MeterLike;
        meters?: MeterLike;
        key?: KeyLike;
        timeline?: ChordTimeline;
        melody?: readonly NoteEvent[];
        totalBeats?: number;
        budget?: number;
    }
    Index

    A single time signature held across the whole span, as sugar for a one-element meters; defaults to 4/4. Giving both is an input error.

    4/4

    meters?: MeterLike

    The meter as it changes over the span.

    4/4 throughout
    
    key?: KeyLike

    The key, when it is already known: read as one key across the whole span, as chordTimelineFromNotes reads it. Omit it to have the keys searched for over time.

    the keys inferred from the notes over time
    
    timeline?: ChordTimeline

    The harmony, given rather than inferred — the shape an arrangement's timeline option takes. The key regions are still read from key or, without one, from the notes.

    inferred from the notes
    
    melody?: readonly NoteEvent[]

    The melodic line. Omit it to read the top line of notes, where notes struck together are one event and the highest of them stands for it.

    the top line of the notes
    
    totalBeats?: number

    End of the analysed span in beats.

    the end of the last note or chord segment
    
    budget?: number

    Upper bound on the work each analysis may do.