Universal Music Theory Library - v0.12.0
    Preparing search index...

    Interface KeyDetectionOptions

    Options for key detection.

    interface KeyDetectionOptions {
        modes?: boolean;
        profile?:
            | KeyProfile
            | "krumhansl"
            | "aarden"
            | "bellman"
            | "temperley"
            | "simple";
    }
    Index

    Properties

    Properties

    modes?: boolean

    Also read church modes (default false). The diatonic collection that holds the most weight gives the seven notes (the best key breaks a tie); within them each degree scores the weight of its triad, the root counted twice. When a degree other than the major and minor tonics scores strictly higher, its mode is put first, with the confidence of that key: a Dm7 G7 vamp is 'D Dorian'. Only notes count, not chord roots or the bass, so with little music or no clear tonic the mode can be wrong.

    profile?:
        | KeyProfile
        | "krumhansl"
        | "aarden"
        | "bellman"
        | "temperley"
        | "simple"

    Key profile to correlate with (default 'krumhansl'), or a custom pair.