Top

This is the program reference for version 2.11.57 of LilyPond, the GNU music typesetter.

Music definitions

Music expressions

AbsoluteDynamicEvent

Create a dynamic mark.

Syntax: note\x, where \x is a dynamic mark like \ppp or \sfz. A complete list is in file ly/dynamic-scripts-init.ly.

Event classes: absolute-dynamic-event, dynamic-event, music-event and StreamEvent.

Accepted by: Dynamic_engraver, Dynamic_performer and New_dynamic_engraver.

Properties:

name (symbol):
'AbsoluteDynamicEvent

Name of this music object.

types (list):
'(general-music event dynamic-event absolute-dynamic-event)

The types of this music object; determines by what engraver this music expression is processed.

AnnotateOutputEvent

Print an annotation of an output element.

Event classes: annotate-output-event, music-event and StreamEvent.

Accepted by: Balloon_engraver.

Properties:

name (symbol):
'AnnotateOutputEvent

Name of this music object.

types (list):
'(general-music event annotate-output-event)

The types of this music object; determines by what engraver this music expression is processed.

ApplyContext

Call the argument with the current context during interpreting phase.

Properties:

name (symbol):
'ApplyContext

Name of this music object.

types (list):
'(general-music apply-context)

The types of this music object; determines by what engraver this music expression is processed.

iterator-ctor (procedure):
ly:apply-context-iterator::constructor

Function to construct a music-event-iterator object for this music.

ApplyOutputEvent

Call the argument with all current grobs during interpreting phase.

Syntax: \applyOutput #'context func

Arguments to func are 1. the grob, 2. the originating context, and 3. the context where func is called.

Event classes: apply-output-event, layout-instruction-event, music-event and StreamEvent.

Accepted by: Output_property_engraver.

Properties:

name (symbol):
'ApplyOutputEvent

Name of this music object.

types (list):
'(general-music event apply-output-event)

The types of this music object; determines by what engraver this music expression is processed.

ArpeggioEvent

Make an arpeggio on this note.

Syntax: note-\arpeggio

Event classes: arpeggio-event, music-event and StreamEvent.

Accepted by: Arpeggio_engraver.

Properties:

name (symbol):
'ArpeggioEvent

Name of this music object.

types (list):
'(general-music arpeggio-event event)

The types of this music object; determines by what engraver this music expression is processed.

ArticulationEvent

Add an articulation marking to a note.

Syntax: notexy, where x is a direction (^ for up or _ for down), or LilyPond's choice (no direction specified)), and where y is an articulation (such as -., ->, \tenuto, \downbow). See the Notation Reference for details.

Event classes: articulation-event, script-event, music-event and StreamEvent.

Accepted by: Script_engraver.

Properties:

name (symbol):
'ArticulationEvent

Name of this music object.

types (list):
'(general-music event articulation-event script-event)

The types of this music object; determines by what engraver this music expression is processed.

AutoChangeMusic

Used for making voices that switch between piano staves automatically.

Properties:

name (symbol):
'AutoChangeMusic

Name of this music object.

iterator-ctor (procedure):
ly:auto-change-iterator::constructor

Function to construct a music-event-iterator object for this music.

start-callback (procedure):
ly:music-wrapper::start-callback

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

length-callback (procedure):
ly:music-wrapper::length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

types (list):
'(general-music music-wrapper-music auto-change-instruction)

The types of this music object; determines by what engraver this music expression is processed.

BarCheck

Check whether this music coincides with the start of the measure.

Properties:

name (symbol):
'BarCheck

Name of this music object.

types (list):
'(general-music bar-check)

The types of this music object; determines by what engraver this music expression is processed.

iterator-ctor (procedure):
ly:bar-check-iterator::constructor

Function to construct a music-event-iterator object for this music.

BassFigureEvent

Print a bass-figure text.

Event classes: bass-figure-event, rhythmic-event, music-event and StreamEvent.

Accepted by: Figured_bass_engraver.

Properties:

name (symbol):
'BassFigureEvent

Name of this music object.

types (list):
'(general-music event rhythmic-event bass-figure-event)

The types of this music object; determines by what engraver this music expression is processed.

BeamEvent

Start or stop a beam.

Syntax for manual control: c8-[ c c-] c8

Event classes: beam-event, span-event, music-event and StreamEvent.

Accepted by: Beam_engraver, Beam_performer and Grace_beam_engraver.

Properties:

name (symbol):
'BeamEvent

Name of this music object.

types (list):
'(general-music event beam-event span-event)

The types of this music object; determines by what engraver this music expression is processed.

BeamForbidEvent

Specify that a note may not auto-beamed.

Event classes: beam-forbid-event, music-event and StreamEvent.

Accepted by: Auto_beam_engraver.

Properties:

name (symbol):
'BeamForbidEvent

Name of this music object.

types (list):
'(general-music event beam-forbid-event)

The types of this music object; determines by what engraver this music expression is processed.

BendAfterEvent

A drop/fall/doit jazz articulation.

Event classes: bend-after-event, music-event and StreamEvent.

Accepted by: Bend_engraver.

Properties:

name (symbol):
'BendAfterEvent

Name of this music object.

types (list):
'(general-music bend-after-event event)

The types of this music object; determines by what engraver this music expression is processed.

BreathingEvent

Create a ‘breath mark’ or ‘comma’.

Syntax: note\breathe

Event classes: breathing-event, music-event and StreamEvent.

Accepted by: Breathing_sign_engraver.

Properties:

name (symbol):
'BreathingEvent

Name of this music object.

types (list):
'(general-music event breathing-event)

The types of this music object; determines by what engraver this music expression is processed.

ClusterNoteEvent

A note that is part of a cluster.

Event classes: cluster-note-event, melodic-event, rhythmic-event, music-event and StreamEvent.

Accepted by: Cluster_spanner_engraver.

Properties:

name (symbol):
'ClusterNoteEvent

Name of this music object.

types (list):
'(general-music cluster-note-event melodic-event rhythmic-event event)

The types of this music object; determines by what engraver this music expression is processed.

ContextChange

Change staves in Piano staff.

Syntax: \change Staff = new-id

Properties:

name (symbol):
'ContextChange

Name of this music object.

iterator-ctor (procedure):
ly:change-iterator::constructor

Function to construct a music-event-iterator object for this music.

types (list):
'(general-music translator-change-instruction)

The types of this music object; determines by what engraver this music expression is processed.

ContextSpeccedMusic

Interpret the argument music within a specific context.

Properties:

name (symbol):
'ContextSpeccedMusic

Name of this music object.

iterator-ctor (procedure):
ly:context-specced-music-iterator::constructor

Function to construct a music-event-iterator object for this music.

length-callback (procedure):
ly:music-wrapper::length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

start-callback (procedure):
ly:music-wrapper::start-callback

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

types (list):
'(context-specification general-music music-wrapper-music)

The types of this music object; determines by what engraver this music expression is processed.

CrescendoEvent

Begin or end a crescendo.

Syntax: note\cr ... note\rc

You can also use \<, \!, \cresc, and \endcresc. See the Notation Reference for details.

Event classes: crescendo-event, span-dynamic-event, span-event, music-event and StreamEvent.

Accepted by: Dynamic_engraver, Dynamic_performer and New_dynamic_engraver.

Properties:

name (symbol):
'CrescendoEvent

Name of this music object.

types (list):
'(general-music span-event span-dynamic-event crescendo-event event)

The types of this music object; determines by what engraver this music expression is processed.

DecrescendoEvent

See CrescendoEvent.

Event classes: decrescendo-event, span-dynamic-event, span-event, music-event and StreamEvent.

Accepted by: Dynamic_engraver, Dynamic_performer and New_dynamic_engraver.

Properties:

name (symbol):
'DecrescendoEvent

Name of this music object.

types (list):
'(general-music span-event span-dynamic-event decrescendo-event event)

The types of this music object; determines by what engraver this music expression is processed.

Event

Atomic music event.

Properties:

name (symbol):
'Event

Name of this music object.

types (list):
'(general-music event)

The types of this music object; determines by what engraver this music expression is processed.

EventChord

Internally used to group a set of events.

Properties:

name (symbol):
'EventChord

Name of this music object.

iterator-ctor (procedure):
ly:event-chord-iterator::constructor

Function to construct a music-event-iterator object for this music.

length-callback (procedure):
ly:music-sequence::maximum-length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

to-relative-callback (procedure):
ly:music-sequence::event-chord-relative-callback

How to transform a piece of music to relative pitches.

types (list):
'(general-music event-chord simultaneous-music)

The types of this music object; determines by what engraver this music expression is processed.

ExtenderEvent

Extend lyrics.

Event classes: extender-event, music-event and StreamEvent.

Accepted by: Extender_engraver.

Properties:

name (symbol):
'ExtenderEvent

Name of this music object.

types (list):
'(general-music extender-event event)

The types of this music object; determines by what engraver this music expression is processed.

FingeringEvent

Specify what finger to use for this note.

Event classes: fingering-event, music-event and StreamEvent.

Accepted by: Fingering_engraver.

Properties:

name (symbol):
'FingeringEvent

Name of this music object.

types (list):
'(general-music fingering-event event)

The types of this music object; determines by what engraver this music expression is processed.

GlissandoEvent

Start a glissando on this note.

Event classes: glissando-event, music-event and StreamEvent.

Accepted by: Glissando_engraver.

Properties:

name (symbol):
'GlissandoEvent

Name of this music object.

types (list):
'(general-music glissando-event event)

The types of this music object; determines by what engraver this music expression is processed.

GraceMusic

Interpret the argument as grace notes.

Properties:

name (symbol):
'GraceMusic

Name of this music object.

start-callback (procedure):
ly:grace-music::start-callback

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

length (moment):
#<Mom 0>

The duration of this music.

iterator-ctor (procedure):
ly:grace-iterator::constructor

Function to construct a music-event-iterator object for this music.

types (list):
'(grace-music music-wrapper-music general-music)

The types of this music object; determines by what engraver this music expression is processed.

HarmonicEvent

Mark a note as harmonic.

Event classes: harmonic-event, music-event and StreamEvent.

Not accepted by any engraver or performer.

Properties:

name (symbol):
'HarmonicEvent

Name of this music object.

types (list):
'(general-music event harmonic-event)

The types of this music object; determines by what engraver this music expression is processed.

HyphenEvent

A hyphen between lyric syllables.

Event classes: hyphen-event, music-event and StreamEvent.

Accepted by: Hyphen_engraver.

Properties:

name (symbol):
'HyphenEvent

Name of this music object.

types (list):
'(general-music hyphen-event event)

The types of this music object; determines by what engraver this music expression is processed.

KeyChangeEvent

Change the key signature.

Syntax: \key name scale

Event classes: key-change-event, music-event and StreamEvent.

Accepted by: Key_engraver and Key_performer.

Properties:

name (symbol):
'KeyChangeEvent

Name of this music object.

to-relative-callback (procedure):
#<procedure #f (x p)>

How to transform a piece of music to relative pitches.

types (list):
'(general-music key-change-event event)

The types of this music object; determines by what engraver this music expression is processed.

LabelEvent

Place a bookmarking label.

Event classes: label-event, music-event and StreamEvent.

Accepted by: Paper_column_engraver.

Properties:

name (symbol):
'LabelEvent

Name of this music object.

types (list):
'(general-music label-event event)

The types of this music object; determines by what engraver this music expression is processed.

LaissezVibrerEvent

Don't damp this chord.

Syntax: note\laissezVibrer

Event classes: laissez-vibrer-event, music-event and StreamEvent.

Accepted by: Laissez_vibrer_engraver.

Properties:

name (symbol):
'LaissezVibrerEvent

Name of this music object.

types (list):
'(general-music event laissez-vibrer-event)

The types of this music object; determines by what engraver this music expression is processed.

LigatureEvent

Start or end a ligature.

Event classes: ligature-event, span-event, music-event and StreamEvent.

Accepted by: Ligature_bracket_engraver, Mensural_ligature_engraver and Vaticana_ligature_engraver.

Properties:

name (symbol):
'LigatureEvent

Name of this music object.

span-type (string):
'ligature

What kind of spanner should be created?

TODO: Consider making type into symbol.

types (list):
'(general-music span-event ligature-event event)

The types of this music object; determines by what engraver this music expression is processed.

LineBreakEvent

Allow, forbid or force a line break.

Event classes: line-break-event, break-event, music-event and StreamEvent.

Accepted by: Page_turn_engraver and Paper_column_engraver.

Properties:

name (symbol):
'LineBreakEvent

Name of this music object.

types (list):
'(general-music line-break-event break-event event)

The types of this music object; determines by what engraver this music expression is processed.

LyricCombineMusic

Align lyrics to the start of notes.

Syntax: \lyricsto voicename lyrics

Properties:

name (symbol):
'LyricCombineMusic

Name of this music object.

length (moment):
#<Mom 0>

The duration of this music.

types (list):
'(general-music lyric-combine-music)

The types of this music object; determines by what engraver this music expression is processed.

iterator-ctor (procedure):
ly:lyric-combine-music-iterator::constructor

Function to construct a music-event-iterator object for this music.

LyricEvent

A lyric syllable. Must be entered in lyrics mode, i.e., \lyrics { twinkle4 twinkle4 } .

Event classes: lyric-event, rhythmic-event, music-event and StreamEvent.

Accepted by: Lyric_engraver and Lyric_performer.

Properties:

name (symbol):
'LyricEvent

Name of this music object.

types (list):
'(general-music rhythmic-event lyric-event event)

The types of this music object; determines by what engraver this music expression is processed.

MarkEvent

Insert a rehearsal mark.

Syntax: \mark marker

Example: \mark "A"

Event classes: mark-event, music-event and StreamEvent.

Accepted by: Mark_engraver.

Properties:

name (symbol):
'MarkEvent

Name of this music object.

types (list):
'(general-music mark-event event)

The types of this music object; determines by what engraver this music expression is processed.

MultiMeasureRestEvent

Used internally by MultiMeasureRestMusic to signal rests.

Event classes: multi-measure-rest-event, rhythmic-event, music-event and StreamEvent.

Accepted by: Multi_measure_rest_engraver.

Properties:

name (symbol):
'MultiMeasureRestEvent

Name of this music object.

types (list):
'(general-music event rhythmic-event multi-measure-rest-event)

The types of this music object; determines by what engraver this music expression is processed.

MultiMeasureRestMusic

Rests that may be compressed into Multi rests.

Syntax: R2.*4 for 4 measures in 3/4 time.

Properties:

name (symbol):
'MultiMeasureRestMusic

Name of this music object.

iterator-ctor (procedure):
ly:sequential-iterator::constructor

Function to construct a music-event-iterator object for this music.

elements-callback (procedure):
mm-rest-child-list

Return a list of children, for use by a sequential iterator. Takes a single music parameter.

types (list):
'(general-music multi-measure-rest)

The types of this music object; determines by what engraver this music expression is processed.

MultiMeasureTextEvent

Texts on multi measure rests.

Syntax: R-\markup { \roman "bla" }

Note the explicit font switch.

Event classes: multi-measure-text-event, music-event and StreamEvent.

Accepted by: Multi_measure_rest_engraver.

Properties:

name (symbol):
'MultiMeasureTextEvent

Name of this music object.

types (list):
'(general-music event multi-measure-text-event)

The types of this music object; determines by what engraver this music expression is processed.

Music

Generic type for music expressions.

Properties:

name (symbol):
'Music

Name of this music object.

types (list):
'(general-music)

The types of this music object; determines by what engraver this music expression is processed.

NoteEvent

A note.

Event classes: note-event, melodic-event, rhythmic-event, music-event and StreamEvent.

Accepted by: Chord_name_engraver, Completion_heads_engraver, Drum_note_performer, Drum_notes_engraver, Fretboard_engraver, Note_heads_engraver, Note_name_engraver, Note_performer and Tab_note_heads_engraver.

Properties:

name (symbol):
'NoteEvent

Name of this music object.

types (list):
'(general-music event note-event rhythmic-event melodic-event)

The types of this music object; determines by what engraver this music expression is processed.

NoteGroupingEvent

Start or stop grouping brackets.

Event classes: note-grouping-event, music-event and StreamEvent.

Accepted by: Horizontal_bracket_engraver.

Properties:

name (symbol):
'NoteGroupingEvent

Name of this music object.

types (list):
'(general-music event note-grouping-event)

The types of this music object; determines by what engraver this music expression is processed.

OverrideProperty

Extend the definition of a graphical object.

Syntax: \override [ context . ] object property = value

Properties:

name (symbol):
'OverrideProperty

Name of this music object.

types (list):
'(general-music layout-instruction-event override-property-event)

The types of this music object; determines by what engraver this music expression is processed.

iterator-ctor (procedure):
ly:push-property-iterator::constructor

Function to construct a music-event-iterator object for this music.

PageBreakEvent

Allow, forbid or force a page break.

Event classes: page-break-event, break-event, music-event and StreamEvent.

Accepted by: Page_turn_engraver and Paper_column_engraver.

Properties:

name (symbol):
'PageBreakEvent

Name of this music object.

types (list):
'(general-music break-event page-break-event event)

The types of this music object; determines by what engraver this music expression is processed.

PageTurnEvent

Allow, forbid or force a page turn.

Event classes: page-turn-event, break-event, music-event and StreamEvent.

Accepted by: Page_turn_engraver and Paper_column_engraver.

Properties:

name (symbol):
'PageTurnEvent

Name of this music object.

types (list):
'(general-music break-event page-turn-event event)

The types of this music object; determines by what engraver this music expression is processed.

PartCombineMusic

Combine two parts on a staff, either merged or as separate voices.

Properties:

name (symbol):
'PartCombineMusic

Name of this music object.

length-callback (procedure):
ly:music-sequence::maximum-length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

start-callback (procedure):
ly:music-sequence::minimum-start-callback

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

types (list):
'(general-music part-combine-music)

The types of this music object; determines by what engraver this music expression is processed.

iterator-ctor (procedure):
ly:part-combine-iterator::constructor

Function to construct a music-event-iterator object for this music.

PercentEvent

Used internally to signal percent repeats.

Event classes: percent-event, rhythmic-event, music-event and StreamEvent.

Accepted by: Percent_repeat_engraver and Slash_repeat_engraver.

Properties:

name (symbol):
'PercentEvent

Name of this music object.

types (list):
'(general-music event percent-event rhythmic-event)

The types of this music object; determines by what engraver this music expression is processed.

PercentRepeatedMusic

Repeats encoded by percents.

Properties:

name (symbol):
'PercentRepeatedMusic

Name of this music object.

iterator-ctor (procedure):
ly:percent-repeat-iterator::constructor

Function to construct a music-event-iterator object for this music.

start-callback (procedure):
ly:repeated-music::first-start

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

length-callback (procedure):
ly:repeated-music::unfolded-music-length

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

types (list):
'(general-music repeated-music percent-repeated-music)

The types of this music object; determines by what engraver this music expression is processed.

PesOrFlexaEvent

Within a ligature, mark the previous and the following note to form a pes (if melody goes up) or a flexa (if melody goes down).

Event classes: pes-or-flexa-event, music-event and StreamEvent.

Accepted by: Vaticana_ligature_engraver.

Properties:

name (symbol):
'PesOrFlexaEvent

Name of this music object.

types (list):
'(general-music pes-or-flexa-event event)

The types of this music object; determines by what engraver this music expression is processed.

PhrasingSlurEvent

Start or end phrasing slur.

Syntax: note\( and note\)

Event classes: phrasing-slur-event, span-event, music-event and StreamEvent.

Accepted by: Phrasing_slur_engraver.

Properties:

name (symbol):
'PhrasingSlurEvent

Name of this music object.

types (list):
'(general-music span-event event phrasing-slur-event)

The types of this music object; determines by what engraver this music expression is processed.

PropertySet

Set a context property.

Syntax: \property context.prop = scheme-val

Properties:

name (symbol):
'PropertySet

Name of this music object.

types (list):
'(layout-instruction-event general-music)

The types of this music object; determines by what engraver this music expression is processed.

iterator-ctor (procedure):
ly:property-iterator::constructor

Function to construct a music-event-iterator object for this music.

PropertyUnset

Remove the definition of a context \property.

Properties:

name (symbol):
'PropertyUnset

Name of this music object.

types (list):
'(layout-instruction-event general-music)

The types of this music object; determines by what engraver this music expression is processed.

iterator-ctor (procedure):
ly:property-unset-iterator::constructor

Function to construct a music-event-iterator object for this music.

QuoteMusic

Quote preprocessed snippets of music.

Properties:

name (symbol):
'QuoteMusic

Name of this music object.

iterator-ctor (procedure):
ly:music-wrapper-iterator::constructor

Function to construct a music-event-iterator object for this music.

length-callback (procedure):
ly:music-wrapper::length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

start-callback (procedure):
ly:music-wrapper::start-callback

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

types (list):
'(general-music music-wrapper-music)

The types of this music object; determines by what engraver this music expression is processed.

RelativeOctaveCheck

Check if a pitch is in the correct octave.

Properties:

name (symbol):
'RelativeOctaveCheck

Name of this music object.

to-relative-callback (procedure):
ly:relative-octave-check::relative-callback

How to transform a piece of music to relative pitches.

types (list):
'(general-music relative-octave-check)

The types of this music object; determines by what engraver this music expression is processed.

RelativeOctaveMusic

Music that was entered in relative octave notation.

Properties:

name (symbol):
'RelativeOctaveMusic

Name of this music object.

to-relative-callback (procedure):
ly:relative-octave-music::relative-callback

How to transform a piece of music to relative pitches.

iterator-ctor (procedure):
ly:music-wrapper-iterator::constructor

Function to construct a music-event-iterator object for this music.

length-callback (procedure):
ly:music-wrapper::length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

start-callback (procedure):
ly:music-wrapper::start-callback

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

types (list):
'(music-wrapper-music general-music relative-octave-music)

The types of this music object; determines by what engraver this music expression is processed.

RepeatTieEvent

Ties for starting a second volta bracket.

Event classes: repeat-tie-event, music-event and StreamEvent.

Accepted by: Repeat_tie_engraver.

Properties:

name (symbol):
'RepeatTieEvent

Name of this music object.

types (list):
'(general-music event repeat-tie-event)

The types of this music object; determines by what engraver this music expression is processed.

RepeatedMusic

Repeat music in different ways.

Properties:

name (symbol):
'RepeatedMusic

Name of this music object.

types (list):
'(general-music repeated-music)

The types of this music object; determines by what engraver this music expression is processed.

RestEvent

A Rest.

Syntax: r4 for a quarter rest.

Event classes: rest-event, rhythmic-event, music-event and StreamEvent.

Accepted by: Figured_bass_engraver and Rest_engraver.

Properties:

name (symbol):
'RestEvent

Name of this music object.

types (list):
'(general-music event rhythmic-event rest-event)

The types of this music object; determines by what engraver this music expression is processed.

RevertProperty

The opposite of OverrideProperty: remove a previously added property from a graphical object definition.

Properties:

name (symbol):
'RevertProperty

Name of this music object.

types (list):
'(general-music layout-instruction-event)

The types of this music object; determines by what engraver this music expression is processed.

iterator-ctor (procedure):
ly:pop-property-iterator::constructor

Function to construct a music-event-iterator object for this music.

ScriptEvent

Add an articulation mark to a note.

Event classes: script-event, music-event and StreamEvent.

Not accepted by any engraver or performer.

Properties:

name (symbol):
'ScriptEvent

Name of this music object.

types (list):
'(general-music event)

The types of this music object; determines by what engraver this music expression is processed.

SequentialMusic

Music expressions concatenated.

Syntax: \sequential { ... } or simply { ... }

Properties:

name (symbol):
'SequentialMusic

Name of this music object.

length-callback (procedure):
ly:music-sequence::cumulative-length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

start-callback (procedure):
ly:music-sequence::first-start-callback

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

elements-callback (procedure):
#<procedure #f (m)>

Return a list of children, for use by a sequential iterator. Takes a single music parameter.

iterator-ctor (procedure):
ly:sequential-iterator::constructor

Function to construct a music-event-iterator object for this music.

types (list):
'(general-music sequential-music)

The types of this music object; determines by what engraver this music expression is processed.

SimultaneousMusic

Music playing together.

Syntax: \simultaneous { ... } or << ... >>

Properties:

name (symbol):
'SimultaneousMusic

Name of this music object.

iterator-ctor (procedure):
ly:simultaneous-music-iterator::constructor

Function to construct a music-event-iterator object for this music.

start-callback (procedure):
ly:music-sequence::minimum-start-callback

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

length-callback (procedure):
ly:music-sequence::maximum-length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

to-relative-callback (procedure):
ly:music-sequence::simultaneous-relative-callback

How to transform a piece of music to relative pitches.

types (list):
'(general-music simultaneous-music)

The types of this music object; determines by what engraver this music expression is processed.

SkipEvent

Filler that takes up duration, but does not print anything.

Syntax: s4 for a skip equivalent to a quarter rest.

Event classes: skip-event, rhythmic-event, music-event and StreamEvent.

Not accepted by any engraver or performer.

Properties:

name (symbol):
'SkipEvent

Name of this music object.

types (list):
'(general-music event rhythmic-event skip-event)

The types of this music object; determines by what engraver this music expression is processed.

SkipMusic

Filler that takes up duration, does not print anything, and also does not create staves or voices implicitly.

Syntax: \skip duration

Properties:

name (symbol):
'SkipMusic

Name of this music object.

length-callback (procedure):
ly:music-duration-length

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

iterator-ctor (procedure):
ly:simple-music-iterator::constructor

Function to construct a music-event-iterator object for this music.

types (list):
'(general-music event rhythmic-event skip-event)

The types of this music object; determines by what engraver this music expression is processed.

SlurEvent

Start or end slur.

Syntax: note( and note)

Event classes: slur-event, span-event, music-event and StreamEvent.

Accepted by: Slur_engraver and Slur_performer.

Properties:

name (symbol):
'SlurEvent

Name of this music object.

types (list):
'(general-music span-event event slur-event)

The types of this music object; determines by what engraver this music expression is processed.

SoloOneEvent

Print ‘Solo 1’.

Event classes: solo-one-event, part-combine-event, music-event and StreamEvent.

Accepted by: Part_combine_engraver.

Properties:

name (symbol):
'SoloOneEvent

Name of this music object.

part-combine-status (symbol):
'solo1

Change to what kind of state? Options are solo1, solo2 and unisono.

types (list):
'(general-music event part-combine-event solo-one-event)

The types of this music object; determines by what engraver this music expression is processed.

SoloTwoEvent

Print ‘Solo 2’.

Event classes: solo-two-event, part-combine-event, music-event and StreamEvent.

Accepted by: Part_combine_engraver.

Properties:

name (symbol):
'SoloTwoEvent

Name of this music object.

part-combine-status (symbol):
'solo2

Change to what kind of state? Options are solo1, solo2 and unisono.

types (list):
'(general-music event part-combine-event solo-two-event)

The types of this music object; determines by what engraver this music expression is processed.

SostenutoEvent

Depress or release sostenuto pedal.

Event classes: sostenuto-event, pedal-event, span-event, music-event and StreamEvent.

Accepted by: Piano_pedal_engraver and Piano_pedal_performer.

Properties:

name (symbol):
'SostenutoEvent

Name of this music object.

types (list):
'(general-music event pedal-event sostenuto-event)

The types of this music object; determines by what engraver this music expression is processed.

SpacingSectionEvent

Start a new spacing section.

Event classes: spacing-section-event, music-event and StreamEvent.

Accepted by: Spacing_engraver.

Properties:

name (symbol):
'SpacingSectionEvent

Name of this music object.

types (list):
'(general-music event spacing-section-event)

The types of this music object; determines by what engraver this music expression is processed.

SpanEvent

Event for anything that is started at a different time than stopped.

Event classes: span-event, music-event and StreamEvent.

Not accepted by any engraver or performer.

Properties:

name (symbol):
'SpanEvent

Name of this music object.

types (list):
'(general-music event)

The types of this music object; determines by what engraver this music expression is processed.

StaffSpanEvent

Start or stop a staff symbol.

Event classes: staff-span-event, span-event, music-event and StreamEvent.

Accepted by: Staff_symbol_engraver.

Properties:

name (symbol):
'StaffSpanEvent

Name of this music object.

types (list):
'(general-music event span-event staff-span-event)

The types of this music object; determines by what engraver this music expression is processed.

StringNumberEvent

Specify on which string to play this note.

Syntax: \number

Event classes: string-number-event, music-event and StreamEvent.

Accepted by: Fretboard_engraver and Tab_note_heads_engraver.

Properties:

name (symbol):
'StringNumberEvent

Name of this music object.

types (list):
'(general-music string-number-event event)

The types of this music object; determines by what engraver this music expression is processed.

StrokeFingerEvent

Specify with which finger to pluck a string.

Syntax: \rightHandFinger text

Event classes: stroke-finger-event, music-event and StreamEvent.

Accepted by: Fingering_engraver.

Properties:

name (symbol):
'StrokeFingerEvent

Name of this music object.

types (list):
'(general-music stroke-finger-event event)

The types of this music object; determines by what engraver this music expression is processed.

SustainEvent

Depress or release sustain pedal.

Event classes: sustain-event, pedal-event, span-event, music-event and StreamEvent.

Accepted by: Piano_pedal_engraver and Piano_pedal_performer.

Properties:

name (symbol):
'SustainEvent

Name of this music object.

types (list):
'(general-music event pedal-event sustain-event)

The types of this music object; determines by what engraver this music expression is processed.

TextScriptEvent

Print text.

Event classes: text-script-event, script-event, music-event and StreamEvent.

Accepted by: Text_engraver.

Properties:

name (symbol):
'TextScriptEvent

Name of this music object.

types (list):
'(general-music script-event text-script-event event)

The types of this music object; determines by what engraver this music expression is processed.

TextSpanEvent

Start a text spanner, e.g., 8va.....|

Event classes: text-span-event, span-event, music-event and StreamEvent.

Accepted by: Text_spanner_engraver.

Properties:

name (symbol):
'TextSpanEvent

Name of this music object.

types (list):
'(general-music span-event event text-span-event)

The types of this music object; determines by what engraver this music expression is processed.

TieEvent

A tie.

Syntax: note-~

Event classes: tie-event, music-event and StreamEvent.

Accepted by: Tie_engraver and Tie_performer.

Properties:

name (symbol):
'TieEvent

Name of this music object.

types (list):
'(general-music tie-event event)

The types of this music object; determines by what engraver this music expression is processed.

TimeScaledMusic

Multiply durations, as in tuplets.

Syntax: \times fraction music, e.g. \times 2/3 { ... } for triplets.

Properties:

name (symbol):
'TimeScaledMusic

Name of this music object.

length-callback (procedure):
ly:music-wrapper::length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

start-callback (procedure):
ly:music-wrapper::start-callback

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

iterator-ctor (procedure):
ly:time-scaled-music-iterator::constructor

Function to construct a music-event-iterator object for this music.

types (list):
'(time-scaled-music music-wrapper-music general-music)

The types of this music object; determines by what engraver this music expression is processed.

TransposedMusic

Music that has been transposed.

Properties:

name (symbol):
'TransposedMusic

Name of this music object.

iterator-ctor (procedure):
ly:music-wrapper-iterator::constructor

Function to construct a music-event-iterator object for this music.

start-callback (procedure):
ly:music-wrapper::start-callback

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

length-callback (procedure):
ly:music-wrapper::length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

to-relative-callback (procedure):
ly:relative-octave-music::no-relative-callback

How to transform a piece of music to relative pitches.

types (list):
'(music-wrapper-music general-music transposed-music)

The types of this music object; determines by what engraver this music expression is processed.

TremoloEvent

Unmeasured tremolo.

Event classes: tremolo-event, music-event and StreamEvent.

Accepted by: Stem_engraver.

Properties:

name (symbol):
'TremoloEvent

Name of this music object.

types (list):
'(general-music event tremolo-event)

The types of this music object; determines by what engraver this music expression is processed.

TremoloRepeatedMusic

Repeated notes denoted by tremolo beams.

Properties:

name (symbol):
'TremoloRepeatedMusic

Name of this music object.

iterator-ctor (procedure):
ly:chord-tremolo-iterator::constructor

Function to construct a music-event-iterator object for this music.

start-callback (procedure):
ly:repeated-music::first-start

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

length-callback (procedure):
ly:repeated-music::folded-music-length

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

types (list):
'(general-music repeated-music tremolo-repeated-music)

The types of this music object; determines by what engraver this music expression is processed.

TremoloSpanEvent

Tremolo over two stems

Event classes: tremolo-span-event, span-event, music-event and StreamEvent.

Accepted by: Chord_tremolo_engraver.

Properties:

name (symbol):
'TremoloSpanEvent

Name of this music object.

types (list):
'(general-music event span-event tremolo-span-event)

The types of this music object; determines by what engraver this music expression is processed.

TrillSpanEvent

Start a trill spanner tr~~~

Event classes: trill-span-event, span-event, music-event and StreamEvent.

Accepted by: Trill_spanner_engraver.

Properties:

name (symbol):
'TrillSpanEvent

Name of this music object.

types (list):
'(general-music span-event event trill-span-event)

The types of this music object; determines by what engraver this music expression is processed.

TupletSpanEvent

Used internally to signal where tuplet brackets start and stop.

Event classes: tuplet-span-event, span-event, music-event and StreamEvent.

Accepted by: Tuplet_engraver.

Properties:

name (symbol):
'TupletSpanEvent

Name of this music object.

types (list):
'(tuplet-span-event span-event event general-music)

The types of this music object; determines by what engraver this music expression is processed.

UnaCordaEvent

Depress or release una-corda pedal.

Event classes: una-corda-event, pedal-event, span-event, music-event and StreamEvent.

Accepted by: Piano_pedal_engraver and Piano_pedal_performer.

Properties:

name (symbol):
'UnaCordaEvent

Name of this music object.

types (list):
'(general-music event pedal-event una-corda-event)

The types of this music object; determines by what engraver this music expression is processed.

UnfoldedRepeatedMusic

Repeated music which is fully written (and played) out.

Properties:

name (symbol):
'UnfoldedRepeatedMusic

Name of this music object.

iterator-ctor (procedure):
ly:unfolded-repeat-iterator::constructor

Function to construct a music-event-iterator object for this music.

start-callback (procedure):
ly:repeated-music::first-start

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

types (list):
'(general-music repeated-music unfolded-repeated-music)

The types of this music object; determines by what engraver this music expression is processed.

length-callback (procedure):
ly:repeated-music::unfolded-music-length

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

UnisonoEvent

Print ‘a 2’.

Event classes: unisono-event, part-combine-event, music-event and StreamEvent.

Accepted by: Part_combine_engraver.

Properties:

name (symbol):
'UnisonoEvent

Name of this music object.

part-combine-status (symbol):
'unisono

Change to what kind of state? Options are solo1, solo2 and unisono.

types (list):
'(general-music event part-combine-event unisono-event)

The types of this music object; determines by what engraver this music expression is processed.

UnrelativableMusic

Music that cannot be converted from relative to absolute notation. For example, transposed music.

Properties:

name (symbol):
'UnrelativableMusic

Name of this music object.

to-relative-callback (procedure):
ly:relative-octave-music::no-relative-callback

How to transform a piece of music to relative pitches.

iterator-ctor (procedure):
ly:music-wrapper-iterator::constructor

Function to construct a music-event-iterator object for this music.

length-callback (procedure):
ly:music-wrapper::length-callback

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

types (list):
'(music-wrapper-music general-music unrelativable-music)

The types of this music object; determines by what engraver this music expression is processed.

VoiceSeparator

Separate polyphonic voices in simultaneous music.

Syntax: \\

Properties:

name (symbol):
'VoiceSeparator

Name of this music object.

types (list):
'(separator general-music)

The types of this music object; determines by what engraver this music expression is processed.

VoltaRepeatedMusic

Repeats with alternatives placed sequentially.

Properties:

name (symbol):
'VoltaRepeatedMusic

Name of this music object.

iterator-ctor (procedure):
ly:volta-repeat-iterator::constructor

Function to construct a music-event-iterator object for this music.

start-callback (procedure):
ly:repeated-music::first-start

Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.

length-callback (procedure):
ly:repeated-music::volta-music-length

How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.

types (list):
'(general-music repeated-music volta-repeated-music)

The types of this music object; determines by what engraver this music expression is processed.

Music classes

StreamEvent

Music event type StreamEvent is in music objects of type AbsoluteDynamicEvent, AnnotateOutputEvent, ApplyOutputEvent, ArpeggioEvent, ArticulationEvent, BassFigureEvent, BeamEvent, BeamForbidEvent, BendAfterEvent, BreathingEvent, ClusterNoteEvent, CrescendoEvent, DecrescendoEvent, ExtenderEvent, FingeringEvent, GlissandoEvent, HarmonicEvent, HyphenEvent, KeyChangeEvent, LabelEvent, LaissezVibrerEvent, LigatureEvent, LineBreakEvent, LyricEvent, MarkEvent, MultiMeasureRestEvent, MultiMeasureTextEvent, NoteEvent, NoteGroupingEvent, PageBreakEvent, PageTurnEvent, PercentEvent, PesOrFlexaEvent, PhrasingSlurEvent, RepeatTieEvent, RestEvent, ScriptEvent, SkipEvent, SlurEvent, SoloOneEvent, SoloTwoEvent, SostenutoEvent, SpacingSectionEvent, SpanEvent, StaffSpanEvent, StringNumberEvent, StrokeFingerEvent, SustainEvent, TextScriptEvent, TextSpanEvent, TieEvent, TremoloEvent, TremoloSpanEvent, TrillSpanEvent, TupletSpanEvent, UnaCordaEvent and UnisonoEvent.

Not accepted by any engraver or performer.

absolute-dynamic-event

Music event type absolute-dynamic-event is in music objects of type AbsoluteDynamicEvent.

Accepted by: Dynamic_engraver, Dynamic_performer and New_dynamic_engraver.

annotate-output-event

Music event type annotate-output-event is in music objects of type AnnotateOutputEvent.

Accepted by: Balloon_engraver.

apply-output-event

Music event type apply-output-event is in music objects of type ApplyOutputEvent.

Accepted by: Output_property_engraver.

arpeggio-event

Music event type arpeggio-event is in music objects of type ArpeggioEvent.

Accepted by: Arpeggio_engraver.

articulation-event

Music event type articulation-event is in music objects of type ArticulationEvent.

Accepted by: Script_engraver.

bass-figure-event

Music event type bass-figure-event is in music objects of type BassFigureEvent.

Accepted by: Figured_bass_engraver.

beam-event

Music event type beam-event is in music objects of type BeamEvent.

Accepted by: Beam_engraver, Beam_performer and Grace_beam_engraver.

beam-forbid-event

Music event type beam-forbid-event is in music objects of type BeamForbidEvent.

Accepted by: Auto_beam_engraver.

bend-after-event

Music event type bend-after-event is in music objects of type BendAfterEvent.

Accepted by: Bend_engraver.

break-event

Music event type break-event is in music objects of type LineBreakEvent, PageBreakEvent and PageTurnEvent.

Accepted by: Page_turn_engraver and Paper_column_engraver.

breathing-event

Music event type breathing-event is in music objects of type BreathingEvent.

Accepted by: Breathing_sign_engraver.

cluster-note-event

Music event type cluster-note-event is in music objects of type ClusterNoteEvent.

Accepted by: Cluster_spanner_engraver.

crescendo-event

Music event type crescendo-event is in music objects of type CrescendoEvent.

Accepted by: Dynamic_performer.

decrescendo-event

Music event type decrescendo-event is in music objects of type DecrescendoEvent.

Accepted by: Dynamic_performer.

dynamic-event

Music event type dynamic-event is in music objects of type AbsoluteDynamicEvent.

Not accepted by any engraver or performer.

extender-event

Music event type extender-event is in music objects of type ExtenderEvent.

Accepted by: Extender_engraver.

fingering-event

Music event type fingering-event is in music objects of type FingeringEvent.

Accepted by: Fingering_engraver.

glissando-event

Music event type glissando-event is in music objects of type GlissandoEvent.

Accepted by: Glissando_engraver.

harmonic-event

Music event type harmonic-event is in music objects of type HarmonicEvent.

Not accepted by any engraver or performer.

hyphen-event

Music event type hyphen-event is in music objects of type HyphenEvent.

Accepted by: Hyphen_engraver.

key-change-event

Music event type key-change-event is in music objects of type KeyChangeEvent.

Accepted by: Key_engraver and Key_performer.

label-event

Music event type label-event is in music objects of type LabelEvent.

Accepted by: Paper_column_engraver.

laissez-vibrer-event

Music event type laissez-vibrer-event is in music objects of type LaissezVibrerEvent.

Accepted by: Laissez_vibrer_engraver.

layout-instruction-event

Music event type layout-instruction-event is in music objects of type ApplyOutputEvent.

Not accepted by any engraver or performer.

ligature-event

Music event type ligature-event is in music objects of type LigatureEvent.

Accepted by: Ligature_bracket_engraver, Mensural_ligature_engraver and Vaticana_ligature_engraver.

line-break-event

Music event type line-break-event is in music objects of type LineBreakEvent.

Not accepted by any engraver or performer.

lyric-event

Music event type lyric-event is in music objects of type LyricEvent.

Accepted by: Lyric_engraver and Lyric_performer.

mark-event

Music event type mark-event is in music objects of type MarkEvent.

Accepted by: Mark_engraver.

melodic-event

Music event type melodic-event is in music objects of type ClusterNoteEvent and NoteEvent.

Not accepted by any engraver or performer.

multi-measure-rest-event

Music event type multi-measure-rest-event is in music objects of type MultiMeasureRestEvent.

Accepted by: Multi_measure_rest_engraver.

multi-measure-text-event

Music event type multi-measure-text-event is in music objects of type MultiMeasureTextEvent.

Accepted by: Multi_measure_rest_engraver.

music-event

Music event type music-event is in music objects of type AbsoluteDynamicEvent, AnnotateOutputEvent, ApplyOutputEvent, ArpeggioEvent, ArticulationEvent, BassFigureEvent, BeamEvent, BeamForbidEvent, BendAfterEvent, BreathingEvent, ClusterNoteEvent, CrescendoEvent, DecrescendoEvent, ExtenderEvent, FingeringEvent, GlissandoEvent, HarmonicEvent, HyphenEvent, KeyChangeEvent, LabelEvent, LaissezVibrerEvent, LigatureEvent, LineBreakEvent, LyricEvent, MarkEvent, MultiMeasureRestEvent, MultiMeasureTextEvent, NoteEvent, NoteGroupingEvent, PageBreakEvent, PageTurnEvent, PercentEvent, PesOrFlexaEvent, PhrasingSlurEvent, RepeatTieEvent, RestEvent, ScriptEvent, SkipEvent, SlurEvent, SoloOneEvent, SoloTwoEvent, SostenutoEvent, SpacingSectionEvent, SpanEvent, StaffSpanEvent, StringNumberEvent, StrokeFingerEvent, SustainEvent, TextScriptEvent, TextSpanEvent, TieEvent, TremoloEvent, TremoloSpanEvent, TrillSpanEvent, TupletSpanEvent, UnaCordaEvent and UnisonoEvent.

Not accepted by any engraver or performer.

note-event

Music event type note-event is in music objects of type NoteEvent.

Accepted by: Chord_name_engraver, Completion_heads_engraver, Drum_note_performer, Drum_notes_engraver, Fretboard_engraver, Note_heads_engraver, Note_name_engraver, Note_performer and Tab_note_heads_engraver.

note-grouping-event

Music event type note-grouping-event is in music objects of type NoteGroupingEvent.

Accepted by: Horizontal_bracket_engraver.

page-break-event

Music event type page-break-event is in music objects of type PageBreakEvent.

Not accepted by any engraver or performer.

page-turn-event

Music event type page-turn-event is in music objects of type PageTurnEvent.

Not accepted by any engraver or performer.

part-combine-event

Music event type part-combine-event is in music objects of type SoloOneEvent, SoloTwoEvent and UnisonoEvent.

Accepted by: Part_combine_engraver.

pedal-event

Music event type pedal-event is in music objects of type SostenutoEvent, SustainEvent and UnaCordaEvent.

Not accepted by any engraver or performer.

percent-event

Music event type percent-event is in music objects of type PercentEvent.

Accepted by: Percent_repeat_engraver and Slash_repeat_engraver.

pes-or-flexa-event

Music event type pes-or-flexa-event is in music objects of type PesOrFlexaEvent.

Accepted by: Vaticana_ligature_engraver.

phrasing-slur-event

Music event type phrasing-slur-event is in music objects of type PhrasingSlurEvent.

Accepted by: Phrasing_slur_engraver.

repeat-tie-event

Music event type repeat-tie-event is in music objects of type RepeatTieEvent.

Accepted by: Repeat_tie_engraver.

rest-event

Music event type rest-event is in music objects of type RestEvent.

Accepted by: Figured_bass_engraver and Rest_engraver.

rhythmic-event

Music event type rhythmic-event is in music objects of type BassFigureEvent, ClusterNoteEvent, LyricEvent, MultiMeasureRestEvent, NoteEvent, PercentEvent, RestEvent and SkipEvent.

Not accepted by any engraver or performer.

script-event

Music event type script-event is in music objects of type ArticulationEvent, ScriptEvent and TextScriptEvent.

Not accepted by any engraver or performer.

skip-event

Music event type skip-event is in music objects of type SkipEvent.

Not accepted by any engraver or performer.

slur-event

Music event type slur-event is in music objects of type SlurEvent.

Accepted by: Slur_engraver and Slur_performer.

solo-one-event

Music event type solo-one-event is in music objects of type SoloOneEvent.

Not accepted by any engraver or performer.

solo-two-event

Music event type solo-two-event is in music objects of type SoloTwoEvent.

Not accepted by any engraver or performer.

sostenuto-event

Music event type sostenuto-event is in music objects of type SostenutoEvent.

Accepted by: Piano_pedal_engraver and Piano_pedal_performer.

spacing-section-event

Music event type spacing-section-event is in music objects of type SpacingSectionEvent.

Accepted by: Spacing_engraver.

span-dynamic-event

Music event type span-dynamic-event is in music objects of type CrescendoEvent and DecrescendoEvent.

Accepted by: Dynamic_engraver and New_dynamic_engraver.

span-event

Music event type span-event is in music objects of type BeamEvent, CrescendoEvent, DecrescendoEvent, LigatureEvent, PhrasingSlurEvent, SlurEvent, SostenutoEvent, SpanEvent, StaffSpanEvent, SustainEvent, TextSpanEvent, TremoloSpanEvent, TrillSpanEvent, TupletSpanEvent and UnaCordaEvent.

Not accepted by any engraver or performer.

staff-span-event

Music event type staff-span-event is in music objects of type StaffSpanEvent.

Accepted by: Staff_symbol_engraver.

string-number-event

Music event type string-number-event is in music objects of type StringNumberEvent.

Accepted by: Fretboard_engraver and Tab_note_heads_engraver.

stroke-finger-event

Music event type stroke-finger-event is in music objects of type StrokeFingerEvent.

Accepted by: Fingering_engraver.

sustain-event

Music event type sustain-event is in music objects of type SustainEvent.

Accepted by: Piano_pedal_engraver and Piano_pedal_performer.

text-script-event

Music event type text-script-event is in music objects of type TextScriptEvent.

Accepted by: Text_engraver.

text-span-event

Music event type text-span-event is in music objects of type TextSpanEvent.

Accepted by: Text_spanner_engraver.

tie-event

Music event type tie-event is in music objects of type TieEvent.

Accepted by: Tie_engraver and Tie_performer.

tremolo-event

Music event type tremolo-event is in music objects of type TremoloEvent.

Accepted by: Stem_engraver.

tremolo-span-event

Music event type tremolo-span-event is in music objects of type TremoloSpanEvent.

Accepted by: Chord_tremolo_engraver.

trill-span-event

Music event type trill-span-event is in music objects of type TrillSpanEvent.

Accepted by: Trill_spanner_engraver.

tuplet-span-event

Music event type tuplet-span-event is in music objects of type TupletSpanEvent.

Accepted by: Tuplet_engraver.

una-corda-event

Music event type una-corda-event is in music objects of type UnaCordaEvent.

Accepted by: Piano_pedal_engraver and Piano_pedal_performer.

unisono-event

Music event type unisono-event is in music objects of type UnisonoEvent.

Not accepted by any engraver or performer.

Music properties

X-offset (number)
Offset of resulting grob; only used for balloon texts.
Y-offset (number)
Offset of resulting grob; only used for balloon texts.
absolute-octave (integer)
The absolute octave for a octave check note.
alteration (number)
Alteration for figured bass.
articulation-type (string)
Key for script definitions alist.

TODO: Consider making type into symbol.

articulations (list of music)
Articulation events specifically for this note.
associated-context (string)
Name of the Voice context associated with this \newaddlyrics section.
augmented (boolean)
This figure is for an augmented figured bass (with + sign).
augmented-slash (boolean)
This figure is for an augmented figured bass (back-slashed number).
bass (boolean)
Set if this note is a bass note in a chord.
bracket-start (boolean)
Start a bracket here.

TODO: Use SpanEvents?

bracket-stop (boolean)
Stop a bracket here.
break-penalty (number)
Penalty for line break hint.
break-permission (symbol)
Whether to allow, forbid or force a line break.
cautionary (boolean)
If set, this alteration needs a cautionary accidental.
change-to-id (string)
Name of the context to change to.
change-to-type (symbol)
Type of the context to change to.
compress-procedure (procedure)
Compress this music expression. Arg 1: the music, arg 2: factor.
context-id (string)
Name of context.
context-type (symbol)
Type of context.
create-new (boolean)
Create a fresh context.
delta-step (number)
How much should a fall change pitch?
denominator (integer)
Denominator in a time signature.
descend-only (boolean)
If set, this \context only descends in the context tree.
digit (integer)
Digit for fingering.
diminished (boolean)
This bass figure should be slashed.
direction (direction)
Print this up or down?
drum-type (symbol)
Which percussion instrument to play this note on.
duration (duration)
Duration of this note or lyric.
element (music)
The single child of a Music_wrapper music object, or the body of a repeat.
elements (list of music)
A list of elements for sequential of simultaneous music, or the alternatives of repeated music.
elements-callback (procedure)
Return a list of children, for use by a sequential iterator. Takes a single music parameter.
error-found (boolean)
If true, a parsing error was found in this expression.
expected-beam-count (integer)
Expected number of non-tremolo beams in a tremolo repeat.
figure (integer)
A bass figure.
force-accidental (boolean)
If set, a cautionary accidental should always be printed on this note.
grob-property (symbol)
The symbol of the grob property to set.
grob-property-path (list)
A list of symbols, locating a nested grob property, e.g., (beamed-lengths details).
grob-value (any type)
The value of the grob property to set.
input-tag (any type)
Arbitrary marker to relate input and output.
inversion (boolean)
If set, this chord note is inverted.
iterator-ctor (procedure)
Function to construct a music-event-iterator object for this music.
label (markup)
Label of a mark.
last-pitch (pitch)
The last pitch after relativization.
length (moment)
The duration of this music.
length-callback (procedure)
How to compute the duration of this music. This property can only be defined as initializer in scm/define-music-types.scm.
line-break-permission (symbol)
When the music is at top-level, whether to allow, forbid or force a line break.
metronome-count (number)
How many beats in a minute?
name (symbol)
Name of this music object.
no-continuation (boolean)
If set, disallow continuation lines.
numerator (integer)
Numerator of a time signature.
octavation (integer)
This pitch was octavated by how many octaves? For chord inversions, this is negative.
once (boolean)
Apply this operation only during one time step?
origin (input location)
Where was this piece of music defined?
page-break-permission (symbol)
When the music is at top-level, whether to allow, forbid or force a page break.
page-label (symbol)
The label of a page marker.
page-marker (boolean)
If true, and the music expression is found at top-level, a page marker object is instanciated instead of a score.
page-turn-permission (symbol)
When the music is at top-level, whether to allow, forbid or force a page turn.
parenthesize (boolean)
Enclose resulting objects in parentheses?
part-combine-status (symbol)
Change to what kind of state? Options are solo1, solo2 and unisono.
pitch (pitch)
The pitch of this note.
pitch-alist (list)
A list of pitches jointly forming the scale of a key signature.
pop-first (boolean)
Do a revert before we try to do a override on some grob property.
prob-property (symbol)
The symbol of the prob property to set.
procedure (procedure)
The function to run with \applycontext. It must take a single argument, being the context.
property-operations (list)
Do these operations for instantiating the context.
quoted-context-id (string)
The ID of the context to direct quotes to, e.g., cue.
quoted-context-type (symbol)
The name of the context to direct quotes to, e.g., Voice.
quoted-events (vector)
A vector of with moment and event-list entries.
quoted-music-name (string)
The name of the voice to quote.
quoted-transposition (pitch)
The pitch used for the quote, overriding \transposition.
quoted-voice-direction (direction)
Should the quoted voice be up-stem or down-stem?
repeat-count (integer)
Do a \repeat how often?
span-direction (direction)
Does this start or stop a spanner?
span-type (string)
What kind of spanner should be created?

TODO: Consider making type into symbol.

split-list (list)
Splitting moments for part combiner.
start-callback (procedure)
Function to compute the negative length of starting grace notes. This property can only be defined as initializer in scm/define-music-types.scm.
string-number (integer)
The number of the string in a StringNumberEvent.
symbol (symbol)
Grob name to perform an override or revert on.
tags (list)
List of symbols that for denoting extra details, e.g., \tag #'part ... could tag a piece of music as only being active in a part.
tempo-unit (duration)
The unit for the metronome count.
text (markup)
Markup expression to be printed.
text-type (symbol)
Particular type of text script (e.g., finger, dynamic).
to-relative-callback (procedure)
How to transform a piece of music to relative pitches.
tonic (pitch)
Base of the scale.
tremolo-type (integer)
Speed of tremolo, e.g., 16 for c4:16.
trill-pitch (pitch)
Pitch of other note of the trill.
tweaks (list)
An alist of properties to override in the backend for the grob made of this event.
type (symbol)
The type of this music object. Determines iteration in some cases.
types (list)
The types of this music object; determines by what engraver this music expression is processed.
untransposable (boolean)
If set, this music is not transposed.
value (any type)
Assignment value for a translation property.
void (boolean)
If this property is #t, then the music expression is to be discarded by the toplevel music handler.
what (symbol)
What to change for auto-change.

FIXME: Naming.

Translation

Contexts

ChoirStaff

Identical to StaffGroup except that the contained staves are not connected vertically.

This context creates the following layout object(s):

SystemStartBar, SystemStartBrace, SystemStartBracket and SystemStartSquare.

This context sets the following properties:

Context ChoirStaff can contain Staff, InnerStaffGroup, InnerChoirStaff, ChordNames, Lyrics, PianoStaff, GrandStaff, RhythmicStaff and DrumStaff.

This context is built from the following engraver(s):

System_start_delimiter_engraver
Create a system start delimiter (i.e., a SystemStartBar, SystemStartBrace, SystemStartBracket or SystemStartSquare spanner).

Properties (read)

systemStartDelimiter (symbol)
Which grob to make for the start of the system/staff? Set to SystemStartBrace, SystemStartBracket or SystemStartBar.
systemStartDelimiterHierarchy (pair)
A nested list, indicating the nesting of a start delimiters.
currentCommandColumn (layout object)
Grob that is X-parent to all current breakable (clef, key signature, etc.) items.

This engraver creates the following layout object(s):

SystemStartBar, SystemStartBrace, SystemStartBracket and SystemStartSquare.

ChordNames

Typesets chord names.

This context creates the following layout object(s):

ChordName, StaffSpacing and VerticalAxisGroup.

This context sets the following properties:

This context is a `bottom' context; it cannot contain other contexts.

This context is built from the following engraver(s):

Hara_kiri_engraver
Like Axis_group_engraver, but make a hara-kiri spanner, and add interesting items (i.e., note heads, lyric syllables, and normal rests).

Properties (read)

keepAliveInterfaces (list)
A list of symbols, signifying grob interfaces that are worth keeping a staff with remove-empty set around for.

This engraver creates the following layout object(s):

VerticalAxisGroup.

Skip_event_swallow_translator
Swallow \skip.
Chord_name_engraver
Catch note events and generate the appropriate chordname.

Music types accepted:

note-event

Properties (read)

chordChanges (boolean)
Only show changes in chords scheme?
chordNameExceptions (list)
An alist of chord exceptions. Contains (chord . markup) entries.
chordNameFunction (procedure)
The function that converts lists of pitches to chord names.
chordNoteNamer (procedure)
A function that converts from a pitch object to a text markup. Used for single pitches.
chordRootNamer (procedure)
A function that converts from a pitch object to a text markup. Used for chords.
chordNameExceptions (list)
An alist of chord exceptions. Contains (chord . markup) entries.
majorSevenSymbol (markup)
How should the