countdown.swf
FPP hotspot plugin for displaying a count-down or count-up clock.The clock can be used to count down from or up to a time of your own choice, or to count down to a target date/time.
When the date/time target (or zero) has been reached, the plugin can execute FPP commands of your own choice.
The following hotspot attributes are supported:
In plugin external xml file, the following tags and attributes can be used:
The following commands can be used in the hotspot command="..." attribute:
NOTES: Local time is always used, but the clock can handle if daylight savings time (DST) is turned on/off between the current time and the target time. In the plugin XML file, use the <target> tag if you want to countdown to a certain date/time (like for example New Year's Eve). With the <duration> tag you can set the clock to count down from or count up to a given number of hours, minutes and seconds. The plugin is monitoring the hotspot command="..." attribute. Use this attribute to dynamically set target date/time or duration, onZero command and to start/stop the clock. When a target date/time is used for countdown, the clock automatically starts counting down, but when a certain time (duration) is set to count up to or down from, you have to start the clock manually. The clock font can be specified by a normal font name as "Arial" or "Trebuchet MS" - or by the number of an embedded font (1-5). By using them, you can be certain that the clock looks the same in the viewers PC as in your own.
Example plugin XML file for countdown to a target date/time:
Example plugin XML file for countdown a certain duration:
Version history:
| xmlFile | xmlFile="cd1.xml" | plugin configuration file, default "countdown.xml" |
| command | command="start" | commands for handling the plugin clock, see below |
In plugin external xml file, the following tags and attributes can be used:
| Use the <target> tag to count down to a certain date/time: | ||
| year | year="2011" | target year, default=next year |
| month | month="1" | target month (1-12), default=1 |
| day | day="1" | target day (1-31), default=1 |
| time | time="00:00:00" | target time, default="00:00:00" |
| valid formats: "hh", "hh:mm" or "hh:mm:ss" | ||
| onZero or onTarget | onTarget="global.hideSpot5" | FPP command(s) to execute when countdown is complete |
| Use the <duration> tag to specify a count-up/down time: | ||
| direction | direction="up" | countdown time, format: "hh:mm:ss", "mm:ss" or "ss" |
| time | time="8:30" | countdown time, format: "hh:mm:ss", "mm:ss" or "ss" |
| onZero or onTarget | onTarget="global.showP12" | FPP command(s) to execute when count-up/down is complete |
| The <style> tag is used to specify the visual attributes of the clock: | ||
| font | font="3" | font name, default="Arial", see below |
| size | size="64" | font size, default=16 |
| color | color="#FFFFFF" | font color, default=#000000 |
| bgColor | bgColor="#000000" | background color, default=transparent |
| frameColor | frameColor="#0000FF" | frame color, default=no frame |
| showSeconds | showSeconds="0" | 0=don't show seconds, 1=show seconds, default=1 |
The following commands can be used in the hotspot command="..." attribute:
| start | start | start the clock |
| stop | stop | stop the clock |
| setClock | setClock(15:00) | set time to count up to or down from, |
| valid formats: "hh:mm:ss", "mm:ss" or "ss" | ||
| setTarget | setTarget(2011:1:1:00:00:00) | set target date/time, format must be |
| YYYY:MM:DD:hh:mm:ss | ||
| onZero or onTarget | onTarget(global.showSign) | FPP command(s) to execute when count-up/down is complete |
NOTES: Local time is always used, but the clock can handle if daylight savings time (DST) is turned on/off between the current time and the target time. In the plugin XML file, use the <target> tag if you want to countdown to a certain date/time (like for example New Year's Eve). With the <duration> tag you can set the clock to count down from or count up to a given number of hours, minutes and seconds. The plugin is monitoring the hotspot command="..." attribute. Use this attribute to dynamically set target date/time or duration, onZero command and to start/stop the clock. When a target date/time is used for countdown, the clock automatically starts counting down, but when a certain time (duration) is set to count up to or down from, you have to start the clock manually. The clock font can be specified by a normal font name as "Arial" or "Trebuchet MS" - or by the number of an embedded font (1-5). By using them, you can be certain that the clock looks the same in the viewers PC as in your own.
Example plugin XML file for countdown to a target date/time:
<?xml version = '1.0'?>
<countdown>
<target
year="2011"
month="1"
day="1"
time="00:00:00"
/>
<style
font="3"
size="64"
color="#000044"
bgColor=""
frameColor=""
showSeconds="1"
/>
</countdown>
<?xml version = '1.0'?>
<countdown>
<duration
time="1:00:00"
onTarget="fullscreen()"
/>
<style
font="3"
size="64"
color="#000044"
bgColor=""
frameColor=""
showSeconds="1"
/>
</countdown>
Version history:
2.1:
The clock can now also be used to count up to a certain time (as a stopwatch). 2.0:
The clock can now also be used to count down a certain time.
Support for dynamically starting and stopping clock.
Support for dynamically setting target date/time or countdown time.
Support for dynamically setting onZero command(s).
Reporting plugin width to FPP only when width has changed. 1.1.1:
Reporting plugin width to FPP every second to make sure all digits are visible. 1.1:
Clock stops at 00:00:00 when countdown has passed target date and time.
The clock can now also be used to count up to a certain time (as a stopwatch). 2.0:
The clock can now also be used to count down a certain time.
Support for dynamically starting and stopping clock.
Support for dynamically setting target date/time or countdown time.
Support for dynamically setting onZero command(s).
Reporting plugin width to FPP only when width has changed. 1.1.1:
Reporting plugin width to FPP every second to make sure all digits are visible. 1.1:
Clock stops at 00:00:00 when countdown has passed target date and time.