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 video 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.

FPP commands can be executed at embedded and ActionScript cue points.

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="/panos/video/Sam.flv"movie url - see info below
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 <cuepoints>, in which you can specify a number of <cuepoint> tags.
The <cuepoint> tags can have the following attributes:
namename="CP1"cue point name, optional - see embedded cue points below
timetime="36.3"cue point time in seconds
commandcommand="pano.pan=0,3000"command to execute when cue point is reached


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
seek(cp)reposition video playhead at cue point named cp
   or
seek(time)reposition video playhead at given time (in seconds with up to 3 decimals)
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



NOTES:

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

When specifying the video url, please note that you either have to specify a path from the directory where pano.swf is stored, or an absolute path (beginning with a "/"). This is due to the way the Flash component FLVPlayback in this plugin uses the "source" property.

Mask and overlay path is specified as usual - i.e. from the current directory (where your html file is stored).

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.

As scale can be set individually for each video, the plugin will always send a scale="nn" command to FPP before each video starts. This of course means that any scale value set in your hotspot will be overwritten.

If a mask is used, the video will be resized to fill the width or height of the mask.

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.

If your video has embedded cue points to which you want to add FPP commands, just specify a <cuepoint> tag with the name of the embedded cue point but without the time="..." attribute. Or - if you can edit the embedded cue points directly - add a "cmd=FPP-command" name-value pair to the cue point parameters.

There are two kinds of embedded cue points: "Event", that are supposed to trigger an action, and "Navigation" that are inserted for navigation purposes. The "seek(cp)" command only works with "Navigation" type cue points, but if you are not able to insert your own cue points, you can always use the "seek(time)" command instead.

If you're using the seek(cp) command to a cue point added in the xml (not embedded), be sure to name it with the name="..." attribute.

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

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" >
         <cuepoints>
            <cuepoint time="11" command="global.showp1()" />
            <cuepoint time="22" command="global.showp2()" />
            <cuepoint time="32" command="global.showp3()" />
            <cuepoint time="38" command="global.showp4()" />
         </cuepoints>
      </movie>
   </program>
</moviebox>
						


Version history:

1.9.2:
Fix for making the plugin work with Adobe Flash Player "Square"

1.9.1:
Fixed bug when embedded cue point doesn't have "parameters" or "cmd" attribute.

1.9:
seek() command added to restart video from a certain cue point or time.

1.8:
Support for embedded cue points added.
<quepoints> -> <cuepoints>

1.7.1:
Modified timing code to make video start quicker.

1.7:
Added "autorewind" attribute.
Adde "rewind" command.

1.6:
Modified unload function: makes video stop loading if plugin hotspot is unloaded.

1.5:
Added "repeat" attribute for each .

1.4:
Added "onComplete" attribute for each and also for the tag.

1.3:
The "autoplay" attribute in the tag was added to enable movies to be played individually.
Commands "autoplay(n)" and "goto(id)" added for the same reason.
Also, plugin is set to visible=false when no movie is playing.

1.2.1:
Fixed bug when going fullscreen

1.2:
Added support for cue points.

1.1:
Commands added: start, stop and pause.
Fixed bug when hotspot was reloaded after changing pano.
If no tooltip is used (on any film) an empty tooltip bubble will not be shown.