From 917555567e3bb1f160ec732f495aef0e618e706a Mon Sep 17 00:00:00 2001 From: Erwan Tulou Date: Wed, 19 May 2010 23:10:54 +0200 Subject: [PATCH] skins2: update documentation with new features for vlc1.1 and vlc1.2 These features include for vlc11 - new variables : vlc.canRecord and vlc.isRecording - new functions : vlc.toggleRecord() and vlc.nextFrame() - a new 'loop' parameter for animated bitmaps - a special id="fullscreenController" for Window, intended to be used as a skinnable fullscreen controller for vlc12 - a new 'art' parameter for image control - a new 'scale2' value for resize parameter of image control --- doc/skins/skins2-howto.xml | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/doc/skins/skins2-howto.xml b/doc/skins/skins2-howto.xml index 5ad8c5c42b..71b0446d85 100644 --- a/doc/skins/skins2-howto.xml +++ b/doc/skins/skins2-howto.xml @@ -10,7 +10,7 @@ HowTo create your own skin -2004-2006 +2004-2010 the VideoLAN project @@ -176,6 +176,11 @@ difficulty to understand how VLC skins work. Only used in animated bitmaps; it is the number of frames (images) per seconds of the animation. (since VLC 0.8.5) Default value: 0 + + loop + 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) + Default value: 0 + @@ -216,6 +221,10 @@ difficulty to understand how VLC skins work. fps Same as in Bitmap tag. + + loop + Same as in Bitmap tag. + @@ -266,6 +275,7 @@ difficulty to understand how VLC skins work. id Name of the window (it may be used for actions). Two windows cannot have the same id. Default value: none + 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 visible @@ -491,6 +501,7 @@ difficulty to understand how VLC skins work. resize 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. + 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. Default value: mosaic. @@ -503,6 +514,11 @@ difficulty to understand how VLC skins work. Action triggered by a double-click on the control. See Actions for a list of possible actions. (Since VLC 0.8.5). Default value: none + + art + 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). + Default value: false + @@ -934,6 +950,12 @@ difficulty to understand how VLC skins work. vlc.snapshot(): Take a snapshot (since VLC 0.8.5). + + vlc.toggleRecord(): Start/Stop recording (since VLC 1.1). + + + vlc.nextFrame(): Advance one frame at a time (since VLC 1.1). + vlc.onTop(): Toggle the "Always on top" status (since VLC 0.8.0). @@ -1093,6 +1115,12 @@ difficulty to understand how VLC skins work. vlc.isSeekable: 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. + + vlc.canRecord: True if the stream can be recorded, false otherwise. (since vlc1.1) + + + vlc.isRecording: True if the stream is being recorded, false otherwise. (since vlc1.1) + vlc.isMute: True when the sound is mute (in VLC, not on your OS), false otherwise. -- 2.39.2