The event lyric line object
Type: Dictionary
This encodes a single lyric syllable within a single lyric line (i.e., a single verse).
Attributes
| Name | Type | Required? | Description |
|---|---|---|---|
| event lyric line extender | No | Specifies that this syllable has an extender line (also called a word extension), indicating that the syllable is sustained beyond this event. To explicitly specify that this syllable has no extender line, use {"show": false}. If not provided, the meaning depends on the document's useLyricExtenders value. If useLyricExtenders is true, this should be interpreted as {"show": false}. If it is false (the default), consuming software should determine whether the syllable has an extender line according to its own logic. |
|
| string | Yes | The text of the syllable. This might be an empty string in the case of lyrics that are skipped for a given verse. |
|
| event lyric line type | 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". |
Plus globally available attributes: _c, _x, id
Parent objects
This object is used by the following parent objects:
- lyrics: "lines"
Examples
This object is used in the following examples: