Home -> FPP plugins page -> moviebox.swf
This plugin is completely free for use in any context or connection.
moviebox.swf
FPP hotspot plugin for showing flv movie files. A mask can be used to select what parts of the movie that will be shown, and also an overlay image to give the movie a suitable framing. You can also set up a sequence of movies that will be shown with variable pauses.
The following hotspot parameters are supported in FPP xml file:

xmlfilexmlFile=moviebox.xmlplugin control XML file


In plugin external xml file, the following tag names are used (see example below):

The top tag is named <moviebox> and it has no attributes.

Child tags are:
<masks>where mask images are defined and loaded
<overlays>where overlay images are defined and loaded
<program>where you specify movie files to be shown


In the <masks> tag you can specify a number of <mask> childtags, where the following attributes are supported:
idid="lion"mask id
urlurl="img/lion_mask.png"url of mask file
In the <overlays> tag you can specify a number of <overlay> childtags, where the following attributes are supported:
idid="leaves"overlay id
urlurl="img/leaves_over.png"url of overlay file
The <program> tag supports the following attributes:
autoplayautoplay="0"autoplay="1" will start playing the movie
program automatically, default=1
autorewindautorewind="1"1=rewinds movie when stopped, default=0
repeatrepeat="5"number of program repetitions, default=1 (0=forever)
onCompleteonComplete="global.endProg()"FPP command to be executed at end of program
clickModeclickMode="pause"defines action when a movie is clicked:
"pause": movie pause/play
"command": <movie> command is executed
default: movie pause/play if no <movie> command is present
In the <program> tag you can specify a number of <movie> childtags, where the following attributes are supported:
pausepause="3.5"pause before movie starts
idid="Sam"movie id (as reference for "goto(id)" command)
urlurl="img/Sam.flv"movie url
repeatrepeat="2"number of movie repetitions, default=1 (0=forever)
scalescale="0.75"hotspot scale for this movie
maskmask="lion"choose mask for this movie
mScalemScale="0.9"mask scale
overlayoverlay="leaves"choose overlay for this movie
oScaleoScale="0.8"overlay scale
tooltiptooltip="Hotel Bellevue"movie mouse-over tooltip
shadowshadow="1"show drop-down shadow (default 0)
command or
onClickonClick="pano.pan=0,3000"command to execute when movie is clicked
onCompleteonComplete="global.endMovie()"FPP command to be executed at end of movie
(see clickMode attribute above)
The <movie> tag can also contain the childtag <quepoints>, in which you can specify a number of <quepoint> tags.
The <quepoint> tags can have the following attributes:
timetime="36"quepoint time in seconds
commandcommand="pano.pan=0,3000"command to execute when quepoint is reached



NOTES:

All tag names must be written in lower case, but attribute names are case independent (bgColor is equal to bgcolor).

If the "autoplay" attribute in the <program> tag is set to autoplay="0" the movie program will not start playing automatically. Individual movies can then be played with the "goto(id)" or the "next" commands. Default is autoplay="1".

When a video is shown without mask and overlay the size will be the original video size, unless the scale parameter is set.

If a mask is used, the video will be resized, so that the mask will always be filled.

If an overlay is used, the video (and the mask) will be repositioned to the center of the overlay.

If you want a video to repeat itself endlessly, just set its repeat="0". The pause="n" will NOT be executed between repetitions.

You can have as many que points as you like, and the time specified for a que point always refers to that particular place in the movie. So if the movie is paused, then the que point will be pushed forwards in elapsed time.


Plugin commands:
The plugin is also checking the hotspot command="..." parameter, in which the following commands are supported:

startstart movie
stopstop movie
pausepause movie
rewindrewind movie
nextjump to next movie
goto(id)goto and play movie with id="id"
autoplay(n)n=0 or 1, set autoplay off/on
execexecute the current movie command
vol-decrease sound volume
vol+increase sound volume


Example plugin external xml file:
<?xml version = '1.0'?>
<moviebox>
   <masks>
      <mask id="lion" url="images/lion2.png" />
      <mask id="leaves" url="images/leaves2S_mask.png" />
   </masks>
   <overlays>
      <overlay id="leaves" url="images/leaves2_over.png" />
   </overlays>
   <program autoplay="1" repeat="0" clickMode="pause" onComplete="global.showMsgP()">
      <movie 
         pause="2"
         url="/panos/Flash/moviebox/images/Mio.flv" 
         scale="0.6"
         mask="leaves" 
         overlay="leaves" 
         oScale="1"
         tooltip="This movie uses a mask\n and an overlay"
         shadow="1"
         onClick="pano.pan=0,3000;pano.tilt=15,3000"
         onComplete="global.showMsg()"
      />
      <movie 
         pause="2"
         url="/panos/Flash/moviebox/images/Basshunter.flv" 
         mask="lion" 
         tooltip="Here I am using a mask only"
      />
      <movie url="/panos/Flash/moviebox/images/Toto.flv" >
         <quepoints>
            <quepoint time="11" command="global.showp1()" />
            <quepoint time="22" command="global.showp2()" />
            <quepoint time="32" command="global.showp3()" />
            <quepoint time="38" command="global.showp4()" />
         </quepoints>
      </movie>
   </program>
</moviebox>