Documentation Archive

Developer

Apple TV Markup Language Reference

On This Page

Compound Banner and Header Elements

Compound banner and header elements provide initial descriptive information for other of elements.

banner

The banner element is used to display information along the top of a template app page. banner can contain the following elements:

banner can be a subelement of:

Listing 21-1 shows an example of a banner element.

Listing 21-1banner example TVML
  1. <banner>
  2. <background>
  3. <img src="" />
  4. </background>
  5. <title>Video Gallery</title>
  6. <button>
  7. <title>Play all</title>
  8. </button>
  9. </banner>

footer

The footer element displays additional information that describes its containing element. The information is displayed at the bottom of the containing element. footer can contain the following elements:

footer can be a subelement of:

Listing 21-2 shows an example of a footer element.

Listing 21-2footer example TVML
  1. <footer>
  2. <text>Text</text>
  3. </footer>

header

The header element displays information that is used to describe the contents of the section it is contained in. header can contain the following elements:

header can be a subelement of:

Listing 21-3 shows an example of a header element.

Listing 21-3header example TVML
  1. <header>
  2. <title>Title</title>
  3. <description>Description</description>
  4. </header>

identityBanner

The identityBanner element displays information along the top of the screen that is used to briefly describe an artist or performer. identityBanner can contain the following elements:

identityBanner can be a subelement of:

Listing 21-4 shows an example of an identityBanner element.

Listing 21-4identityBanner example TVML
  1. <identityBanner>
  2. <title>Title</title>
  3. <subtitle>Subtitle</subtitle>
  4. <row>
  5. <buttonLockup>
  6. <badge src=""/>
  7. <title>Title 1</title>
  8. </buttonLockup>
  9. <buttonLockup>
  10. <badge src=""/>
  11. <title>Title 2</title>
  12. </buttonLockup>
  13. </row>
  14. </identityBanner>

itemBanner

The itemBanner element is used to display information along the top of the element in which it is contained. itemBanner can contain the following elements:

itemBanner can be a subelement of:

Listing 21-5 shows an example of an itemBanner element.

Listing 21-5itemBanner example TVML
  1. <itemBanner>
  2. <img />
  3. <row>
  4. <buttonLockup>
  5. <text>Text</text>
  6. </buttonLockup>
  7. </row
  8. </itemBanner>

segmentBarHeader

The segmentBarHeader element displays information that is used to describe the contents of a segmentBar element. segmentBarHeader can contain the following elements:

segmentBarHeader can be a subelement of:

Listing 21-6 shows an example of a segmentBarHeader element.

Listing 21-6segmentBarHeader example TVML
  1. <segmentBarHeader>
  2. <title>Title</title>
  3. <subtitle>Subtitle</subtitle>
  4. <segmentBar>
  5. <segmentBarItem>
  6. <title>Title</title>
  7. </segmentBarItem>
  8. </segmentBar>
  9. </segmentBarHeader>