API:banners.xml

From TvDBwiki

The banners.xml file holds a list of all of the series and season banners associated with the series.

[edit] Explanation of Fields

BannerPath

Can be appended to <mirrorpath>/banners/ to determine the actual location of the artwork.

BannerType

This can be series, season, poster, or fanart. Denotes if the banner applies to the series as a whole (and if it's a wide format, poster, or fan art image) or to a specific season.

BannerType2

This can be text, graphical, or blank for series banners. It can be season or seasonwide for season banners. If will be the resolution of the image for fan art. Blank banners will leave the title and show logo off the banner. Text banners will show the series name as plain text in an Arial font. Graphical banners will show the series name in the show's official font or will display the actual logo for the show. Season banners are the standard DVD cover format while wide season banners will be the same dimensions as the series banners.

Language

Some banners list the series name in a foreign language. The language abbreviation will be listed here.

Season

If the banner is for a specific season, that season number will be listed here.

VignettePath

Can be appended to <mirrorpath>/banners/ to determine the location of the vignette version of fan art. All automatic vignettes are upper-left format.

ThumbnailPath

Fan art is quite large in size. Instead of downloading all of the full resolution fan art files to display to your users, please download and display the thumbnail so they can choose their artwork from those. Responsiveness in your application will be greatly improved and you'll be reducing bandwidth for the server and users. This thumbnail image can be appended to <mirrorpath>/banners/ for its actual location. All thumbnail images are 300px wide and under 20kb (as opposed to 500+kb for full art).

Colors

These are the colors selected by the artist that match the image. The format is 3 colors separated by a pipe "|". This field has leading and trailing pipes. Each color is comma separated RGB, with each color portion being an integer from 1 to 255. So the format looks like |r,g,b|r,g,b|r,g,b|. The first color is the light accent color. The second color is the dark accent color. The third color is the neutral mid-tone color.

[edit] Example Results

<?xml version="1.0" encoding="UTF-8" ?>
<Banners>
   <Banner>
      <id>20106</id>
      <BannerPath>fanart/original/73739-1.jpg</BannerPath>
      <VignettePath>fanart/vignette/73739-1.jpg</VignettePath>
      <ThumbnailPath>_cache/fanart/original/73739-1.jpg</ThumbnailPath>
      <BannerType>fanart</BannerType>
      <BannerType2>1920x1080</BannerType2>
      <Colors>|68,69,59|69,70,58|78,78,68|</Colors>
      <Language>en</Language>
   </Banner>
   <Banner>
      <id>18953</id>
      <BannerPath>seasons/73739-2-2.jpg</BannerPath>
      <BannerType>season</BannerType>
      <BannerType2>season</BannerType2>
      <Language>es</Language>
      <Season>2</Season>
   </Banner>
   <Banner>
      <id>9529</id>
      <BannerPath>graphical/73739-g.jpg</BannerPath>
      <BannerType>series</BannerType>
      <BannerType2>graphical</BannerType2>
      <Language>en</Language>
   </Banner>
</Banners>