<title>HowTo create your own skin</title>
<copyright>
-<year>2004-2006</year>
+<year>2004-2010</year>
<holder>
the VideoLAN project
</holder>
<para>Only used in animated bitmaps; it is the number of frames (images) per seconds of the animation. (since VLC 0.8.5)</para>
<para>Default value: 0</para>
</sect3>
+ <sect3 id="bitmaploop">
+ <title>loop</title>
+ <para>Only used in animated bitmaps; it is the number of loops before animation stops. Default value 0 means animation doesn't stop. Otherwise, animation stops on the last frame after the number of loops has been reached (since VLC 1.1)</para>
+ <para>Default value: 0</para>
+ </sect3>
</sect2>
<title>fps</title>
<para>Same as in <link linkend="bitmapfps">Bitmap</link> tag.</para>
</sect3>
+ <sect3 id="subbitmaploop">
+ <title>loop</title>
+ <para>Same as in <link linkend="bitmaploop">Bitmap</link> tag.</para>
+ </sect3>
</sect2>
<title>id</title>
<para>Name of the window (it may be used for actions). Two windows cannot have the same id.</para>
<para>Default value: none</para>
+ <para>As of vlc1.1, a special id has been added to provide a skinnable fullscreen controller. This value id="fullscreenController" allows the window to be displayed only in fullscreen mode. Display is toggled by pressing the 'i' hotkey or clicking the mouse middle button</para>
</sect3>
<sect3 id="windowvisible">
<title>visible</title>
<sect3 id="imageresize">
<title>resize</title>
<para>Since VLC 0.8.2. Specify the behaviour of the image when it is resized. Possible values are 'mosaic' (the image is repeated as many times as necessary to reach the wanted dimensions) and 'scale' (the image is actually rescaled). Beware that the 'scale' behaviour is much slower than the 'mosaic' one, so make sure to use it only when it's really needed.</para>
+ <para>In future VLC 1.2. a third value 'scale2' is available to scale an image, yet preserving its aspect ratio. The image is centered and scaled either heightwise or widthwise to fill up as much area as possible. Extra borders are made transparent.</para>
<para>Default value: mosaic.</para>
</sect3>
<sect3 id="imageaction">
<para>Action triggered by a double-click on the control. See <link linkend="actions">Actions</link> for a list of possible actions. (Since VLC 0.8.5).</para>
<para>Default value: none</para>
</sect3>
+ <sect3 id="imageart">
+ <title>art</title>
+ <para>if set to true, the skin engine reuses the control to display the art file of the resource currently being played back. Usually, resize="scale2" is desirable, for art to be rendered in the best possible way. (in future VLC 1.2).</para>
+ <para>Default value: false</para>
+ </sect3>
</sect2>
<sect2 id="Button">
<listitem><para>
<emphasis>vlc.snapshot()</emphasis>: Take a snapshot (since VLC 0.8.5).
</para></listitem>
+ <listitem><para>
+ <emphasis>vlc.toggleRecord()</emphasis>: Start/Stop recording (since VLC 1.1).
+ </para></listitem>
+ <listitem><para>
+ <emphasis>vlc.nextFrame()</emphasis>: Advance one frame at a time (since VLC 1.1).
+ </para></listitem>
<listitem><para>
<emphasis>vlc.onTop()</emphasis>: Toggle the "Always on top" status (since VLC 0.8.0).
</para></listitem>
<listitem><para>
<emphasis>vlc.isSeekable</emphasis>: True when the stream is seekable, false otherwise. This one can be used if you want to display a slider only when seeking is allowed.
</para></listitem>
+ <listitem><para>
+ <emphasis>vlc.canRecord</emphasis>: True if the stream can be recorded, false otherwise. (since vlc1.1)
+ </para></listitem>
+ <listitem><para>
+ <emphasis>vlc.isRecording</emphasis>: True if the stream is being recorded, false otherwise. (since vlc1.1)
+ </para></listitem>
<listitem><para>
<emphasis>vlc.isMute</emphasis>: True when the sound is mute (in VLC, not on your OS), false otherwise.
</para></listitem>
<para>A box inside a container box always defines how it should react when its container box is resized. Two different mechanisms are provided: corners anchoring (useful when resizing of the inner box is wanted, for example) and constant ratio (mainly useful to keep the inner box centered inside its parent):</para>
<itemizedlist>
<listitem><para>
- <emphasis>corners anchoring</emphasis>: The top-left-hand corner (TL) and the bottom-right-hand corner (BR) of the inner box are "tied" to corners of the container box (TL, TR, BL or BR). When any resizing occurs, tied corners move together, which can move or resize the inner box. For example, if the TL corner of the inner box is tied to the TL corner of the container (let's write it TL/TL), and if the BR corner of the inner box is also tied to the TL corner of the container box (BR/TL), the inner box will not be resized, and will always stay at the same place (this is the default behaviour). If we have TL/TL and TL/BL, the inner box is resized vertically when its container is resized. If we have TL/TR and BR/TR, the inner box moves with the TR corner of its container. We could even define TL/BR and BR/TL, in which case increasing the size of the container box would shrink the size of the inner box... until it disappears completely!
+ <emphasis>corners anchoring</emphasis>: The top-left-hand corner (TL) and the bottom-right-hand corner (BR) of the inner box are "tied" to corners of the container box (TL, TR, BL or BR). When any resizing occurs, tied corners move together, which can move or resize the inner box. For example, if the TL corner of the inner box is tied to the TL corner of the container (let's write it TL/TL), and if the BR corner of the inner box is also tied to the TL corner of the container box (BR/TL), the inner box will not be resized, and will always stay at the same place (this is the default behaviour). If we have TL/TL and BR/BL, the inner box is resized vertically when its container is resized. If we have TL/TR and BR/TR, the inner box moves with the TR corner of its container. We could even define TL/BR and BR/TL, in which case increasing the size of the container box would shrink the size of the inner box... until it disappears completely!
</para>
<para>This mechanism is controlled by the <link linkend="lefttop">lefttop</link> and <link linkend="rightbottom">rightbottom</link> attributes of the controls.
</para></listitem>
projects / vlc / blobdiff