OptionaltsA 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.
OptionalmetersThe meter as it changes over the span. Bar lines, downbeats and the metric accents the search discounts a modulation by all follow the signature in force at the beat in question, so a piece that changes meter is not read in the one it opened in.
OptionalexpectedExpected length of one key area in beats; defaults to four bars of the opening meter.
This is a prior, not a window: the longer a key is expected to hold, the more evidence a modulation needs before the search will report one. Keys change far more slowly than chords do, which is why the default is measured in bars rather than beats.
OptionalminShortest key area the search may report, in beats; defaults to one bar of
the opening meter. Values above expectedKeyBeats are clamped to it.
OptionaltotalEnd of the analyzed span in beats; defaults to the end of the last note or chord segment.
OptionalprofileKey profile the regions are scored against; defaults to 'krumhansl'.
Same meaning as the option of the same name on the key detectors.
Every entry point reports confidence as the correlation between a
region's pitch-class distribution and this profile, so the option is what
that number is measured against. Which keys detectModulations
reports is settled by how each chord reads in a key rather than by a
pitch-class profile, so there the profile scores the answer without
choosing it.
OptionalbudgetUpper bound on the work this call may do.
Options shared by the key-region entry points.