OptionalkeyA single key held across the whole arrangement. Omit it, and keys with
it, to have the key searched for over time so a modulating piece is read
against the key actually in force.
Taken in whatever form the caller holds a key, and kept whole: the region built from it carries the spelling and the scale form it was named with.
OptionalkeysKey regions to judge against, when a previous pass already worked them out.
Takes precedence over key; supplying both is answering the same question
twice, and the more specific answer wins.
OptionaltimelineA chord timeline to analyse against, instead of inferring one from the notes. Supply it to analyse a hand-written progression, or to reuse the timeline of an earlier call rather than re-running chord inference.
OptionalharmonyIndices of the tracks the harmony is inferred from. Defaults to every pitched track. Percussion tracks are excluded either way. An index naming no track is an input error rather than one that matches nothing.
OptionalminLowest severity reported in conflicts.
OptionaltsA single time signature held across the whole arrangement, as sugar for a
one-element meters; defaults to 4/4. Giving both is an input error.
OptionalmetersThe meter as it changes over the arrangement. Bar lines, downbeats and metric weight all follow the signature in force at the beat in question.
OptionalpickupLength of the pickup in beats, when the piece starts with one.
The first downbeat is beat 0, so an upbeat is written at negative beats. Declaring its length rejects a note that starts before the pickup does; leave it unset to accept any finite onset.
OptionalharmonicExpected chord length in beats; defaults to the length of the opening bar.
A prior rather than a grid: the arrangement analysis infers its harmony
with dynamic segmentation, where the longer a chord is expected to last the
more evidence a change needs before the search will place one. A chord may
still begin at any position the notes argue for. Supply timeline to
analyse against boundaries you have fixed yourself.
OptionalprofileSafety profile used for conflict detection; defaults to pop.
OptionalbudgetUpper bound on the work this call may do — note counts, windows, and candidate counts are each checked against it before anything is allocated.
Raise it to analyse a piece larger than the default allows; the default is DEFAULT_GENERATION_BUDGET, chosen so a runaway input fails fast rather than blocking the thread.
Options controlling analyzeArrangement and tensionCurve.