* skins2: Added the vlc.snapshot() action

[vlc] / doc / skins / skins2-howto.xml

diff --git a/doc/skins/skins2-howto.xml b/doc/skins/skins2-howto.xml
index f2e2a8ab803dcb8c848950ed44217de9691ecbb1..99bfa03a7feb6af5f2e61c64bb5871cf4488bb4c 100644 (file)
--- a/doc/skins/skins2-howto.xml
+++ b/doc/skins/skins2-howto.xml
@@ -745,6 +745,10 @@ difficulty to understand how VLC skins work.</para>
     <para>A flat playtree will work like old-style playlists.</para>
     <para>Default value: false</para>
   </sect4>
+  <sect4 id="itemimage">
+    <title>itemimage</title>
+    <para>Identifiant of a <link linkend="Bitmap">Bitmap</link> shown to the left of a leaf (playlist item).</para>
+ </sect4>
   <sect4 id="openimage">
     <title>openimage</title>
     <para>Identifiant of a <link linkend="Bitmap">Bitmap</link> shown to the left of a node, when it is expanded.</para>
@@ -793,11 +797,23 @@ difficulty to understand how VLC skins work.</para>
   <listitem><para>
     <emphasis>dialogs.fileInfo()</emphasis>: Show the "File Info" dialog box.
   </para></listitem>
+  <listitem><para>
+    <emphasis>dialogs.playlist()</emphasis>: Show the "standard" (not skinned) playlist dialog.
+  </para></listitem>
   <listitem><para>
     <emphasis>dialogs.streamingWizard()</emphasis>: Show the "Streaming Wizard" dialog box (new after VLC 0.8.2).
   </para></listitem>
   <listitem><para>
-    <emphasis>dialogs.popup()</emphasis>: Show the popup menu, (already available with a right-click on a <link linkend="Image">Image</link> control).
+    <emphasis>dialogs.popup()</emphasis>: Show the full popup menu, (already available with a right-click on a <link linkend="Image">Image</link> control).
+  </para></listitem>
+  <listitem><para>
+    <emphasis>dialogs.audioPopup()</emphasis>: Show the audio settings popup menu (since VLC 0.8.5).
+  </para></listitem>
+   <listitem><para>
+    <emphasis>dialogs.videoPopup()</emphasis>: Show the video settings popup menu (since VLC 0.8.5).
+  </para></listitem>
+  <listitem><para>
+    <emphasis>dialogs.miscPopup()</emphasis>: Show a popup menu containing playback control and general options (since VLC 0.8.5).
   </para></listitem>
   <listitem><para>
     <emphasis>equalizer.enable()</emphasis>: Enable the equalizer audio filter (since VLC 0.8.5).
@@ -832,6 +848,9 @@ difficulty to understand how VLC skins work.</para>
   <listitem><para>
     <emphasis>vlc.fullscreen()</emphasis>: Toggle the fullscreen mode.
   </para></listitem>
+  <listitem><para>
+    <emphasis>vlc.snapshot()</emphasis>: Take a snapshot (since VLC 0.8.5).
+  </para></listitem>
   <listitem><para>
     <emphasis>vlc.onTop()</emphasis>: Toggle the "Always on top" status (since VLC 0.8.0).
   </para></listitem>
@@ -917,7 +936,7 @@ difficulty to understand how VLC skins work.</para>
 
 <itemizedlist>
   <listitem><para>
-    <emphasis>$B</emphasis>: Get the stream bitrate (in kb/s).
+    <emphasis>$B</emphasis>: Get the audio stream bitrate (in kb/s).
   </para></listitem>
   <listitem><para>
     <emphasis>$V</emphasis>: Value of the volume (from 0 to 100 --> useful for a percentage).
@@ -944,6 +963,9 @@ difficulty to understand how VLC skins work.</para>
   <listitem><para>
     <emphasis>$F</emphasis>: Full name (with path) of the stream that is being played.
   </para></listitem>
+  <listitem><para>
+    <emphasis>$S</emphasis>: Get the audio sample rate (in kHz).
+  </para></listitem>
 </itemizedlist>
 
 <para>Example of <link linkend="slidertooltiptext">tooltiptext</link> value for a slider controlling the volume: "Volume: $V%".</para>
@@ -964,6 +986,9 @@ difficulty to understand how VLC skins work.</para>
   <listitem><para>
     <emphasis>vlc.hasVout</emphasis>: True if a video is being played (since VLC 0.8.5).
   </para></listitem>
+  <listitem><para>
+    <emphasis>vlc.hasAudio</emphasis>: True if audio is being played (since VLC 0.8.5).
+  </para></listitem>
   <listitem><para>
     <emphasis>vlc.isFullscreen</emphasis>: True when the video is in fullscreen mode (since VLC 0.8.5).
   </para></listitem>
@@ -995,7 +1020,7 @@ difficulty to understand how VLC skins work.</para>
     <emphasis>playlist.isRepeat</emphasis>: True when the current playlist item is being repeated, false otherwise (since VLC 0.8.0).
   </para></listitem>
   <listitem><para>
-          <emphasis>dvd.isActive</emphasis>: True when a DVD is currently playing. This variable can be used to display buttons associated to the <link linkend="dvdactions">dvd.* actions</link> only when needed (since VLC 0.8.5).
+   <emphasis>dvd.isActive</emphasis>: True when a DVD is currently playing. This variable can be used to display buttons associated to the <link linkend="dvdactions">dvd.* actions</link> only when needed (since VLC 0.8.5).
   </para></listitem>
   <listitem><para>
     <emphasis>window_name.isVisible</emphasis>: True when the window whose <link linkend="windowid">id</link> is "window_name" is visible, false otherwise.