Timed (Advertisement-) Overlays

Introduction

Projekktor supports dynamic graphic- and text- overlays for video items. Programming them is done through external XML files. Their structure is quite similar to the Timed Text (TT) XML standard. To specify an overlay-XML-file for any video item set the overlays item variable.

Structure

For a new overlay add a div container to the XML´s body. The properties begin and end are obligatory. If the img property is not set and also no text is contained within the div the specific container will be ignored. On the other side it is possible to set the img property OR the text only OR even both.

property	value	example	purpose	note
begin	6 digits time format	00:00:03	sec. of playback to start overlay	required
end	6 digits time format	00:00:06	sec. of playback to end overlay	required, must be greater than begin
valign	top, bottom, middle OR an numeric value	top	vertical overlay alignment within video area	default is middle
align	left, right, middle OR an numeric value	left	horizontal overlay alignment within video area	default is center
bgcolor	hex color code	0xFBB64F	fills the overlay background with the specified color	optional
img	name of file residing in directory set through path_overlays config variable	super.swf	JPG, PNG, GIF or SWF file to use as overlay	optional
dest_url	any full qualified URL	http://www.projekktor.com	makes the overlay clickable and will open a share popup for the specified URL then	this feature is only available for PRO or PRO+ versions
size	some positive numeric value	15	sets the font-size of the overlay text	default is 24

Sample:

<adv>
  <head>     
    <layout/>
  </head>
  <body>
    <div xml:id="adv">
      <div begin="00:00:03" end="00:00:6" valign="bottom" align="right">simple text overlay test</div>
      <div begin="00:00:08" end="00:00:11" valign="top" align="right" bgcolor="0xFBB64F">overlay test with BG color</div>
      <div begin="00:00:12" end="00:00:15" valign="top" align="left" img="super.swf"></div>
    </div>
  </body>
</adv>