
Provide lyrics for songs in an album by delivering documents called lyrics files. Lyrics files are formatted according to the TTML format, with extensions for features specific to the Apple implementation. Each document contains the lyrics for one song. For each <track> tag in the metadata.xml file, specify the lyrics file using the <lyrics_file> tag. See Basic Music Album Metadata Example for information on how to deliver the lyrics file.
Note: You cannot deliver lyrics for music videos.
Lyrics files can specify line-by-line lyrics or beat-by-beat lyrics:
For annotations on the XML formats, see Lyrics Example Annotations.
Note: You can still send lyrics in plain text format using the <lyrics> tag, however, sending lyrics in HTML format is being deprecated.
The following sections briefly describe the standard TTML content elements for lyrics. Throughout this chapter, the symbol
indicates an Apple implementation or recommendation.
The basic structure of a song is based on the standard TTML content elements.
Lyrics Content | TTML Element | Use |
|---|---|---|
Song |
| The |
Paragraphs |
| A
|
Lines |
| A
|
Word or Phrase |
| A |
Song Parts: To distinguish between song parts, add the itunes:song-part attribute to a <div> block to note its compositional purpose in the song.
Example: <div itunes:song-part="Chorus">
You can use any value you want for the itunes:song-part attribute, but Apple recommends the following values:
Verse
Chorus
PreChorus
Bridge
Intro
Outro
Refrain
Instrumental
Note: Currently, song parts are not displayed to the users.
Add the ttm:agent attribute to any <p> and <span> element to indicate which artist is performing the contents.
Optionally add timing to the lyrics so that the lyrics can be synchronized to the timing of the words sung by the singers, like the display of lyrics in a sing-along.
Add timing to the <p> tag for line-by-line timing. For an example of line-by-line timing, see Line-by-Line Lyrics Example XML Delivery.
Add timing to the <span> tag for beat-by-beat timing of words or phases. For an example of beat-by-beat timing, see Beat-by-Beat Lyrics Example XML Delivery.
A time value is expressed as a Synchronized Multimedia Integration Language (SMIL) full or partial clock-value:
(Hours ":")? Minutes ":" Seconds ("." Fraction up to 3 digits)?
Specifying hours and fractions of seconds is optional (as indicated by the ?).
Rules for timing
Where timing occurs, you must specify both the begin and end attributes.
All time codes must be valid.
The begin time code must be before the end time code in the same element.
Time codes of sub-elements must be within the time codes of the parent element.
Time codes must be within the duration of song.
The timing of <div> elements must not overlap, regardless of any ttm:agent attribute.
White space in the document is processed according to rules defined by [XML 1.0], §2.10, White Space Handling.
Apple strongly recommends that you adhere to the xml:space="default" rules and refrain from specifying XML whitespace handling attributes.