The tuplet object
Type: Dictionary
The tuplet object organizes a set of musical events that form a distinct and contiguous run within a sequence, and which are subject to a common time modification ratio expressed as the quotient of two rational numbers. A tuplet behaves much like a sequence with respect to its contents.
The contents of the tuplet are placed into a temporal sequence by performing the procedure sequencing the content with a starting position determined by the parent context, and a time modification ratio equal to the tuplet’s outer value divided by its inner value. Following this procedure, the value of the sequence cursor MUST equal the value of inner, or the contents are considered to be in error.
Keys:
| Name | Type | Required? | Description |
|---|---|---|---|
| yes, no or auto object | No | Controls the display of a bracket in conjunction with the tuplet. This is disregarded if "show-number" has a value of "none". * "auto" (default) — a bracket is shown for the tuplet if and only if the notes are unbeamed. * "yes" — always display a bracket. * "no" — never display a bracket. |
|
| An array of event objects | Yes | ||
| note value quantity object | Yes | The duration of the enclosed content, as notated. For example, a quarter-note triplet would use the value {"multiple": "3", "duration": {"base": "quarter"}}. |
|
| orientation object | No | A specific orientation for this tuplet. If not provided, the orientation is inherited from any ancestor element that specified it. If no ancestor did so, the orientation is determined automatically according to the implementation’s rendering rules. | |
| note value quantity object | Yes | The duration of this tuplet with respect to its containing element. This is how much time the tuplet occupies in the measure (or parent tuplet, in case of nested tuplets) in which it is placed. For example, a quarter-note triplet would use the value {"multiple": "2", "duration": {"base": "quarter"}}. |
|
| tuplet display setting object | No | Controls the display of the quantity of inner and outer note value units for the tuplet. * "none" — do not show any tuplet number. * "inner" (default) — display only the numerator of the tuplet's "inner" attribute. * "both" — display both the numerators of the tuplet's "inner" and "outer" attributes. |
|
| tuplet display setting object | No | Controls the display of the note value units used inside and outside the tuplet. * "none" (default) — do not show any tuplet units. * "inner" — display only the note value unit of the tuplet’s "inner" attribute. * "both" — display both the note value units of the tuplet's "inner" and "outer" attributes. |
|
| staff number object | No | A specific staff index for this tuplet. If not provided, the value is inherited from any ancestor element that specified it. If no ancestor did so, the value is determined automatically according to the implementation’s rendering rules. The primary purpose of this attribute is to override a default staff assignment at the sequence level — as in cross-staff keyboard notation. |
|
The string "tuplet"
|
Yes |
Examples
This object is used in the following examples: