Introduction

This page describes how to configure the overlay XML configuration file and the properties associated with it.

To enable this feature you should set the following properties:

imagetype.xmlOverlay=true
imagetype.xmlOverlayFile=filename.xml

Instead of skin(-user).properties the overlay settings can be put in overlay.properties (resources folder). It is possible to define a resources folder different to the default one. That can be especially useful for eversion skins. E.g. if overlay XMLs and images are in "/skins/eversion/resources/skin-name":

# skin directory
mjb.skin.dir=./skins/eversion
#set relation of overlay.dir (def:true); true = skin root, false = YAMJ root
mjb.overlay.skinroot=true
# place of overlay xml files and overlay.properties:
mjb.overlay.dir=./resources/skin-name
# place of overlay xml resources (overlay images, default overlay PNGs, dummy images):
mjb.overlay.resources=.

Example 1

Overlay-example.xml

Example 2

Overlay-example_2.xml Overlay-data_2.xml

File format

<overlay>
 <layer>
  <name>ParamName1</name>
  <images>
   <image value="true" filename="image1.png"/>
  </images>
 </layer>
 <layer after="true">
  <name>ParamName2/ParamName3</name>
  <left>-1</left>
  <top>23</top>
  <align>center</align>
  <valign>bottom</valign>
  <images>
   <image name="ParamName2" value="true/true" filename="image2.png"/>
   <image name="ParamName2" value="true/false" filename="image3.png"/>
   <image name="ParamName2" value="false/true" filename="image4.png"/>
   <image name="ParamName3" value="true" filename="image5.png"/>
  </images>
  <positions>
   <position value="true/true" align="right/left"/>
  </positions>
 </layer>
</overlay>

Details

• <layer> - each overlay layer (required)
• after - indicates the time when the paint layer: before or after applying the basic overlay (optional, def: false).
• <name> - parameter name (one - required, more divided slash - optional)
• set - true, false, number(if ImageType.logoSet=count)
• TV - true, false
• HD - true, false
• subtitle, ST - true, false
• watched - true, false
• top250 - true, false
• language - not use tag <images>
• rating - 0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100 (or real number [0..100] if ImageType.rating=real)
• videosource, source, VS - text value corresponding <videoSource>
• videoout, out, VO - text value corresponding <videoOutput>
• videocodec, vcodec, V? - text value corresponding <videoCodec>
• audiocodec, acodec, A? - text value corresponding <audioCodec>
• audiochannels, channels - text value corresponding <audioChannels>
• container - text value corresponding <container>
• aspect - text value corresponding <aspect>
• fps - text value corresponding <fps>
• certification - text value corresponding <certification>
• keywords - text value in the movie filename
• country - text value corresponding <country>
• company - text value corresponding <company>
• award - according to ImageType.award
• true - true/false
• block - award names
• count - number of awards won
• <left> - horizontal offset (optional, integer, def: 0)
• <top> - vertical offset (optional, integer, def: 0)
• <align> - horizontal align (optional, [left, center, right], def: left)
• <valign> - vertical align (optional, [top, center, bottom], def: top)
• <image> - image file (required)
• name - parameter name (optional, def: first parameter)
• value - parameter value corresponding his name (see tag <name>). may be use value "default" if no more matched (required)
• filename - image filename (required)
• <position> - parameters of the mutual arrangement (optional)
• value - parameter`s value (required)
• left - horizontal offsets (optional, def: from tag <left>)
• top - vertical offsets (optional, def: from tag <top>)
• align - horizontal aligns (optional, def: from tag <align>)
• valign - vertical aligns (optional, def: from tag <align>)
• <block> - each named block
• <name> - parameter name
• <dir> - true(vertical)/false(horizontal)
• <size> - auto/static
• <cols> - auto/<number>
• <rows> - auto/<number>
• <hmargin> - <number>
• <vmargin> - <number>

Properties

These properties enable or disable (default) the logos that can be used for each of the image types.

ImageType can be one of "posters", "banners", "thumbnails" or "videoimages"

• ImageType.xmlOverlayFile
• The filename for the overlay configuration file. Default is overlay-default.xml

For next options default value is false, set to true to enable.

• ImageType.xmlOverlay
• ImageType.logoSet - value count to use number of movies
• ImageType.logoHD
• ImageType.logoTV
• ImageType.logoSet
• ImageType.logoSubTitle
• ImageType.language
• ImageType.rating - value real to use real numbers of rating
• ImageType.videosource
• ImageType.videoout
• ImageType.videocodec
• ImageType.audiocodec - value block to use all data, instead first
• ImageType.audiochannels - value block to use all data, instead first
• ImageType.container
• ImageType.aspect
• ImageType.fps
• ImageType.certification
• ImageType.watched
• ImageType.top250
• ImageType.keywords
• ImageType.country - value block to use all data, instead first
• ImageType.company - value block to use all data, instead first
• ImageType.award - value block to use all data, count to use number of awards

Values ??can be combined with keywords using the parameters:

overlay.keywords.rating, overlay.keywords.videosource, overlay.keywords.videoout, overlay.keywords.videocodec, overlay.keywords.audiocodec, overlay.keywords.audiochannels, overlay.keywords.container, overlay.keywords.aspect, overlay.keywords.fps, overlay.keywords.certification, overlay.keywords.keywords, overlay.keywords.country, overlay.keywords.company, overlay.keywords.award

paramName=keyword1 / synonym1_1 / synonym1_2 ; keyword2 / synonym2_1

Footer images

The imagetype "Footer" (videoname.{footername}.png) shows a video's mediainfo as graphical elements and are exclusively generated by xmlOverlay functions.

They don't contain any artwork (thumbnail, poster, banner ...) and can be positioned independently from artwork (e.g. in indexes).

How to use:

To turn it on, use YAMJ skin-properties:

# number of footers to create
mjb.footer.count=2
# enable or disable footer
mjb.footer.0.enable=true
mjb.footer.1.enable=true
# set footer token name
mjb.footer.0.name=footername1
mjb.footer.1.name=footername2

mjb.forceFooterOverwrite=true

If no footer token name is set, it's footer.0, footer.1, etc.

Create an overlay XML file ({footername}.xml) and together with OverlayXML like for the other imagetypes:

footername1.format=png
footername1.width=450
footername1.height=50
footername1.videoout=true
footername1.container=true
...
footername1.overlay=false
footername1.xmlOverlay=true
footername1.xmlOverlayFile=footer.xml