The event lyric line object

Type: Dictionary

This encodes a single lyric syllable within a single lyric line (i.e., a single verse).

Keys:

Name Type Required? Description
"text" string object Yes The text of the syllable.

This might be an empty string in the case of lyrics that are skipped for a given verse.
"type" event lyric line type object No Specifies the syllable's part of the word: "start", "middle", "end" or "whole". If not provided, the default value is "whole".

Generally software uses this data to determine whether to put a hyphen after a syllable, if space is available. The data can also be used to inform synthesized vocal audio playback.

Note: The hyphen character itself should not be encoded within "text".

Examples

This object is used in the following examples:

Lyrics (basic), Lyrics (multi-line)