data/effects/timer.xml

0001 <?xml version="1.0"?>
0002 <!DOCTYPE kpartgui>
0003 <effect tag="timer" id="timer">
0004     <name>Timer</name>
0005     <description>Overlay a timer onto the video</description>
0006     <author>Guillaume Papin</author>
0007     <parameter type="animatedrect" name="geometry" default="0 0 100% 100%" fixed="0">
0008         <name>Geometry</name>
0009     </parameter>
0010     <parameter type="fontfamily" name="family" default="DejaVu Sans">
0011         <name>Font Family</name>
0012     </parameter>
0013     <parameter type="list" name="style" default="normal" paramlist="normal;italic">
0014         <name>Font Style</name>
0015     </parameter>
0016     <parameter type="constant" name="size" max="200" min="8" default="48">
0017         <name>Font Size</name>
0018     </parameter>
0019     <parameter type="constant" name="weight" max="900" min="100" default="400">
0020         <name>Font Weight</name>
0021     </parameter>
0022     <parameter type="color" name="fgcolour" default="0x000000ff" alpha="1">
0023         <name>Foreground Color</name>
0024     </parameter>
0025     <parameter type="color" name="bgcolour" default="0x00000020" alpha="1">
0026         <name>Background Color</name>
0027     </parameter>
0028     <parameter type="color" name="olcolour" default="0x00000000" alpha="1">
0029         <name>Outline Color</name>
0030     </parameter>
0031     <parameter type="constant" name="outline" max="3" min="0" default="0">
0032         <name>Outline Width</name>
0033     </parameter>
0034     <parameter type="constant" name="pad" max="500" min="0" default="0">
0035         <name>Padding</name>
0036     </parameter>
0037     <parameter type="list" name="halign" default="left" paramlist="left;center;right">
0038         <paramlistdisplay>Left,Center,Right</paramlistdisplay>
0039         <name>Horizontal Alignment</name>
0040     </parameter>
0041     <parameter type="list" name="valign" default="top" paramlist="top;middle;bottom">
0042         <paramlistdisplay>Top,Middle,Bottom</paramlistdisplay>
0043         <name>Vertical Alignment</name>
0044     </parameter>
0045     <parameter type="list" name="format" default="SS.SS" paramlist="HH:MM:SS;HH:MM:SS.S;MM:SS;MM:SS.SS;MM:SS.SSS;SS;SS.S;SS.SS;SS.SSS">
0046         <name>Format</name>
0047         <paramlistdisplay>HH:MM:SS,HH:MM:SS.S,MM:SS,MM:SS.SS,MM:SS.SSS,SS,SS.S,SS.SS,SS.SSS</paramlistdisplay>
0048     </parameter>
0049     <parameter type="position" name="start" max="1000000" min="0" default="0" totime="true">
0050         <name>Start</name>
0051         <comment><![CDATA[The time that the timer will start counting up or down.
0052 The text will be frozen at 00:00:00.000 from the start of the filter until the start time has elapsed.]]></comment>
0053     </parameter>
0054     <parameter type="position" name="duration" max="1000000" min="0" default="%out" totime="true" relative="true">
0055         <name>Duration</name>
0056         <comment><![CDATA[The maximum elapsed duration of the timer after the start time has elapsed.
0057 The text will be frozen at the duration time after the duration has elapsed.]]></comment>
0058     </parameter>
0059     <parameter type="position" name="offset" max="1000000" min="0" default="0" totime="true" relative="true">
0060         <name>Offset</name>
0061         <comment><![CDATA[An offset to be added to the timer value.
0062 When the direction is "down", the timer will count down to "offset" instead of 00:00:00.000.
0063 When the direction is up, the timer will count up starting from "offset".]]></comment>
0064     </parameter>
0065     <parameter type="list" name="direction" default="up" paramlist="up;down">
0066         <name>Direction</name>
0067         <comment>
0068             <![CDATA[Whether the counter should count up from 00:00:00.000 or down from the duration time.]]>
0069         </comment>
0070     </parameter>
0071 </effect>