Skip to content

transpose()

Shift the pitch of every note, in place.

With no scale, steps are semitones (for example, 12 raises everything by an octave). With a scale and key, steps are scale degrees instead, keeping the music in that key.

Parameters

Mod.transpose() is a static utility. Call it on the Mod class itself, for example:

Mod.transpose(material, steps)
Mod.transpose(material, steps, scale, key)

Parameter Type Default Description
material Note, Phrase, Part, or Score required The music to change.
steps int required How far to shift, in semitones, or in scale degrees when a scale is given.
scale list[int] CHROMATIC_SCALE The scale to shift within, a list of pitch classes between 0 and 11. If omitted, the shift is chromatic (by semitones).
key int 0 The scale's root pitch class, from 0 to 11, where 0 means C.