The lyrics object

Type: Dictionary

This contains the lyric data for a given event. Typically this correponds to a single sung syllable.

Keys:

Name Type Required? Description
"lines" An object with user-defined keys, where each value is a event lyric line object No A data structure representing all of the event's lyric lines (e.g., for multiple verses). This is encoded as an object in which the keys are user-defined strings (such as "1", "2" or "A") and the values are event lyric line objects.

These user-defined strings are effectively document-scoped IDs of the lyric lines. All lyric lines that appear together should have the same ID in the document.

Examples

This object is used in the following examples:

Lyrics (basic), Lyrics (multi-line)