annotate DOCS/skin.html @ 5331:6bab0f8a75e4

Fix aspect info for square pixel.
author atmos4
date Mon, 25 Mar 2002 09:52:15 +0000
parents b190d3e9427c
children b85d324d4503
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1982
b190d3e9427c init version
pontscho
parents:
diff changeset
1 <html>
b190d3e9427c init version
pontscho
parents:
diff changeset
2 <head>
b190d3e9427c init version
pontscho
parents:
diff changeset
3 <meta http-equiv=Content-Type content="text/html; charset=iso-8859-1">
b190d3e9427c init version
pontscho
parents:
diff changeset
4 <title>MPlayer skin format</title>
b190d3e9427c init version
pontscho
parents:
diff changeset
5 <style type="text/css">
b190d3e9427c init version
pontscho
parents:
diff changeset
6 em.note {color: green}
b190d3e9427c init version
pontscho
parents:
diff changeset
7 em.warn {color: red}
b190d3e9427c init version
pontscho
parents:
diff changeset
8 </style>
b190d3e9427c init version
pontscho
parents:
diff changeset
9 </head>
b190d3e9427c init version
pontscho
parents:
diff changeset
10
b190d3e9427c init version
pontscho
parents:
diff changeset
11 <body bgcolor=white text=black>
b190d3e9427c init version
pontscho
parents:
diff changeset
12
b190d3e9427c init version
pontscho
parents:
diff changeset
13 <h1 align="center">MPlayer skin format</h1>
b190d3e9427c init version
pontscho
parents:
diff changeset
14
b190d3e9427c init version
pontscho
parents:
diff changeset
15 <hr>
b190d3e9427c init version
pontscho
parents:
diff changeset
16
b190d3e9427c init version
pontscho
parents:
diff changeset
17 <h2>Contents</h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
18
b190d3e9427c init version
pontscho
parents:
diff changeset
19 <ul type=disc>
b190d3e9427c init version
pontscho
parents:
diff changeset
20 <li><a href="#intro">1 Introduction</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
21 <li><a href="#overview">2 Overview</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
22 <ul type=circle>
b190d3e9427c init version
pontscho
parents:
diff changeset
23 <li><a href="#dirs">2.1 Directories</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
24 <li><a href="#images">2.2 Images</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
25 <li><a href="#parts">2.3 Parts of a skin</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
26 <li><a href="#files">2.4 Files</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
27 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
28 <li><a href="#skin">3 The <code>skin</code> file</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
29 <ul type=circle>
b190d3e9427c init version
pontscho
parents:
diff changeset
30 <li><a href="#mainwin">3.1 Main window</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
31 <li><a href="#subwindow">3.2 Subwindow</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
32 <li><a href="#skinmenu">3.3 Skin menu</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
33 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
34 <li><a href="#fonts">4 Fonts</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
35 <ul type=circle>
b190d3e9427c init version
pontscho
parents:
diff changeset
36 <li><a href="#symbols">4.1 Symbols</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
37 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
38 <li><a href="#guimsg">Appendix A: GUI messages</a></li>
b190d3e9427c init version
pontscho
parents:
diff changeset
39 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
40
b190d3e9427c init version
pontscho
parents:
diff changeset
41 <hr>
b190d3e9427c init version
pontscho
parents:
diff changeset
42
b190d3e9427c init version
pontscho
parents:
diff changeset
43 <div align=center>
b190d3e9427c init version
pontscho
parents:
diff changeset
44 Last modified: Sep 10, 2001
b190d3e9427c init version
pontscho
parents:
diff changeset
45 </div>
b190d3e9427c init version
pontscho
parents:
diff changeset
46
b190d3e9427c init version
pontscho
parents:
diff changeset
47 <hr>
b190d3e9427c init version
pontscho
parents:
diff changeset
48
b190d3e9427c init version
pontscho
parents:
diff changeset
49 <h2><a name="intro">1 Introduction</a></h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
50
b190d3e9427c init version
pontscho
parents:
diff changeset
51 The purpose of this document is to describe the MPlayer skin format.
b190d3e9427c init version
pontscho
parents:
diff changeset
52 The information contained here might be wrong, for <em>a)</em> it is not me
b190d3e9427c init version
pontscho
parents:
diff changeset
53 who wrote the GUI, <em>b)</em> the GUI is not finished, <em>c)</em> I might
b190d3e9427c init version
pontscho
parents:
diff changeset
54 be wrong. So do not be surprised if something does not work as described here.
b190d3e9427c init version
pontscho
parents:
diff changeset
55
b190d3e9427c init version
pontscho
parents:
diff changeset
56 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
57 Thanks to <em>Zoltán Ponekker</em> for his help.
b190d3e9427c init version
pontscho
parents:
diff changeset
58
b190d3e9427c init version
pontscho
parents:
diff changeset
59 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
60 <em>András Mohari &lt;mayday@freemail.hu&gt;</em>
b190d3e9427c init version
pontscho
parents:
diff changeset
61
b190d3e9427c init version
pontscho
parents:
diff changeset
62
b190d3e9427c init version
pontscho
parents:
diff changeset
63 <h2><a name="overview">2 Overview</a></h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
64
b190d3e9427c init version
pontscho
parents:
diff changeset
65 It does not really have anything to do with the skin format, but you should
b190d3e9427c init version
pontscho
parents:
diff changeset
66 know that <em>MPlayer has <b>no</b> builtin skin, so <b>at least one skin
b190d3e9427c init version
pontscho
parents:
diff changeset
67 must be installed in order to be able to use the GUI.</b></em>
b190d3e9427c init version
pontscho
parents:
diff changeset
68
b190d3e9427c init version
pontscho
parents:
diff changeset
69
b190d3e9427c init version
pontscho
parents:
diff changeset
70 <h3><a name="dirs">2.1 Directories</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
71
b190d3e9427c init version
pontscho
parents:
diff changeset
72 The directories searched for skins are (in order):
b190d3e9427c init version
pontscho
parents:
diff changeset
73 <pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
74 /usr/local/share/mplayer/Skin/
b190d3e9427c init version
pontscho
parents:
diff changeset
75 ~/.mplayer/Skin/
b190d3e9427c init version
pontscho
parents:
diff changeset
76 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
77
b190d3e9427c init version
pontscho
parents:
diff changeset
78 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
79 Note that the first path may vary according to the way MPlayer was configured
b190d3e9427c init version
pontscho
parents:
diff changeset
80 (see the <code>--datadir</code> argument of the <code>configure</code>
b190d3e9427c init version
pontscho
parents:
diff changeset
81 script).
b190d3e9427c init version
pontscho
parents:
diff changeset
82
b190d3e9427c init version
pontscho
parents:
diff changeset
83 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
84 Every skin is installed into its own directory under one of the directories
b190d3e9427c init version
pontscho
parents:
diff changeset
85 listed above, for example:
b190d3e9427c init version
pontscho
parents:
diff changeset
86 <pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
87 /usr/local/share/mplayer/Skin/default/
b190d3e9427c init version
pontscho
parents:
diff changeset
88 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
89
b190d3e9427c init version
pontscho
parents:
diff changeset
90
b190d3e9427c init version
pontscho
parents:
diff changeset
91 <h3><a name="images">2.2 Image formats</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
92
b190d3e9427c init version
pontscho
parents:
diff changeset
93 Images must be truecolor (24 or 32 bpp) and can be in
b190d3e9427c init version
pontscho
parents:
diff changeset
94 BMP, PNG and TGA format (note that TGA images must be uncompressed).
b190d3e9427c init version
pontscho
parents:
diff changeset
95 <em>The preferred format is PNG as it compresses very well.</em>
b190d3e9427c init version
pontscho
parents:
diff changeset
96
b190d3e9427c init version
pontscho
parents:
diff changeset
97 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
98 In the main window (see below) you can use images with `transparency':
b190d3e9427c init version
pontscho
parents:
diff changeset
99 regions filled with the color #FF00FF (<font color="#FF00FF">magenta</font>)
b190d3e9427c init version
pontscho
parents:
diff changeset
100 are fully transparent when viewed by MPlayer. This means that you can even
b190d3e9427c init version
pontscho
parents:
diff changeset
101 have shaped windows if your X server has the XShape extension.
b190d3e9427c init version
pontscho
parents:
diff changeset
102
b190d3e9427c init version
pontscho
parents:
diff changeset
103
b190d3e9427c init version
pontscho
parents:
diff changeset
104 <h3><a name="parts">2.3 Parts of a skin</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
105
b190d3e9427c init version
pontscho
parents:
diff changeset
106 Skins are quite free-format (unlike the fixed-format skins of
b190d3e9427c init version
pontscho
parents:
diff changeset
107 Winamp/XMMS, for example), so it is up to you to create something great.
b190d3e9427c init version
pontscho
parents:
diff changeset
108
b190d3e9427c init version
pontscho
parents:
diff changeset
109 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
110 Currently there are three windows to be decorated: the
b190d3e9427c init version
pontscho
parents:
diff changeset
111 <a href="#mainwin">main window</a>, the <a href="#subwindow">subwindow</a> and
b190d3e9427c init version
pontscho
parents:
diff changeset
112 the <a href="#skinmenu">skin menu</a> (which can be activated by a right
b190d3e9427c init version
pontscho
parents:
diff changeset
113 click).
b190d3e9427c init version
pontscho
parents:
diff changeset
114
b190d3e9427c init version
pontscho
parents:
diff changeset
115 <ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
116 <li>
b190d3e9427c init version
pontscho
parents:
diff changeset
117 The <b>main window</b> is where you can control MPlayer. The background of
b190d3e9427c init version
pontscho
parents:
diff changeset
118 the window is an image. Various items can (and must) be
b190d3e9427c init version
pontscho
parents:
diff changeset
119 placed in the window: <em>buttons</em>, <em>potmeters</em> (sliders, if
b190d3e9427c init version
pontscho
parents:
diff changeset
120 you like it better) and <em>labels</em>. For every item, you must
b190d3e9427c init version
pontscho
parents:
diff changeset
121 specify its position and size.
b190d3e9427c init version
pontscho
parents:
diff changeset
122
b190d3e9427c init version
pontscho
parents:
diff changeset
123 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
124 A <b>button</b> has three states (pressed, released,
b190d3e9427c init version
pontscho
parents:
diff changeset
125 disabled), so its image must be divided into three parts vertically.
b190d3e9427c init version
pontscho
parents:
diff changeset
126 See the <a href="#main.button">button</a> item for details.
b190d3e9427c init version
pontscho
parents:
diff changeset
127 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
128 A <b>potmeter</b> (mainly used for the seek bar and volume/balance
b190d3e9427c init version
pontscho
parents:
diff changeset
129 control) can have any number of phases by dividing its image into different
b190d3e9427c init version
pontscho
parents:
diff changeset
130 parts below each other.
b190d3e9427c init version
pontscho
parents:
diff changeset
131 See <a href="#main.hpotmeter">hpotmeter</a> and
b190d3e9427c init version
pontscho
parents:
diff changeset
132 <a href="#main.potmeter">potmeter</a> for details.
b190d3e9427c init version
pontscho
parents:
diff changeset
133
b190d3e9427c init version
pontscho
parents:
diff changeset
134 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
135 <b>Labels</b> are a bit special: the characters needed to draw them are taken
b190d3e9427c init version
pontscho
parents:
diff changeset
136 from an image file, and the characters in the image are described
b190d3e9427c init version
pontscho
parents:
diff changeset
137 by a <a href="#fonts">font description file</a>.
b190d3e9427c init version
pontscho
parents:
diff changeset
138 The latter is a plain text file which specifies
b190d3e9427c init version
pontscho
parents:
diff changeset
139 the x,y position and size of each character in the image. (So the
b190d3e9427c init version
pontscho
parents:
diff changeset
140 image file and its font description file form a font <em>together</em>.)
b190d3e9427c init version
pontscho
parents:
diff changeset
141 See <a href="#main.dlabel">dlabel</a> and <a href="#main.slabel">slabel</a>
b190d3e9427c init version
pontscho
parents:
diff changeset
142 for details.
b190d3e9427c init version
pontscho
parents:
diff changeset
143
b190d3e9427c init version
pontscho
parents:
diff changeset
144 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
145 <em class=note>
b190d3e9427c init version
pontscho
parents:
diff changeset
146 <b>Note:</b> all images can have full transparency as described in the
b190d3e9427c init version
pontscho
parents:
diff changeset
147 section about <a href="#images">image formats</a>.
b190d3e9427c init version
pontscho
parents:
diff changeset
148 </em>
b190d3e9427c init version
pontscho
parents:
diff changeset
149 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
150
b190d3e9427c init version
pontscho
parents:
diff changeset
151 <li>
b190d3e9427c init version
pontscho
parents:
diff changeset
152 The <b>subwindow</b> is where the movie appears. It can display a specified
b190d3e9427c init version
pontscho
parents:
diff changeset
153 image if there is no movie loaded (it is quite boring to have an empty
b190d3e9427c init version
pontscho
parents:
diff changeset
154 window :-))
b190d3e9427c init version
pontscho
parents:
diff changeset
155 <em class=note><b>Note:</b> transparency
b190d3e9427c init version
pontscho
parents:
diff changeset
156 is <b>not allowed</b> here.</em>
b190d3e9427c init version
pontscho
parents:
diff changeset
157 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
158
b190d3e9427c init version
pontscho
parents:
diff changeset
159 <li>
b190d3e9427c init version
pontscho
parents:
diff changeset
160 The <b>skin menu</b> is just a way to control MPlayer by means of
b190d3e9427c init version
pontscho
parents:
diff changeset
161 menu entries. Two images are required for the menu: one of them is the base
b190d3e9427c init version
pontscho
parents:
diff changeset
162 image that shows the menu in its normal state, the other one is used to
b190d3e9427c init version
pontscho
parents:
diff changeset
163 display the selected entries. When you pop up the menu, the first image is
b190d3e9427c init version
pontscho
parents:
diff changeset
164 shown. If you move the mouse over the menu entries, the currently selected
b190d3e9427c init version
pontscho
parents:
diff changeset
165 entry is copied from the second image over the menu entry below the mouse
b190d3e9427c init version
pontscho
parents:
diff changeset
166 pointer. (So the second image is never shown in whole.)
b190d3e9427c init version
pontscho
parents:
diff changeset
167 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
168 A menu entry is defined by its position and size in the image (see the
b190d3e9427c init version
pontscho
parents:
diff changeset
169 section about the <a href="#skinmenu">skin menu</a> for details).
b190d3e9427c init version
pontscho
parents:
diff changeset
170 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
171 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
172
b190d3e9427c init version
pontscho
parents:
diff changeset
173 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
174 There is an important thing not mentioned yet: for buttons, potmeters and
b190d3e9427c init version
pontscho
parents:
diff changeset
175 menu entries to work, MPlayer must know what to do if they are clicked.
b190d3e9427c init version
pontscho
parents:
diff changeset
176 This is done by <a href="#guimsg">messages</a> (events). For these items
b190d3e9427c init version
pontscho
parents:
diff changeset
177 you must define the messages to be genereated when they are clicked.
b190d3e9427c init version
pontscho
parents:
diff changeset
178
b190d3e9427c init version
pontscho
parents:
diff changeset
179 <h3><a name="files">2.4 Files</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
180
b190d3e9427c init version
pontscho
parents:
diff changeset
181 You need the following files to build a skin.
b190d3e9427c init version
pontscho
parents:
diff changeset
182 <ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
183 <li>
b190d3e9427c init version
pontscho
parents:
diff changeset
184 The configuration file named <a href="#skin">skin</a> tells MPlayer how
b190d3e9427c init version
pontscho
parents:
diff changeset
185 to put different parts of the skin together and what to do if you click
b190d3e9427c init version
pontscho
parents:
diff changeset
186 somewhere in the window.
b190d3e9427c init version
pontscho
parents:
diff changeset
187 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
188 <li>The background image for the main window.</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
189 <li>Images for the items in the main window (including one or more font
b190d3e9427c init version
pontscho
parents:
diff changeset
190 description files needed to draw labels).</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
191 <li>The image to be displayed in the subwindow (optional).</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
192 <li>Two images for the skin menu (they are needed only if you want to create
b190d3e9427c init version
pontscho
parents:
diff changeset
193 a menu).
b190d3e9427c init version
pontscho
parents:
diff changeset
194 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
195
b190d3e9427c init version
pontscho
parents:
diff changeset
196 With the exception of the skin configuration file, you can name the other
b190d3e9427c init version
pontscho
parents:
diff changeset
197 files whatever you want (but note that font description files must have
b190d3e9427c init version
pontscho
parents:
diff changeset
198 .fnt extension).
b190d3e9427c init version
pontscho
parents:
diff changeset
199
b190d3e9427c init version
pontscho
parents:
diff changeset
200
b190d3e9427c init version
pontscho
parents:
diff changeset
201 <h2><a name="skin">3 The <code><b>skin</b></code> file</a></h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
202
b190d3e9427c init version
pontscho
parents:
diff changeset
203 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
204 As mentioned above, this is the skin configuration file.
b190d3e9427c init version
pontscho
parents:
diff changeset
205 It is line oriented; comment lines start with a '<code>;</code>' character
b190d3e9427c init version
pontscho
parents:
diff changeset
206 at the beginning of the line (only spaces and tabs are allowed before the
b190d3e9427c init version
pontscho
parents:
diff changeset
207 '<code>;</code>').
b190d3e9427c init version
pontscho
parents:
diff changeset
208
b190d3e9427c init version
pontscho
parents:
diff changeset
209 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
210 The file is made up of sections. Each section describes the skin for an
b190d3e9427c init version
pontscho
parents:
diff changeset
211 application and has the following form:
b190d3e9427c init version
pontscho
parents:
diff changeset
212 <table border=1 width="100%"><tr bgcolor=silver><td><pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
213 section = <i>section name</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
214 .
b190d3e9427c init version
pontscho
parents:
diff changeset
215 .
b190d3e9427c init version
pontscho
parents:
diff changeset
216 .
b190d3e9427c init version
pontscho
parents:
diff changeset
217 end
b190d3e9427c init version
pontscho
parents:
diff changeset
218 </pre></td></tr></table>
b190d3e9427c init version
pontscho
parents:
diff changeset
219
b190d3e9427c init version
pontscho
parents:
diff changeset
220 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
221 Currently there is only one application, so you need only one section:
b190d3e9427c init version
pontscho
parents:
diff changeset
222 its name is <b>movieplayer</b>.
b190d3e9427c init version
pontscho
parents:
diff changeset
223
b190d3e9427c init version
pontscho
parents:
diff changeset
224 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
225 Within this section each window is described by a block in the following form:
b190d3e9427c init version
pontscho
parents:
diff changeset
226 <table border=1 width="100%"><tr bgcolor=silver><td><pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
227 window = <i>window name</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
228 .
b190d3e9427c init version
pontscho
parents:
diff changeset
229 .
b190d3e9427c init version
pontscho
parents:
diff changeset
230 .
b190d3e9427c init version
pontscho
parents:
diff changeset
231 end
b190d3e9427c init version
pontscho
parents:
diff changeset
232 </pre></tr></td></table>
b190d3e9427c init version
pontscho
parents:
diff changeset
233 where <i>window name</i> can be one of these strings:
b190d3e9427c init version
pontscho
parents:
diff changeset
234 <ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
235 <li><b>main</b> - for the main window</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
236 <li><b>sub</b> - for the subwindow</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
237 <li><b>menu</b> - for the skin menu</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
238 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
239
b190d3e9427c init version
pontscho
parents:
diff changeset
240 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
241 (The sub and menu block is optional---you do not need to create a menu or
b190d3e9427c init version
pontscho
parents:
diff changeset
242 to decorate the subwindow.)
b190d3e9427c init version
pontscho
parents:
diff changeset
243
b190d3e9427c init version
pontscho
parents:
diff changeset
244 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
245 Within a window block, you can define each item for the window
b190d3e9427c init version
pontscho
parents:
diff changeset
246 by a line in this form:
b190d3e9427c init version
pontscho
parents:
diff changeset
247
b190d3e9427c init version
pontscho
parents:
diff changeset
248 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
249 <pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
250 item = parameter
b190d3e9427c init version
pontscho
parents:
diff changeset
251 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
252 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
253
b190d3e9427c init version
pontscho
parents:
diff changeset
254 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
255 where <i>item</i> is a string that identifies the type of the GUI item,
b190d3e9427c init version
pontscho
parents:
diff changeset
256 <i>parameter</i> is a numeric or textual value (or a list of values
b190d3e9427c init version
pontscho
parents:
diff changeset
257 separated by commas).
b190d3e9427c init version
pontscho
parents:
diff changeset
258 </p>
b190d3e9427c init version
pontscho
parents:
diff changeset
259
b190d3e9427c init version
pontscho
parents:
diff changeset
260 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
261 Putting the above together, the whole file looks something like this:
b190d3e9427c init version
pontscho
parents:
diff changeset
262
b190d3e9427c init version
pontscho
parents:
diff changeset
263 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
264 <table border=1 width="100%"><tr bgcolor=silver><td><pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
265 section = movieplayer
b190d3e9427c init version
pontscho
parents:
diff changeset
266 window = main
b190d3e9427c init version
pontscho
parents:
diff changeset
267 ; ... items for main window ...
b190d3e9427c init version
pontscho
parents:
diff changeset
268 end
b190d3e9427c init version
pontscho
parents:
diff changeset
269
b190d3e9427c init version
pontscho
parents:
diff changeset
270 window = sub
b190d3e9427c init version
pontscho
parents:
diff changeset
271 ; ... items for subwindow ...
b190d3e9427c init version
pontscho
parents:
diff changeset
272 end
b190d3e9427c init version
pontscho
parents:
diff changeset
273
b190d3e9427c init version
pontscho
parents:
diff changeset
274 window = menu
b190d3e9427c init version
pontscho
parents:
diff changeset
275 ; ... items for skin menu ...
b190d3e9427c init version
pontscho
parents:
diff changeset
276 end
b190d3e9427c init version
pontscho
parents:
diff changeset
277 end
b190d3e9427c init version
pontscho
parents:
diff changeset
278 </pre></tr></td></table>
b190d3e9427c init version
pontscho
parents:
diff changeset
279
b190d3e9427c init version
pontscho
parents:
diff changeset
280 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
281 Finally some words about specifying images for the various items.
b190d3e9427c init version
pontscho
parents:
diff changeset
282 <br>
b190d3e9427c init version
pontscho
parents:
diff changeset
283 The name of an image file must be given without leading directories---
b190d3e9427c init version
pontscho
parents:
diff changeset
284 images are searched in the directory of the skins. You may (but you need not)
b190d3e9427c init version
pontscho
parents:
diff changeset
285 specify the file's extension. If the file doesn't exist, MPlayer tries to
b190d3e9427c init version
pontscho
parents:
diff changeset
286 load the file <i>&lt;filename&gt;.&lt;ext&gt;</i>, where <i>tga</i>,
b190d3e9427c init version
pontscho
parents:
diff changeset
287 <i>TGA</i>, <i>bmp</i>, <i>BMP</i>, <i>png</i> and <i>PNG</i> is tried
b190d3e9427c init version
pontscho
parents:
diff changeset
288 for <i>&lt;ext&gt;</i> (in this order). The first matching file will be used.
b190d3e9427c init version
pontscho
parents:
diff changeset
289
b190d3e9427c init version
pontscho
parents:
diff changeset
290 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
291
b190d3e9427c init version
pontscho
parents:
diff changeset
292 <table border=1 cellpadding=5 width="100%"><tr bgcolor="#ffffcc"><td>
b190d3e9427c init version
pontscho
parents:
diff changeset
293 Here is an example to make this clear. Suppose that you have an image called
b190d3e9427c init version
pontscho
parents:
diff changeset
294 <i>main.png</i> that you use for the main window:
b190d3e9427c init version
pontscho
parents:
diff changeset
295 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
296 <pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
297 base = main, -1, -1
b190d3e9427c init version
pontscho
parents:
diff changeset
298 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
299 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
300
b190d3e9427c init version
pontscho
parents:
diff changeset
301 MPlayer tries to load <i>main</i>, <i>main.tga</i>, <i>main.TGA</i>,
b190d3e9427c init version
pontscho
parents:
diff changeset
302 <i>main.bmp</i> etc, so <i>main.png</i> will be found.
b190d3e9427c init version
pontscho
parents:
diff changeset
303 <br>
b190d3e9427c init version
pontscho
parents:
diff changeset
304 If (by accident) you wrote
b190d3e9427c init version
pontscho
parents:
diff changeset
305 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
306 <pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
307 base = main.bmp, -1, -1
b190d3e9427c init version
pontscho
parents:
diff changeset
308 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
309 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
310 then <i>main.bmp</i>, <i>main.bmp.tga</i>, <i>main.bmp.TGA</i>,
b190d3e9427c init version
pontscho
parents:
diff changeset
311 <i>main.bmp.bmp</i> would be searched and MPlayer would finally give up
b190d3e9427c init version
pontscho
parents:
diff changeset
312 because there is no <i>main.bmp</i> in the directory, but <i>main.png</i>.
b190d3e9427c init version
pontscho
parents:
diff changeset
313 </td></tr></table>
b190d3e9427c init version
pontscho
parents:
diff changeset
314
b190d3e9427c init version
pontscho
parents:
diff changeset
315
b190d3e9427c init version
pontscho
parents:
diff changeset
316 <h3><a name="mainwin">3.1 Main window</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
317
b190d3e9427c init version
pontscho
parents:
diff changeset
318 Below you can see the list of items that can be used in the
b190d3e9427c init version
pontscho
parents:
diff changeset
319 '<code>window = main</code>' .&nbsp;.&nbsp;. '<code>end</code>' block.
b190d3e9427c init version
pontscho
parents:
diff changeset
320
b190d3e9427c init version
pontscho
parents:
diff changeset
321 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
322 <dt><a name="main.base">
b190d3e9427c init version
pontscho
parents:
diff changeset
323 <b>base = <i>image, x, y</i></b>
b190d3e9427c init version
pontscho
parents:
diff changeset
324 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
325 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
326 Lets you specify the background image to be used for the main window.
b190d3e9427c init version
pontscho
parents:
diff changeset
327 The window will appear at the given <i>x</i>,<i>y</i> position
b190d3e9427c init version
pontscho
parents:
diff changeset
328 on the screen (0,0 is the top left corner). You can specify -1 for center
b190d3e9427c init version
pontscho
parents:
diff changeset
329 and -2 for right (x) and bottom (y). The window will be as large as the image.
b190d3e9427c init version
pontscho
parents:
diff changeset
330 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
331 <em class=warn>
b190d3e9427c init version
pontscho
parents:
diff changeset
332 <b>Warning:</b> transparent regions in the image (colored #FF00FF) appear
b190d3e9427c init version
pontscho
parents:
diff changeset
333 black on X servers without the XShape extension.
b190d3e9427c init version
pontscho
parents:
diff changeset
334 </em>
b190d3e9427c init version
pontscho
parents:
diff changeset
335 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
336 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
337
b190d3e9427c init version
pontscho
parents:
diff changeset
338 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
339 <dt><a name="main.button">
b190d3e9427c init version
pontscho
parents:
diff changeset
340 <b>button = <i>image, x, y, width, height, message</i></b></a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
341 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
342 Place a button of <i>width</i> * <i>height</i> size at the
b190d3e9427c init version
pontscho
parents:
diff changeset
343 <i>x</i>,<i>y</i> position. The specified message is generated when
b190d3e9427c init version
pontscho
parents:
diff changeset
344 the button is clicked.
b190d3e9427c init version
pontscho
parents:
diff changeset
345 The image given by <i>image</i> must have three parts below each other
b190d3e9427c init version
pontscho
parents:
diff changeset
346 (according to the possible states of the button), like this:
b190d3e9427c init version
pontscho
parents:
diff changeset
347 <div align=center><table><tr><td><pre><small>
b190d3e9427c init version
pontscho
parents:
diff changeset
348 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
349 | pressed |
b190d3e9427c init version
pontscho
parents:
diff changeset
350 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
351 | released |
b190d3e9427c init version
pontscho
parents:
diff changeset
352 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
353 | disabled |
b190d3e9427c init version
pontscho
parents:
diff changeset
354 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
355 </small></pre></td></tr></table></div>
b190d3e9427c init version
pontscho
parents:
diff changeset
356 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
357 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
358
b190d3e9427c init version
pontscho
parents:
diff changeset
359 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
360 <dt><a name="main.decoration">
b190d3e9427c init version
pontscho
parents:
diff changeset
361 <b>decoration = enable|disable</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
362 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
363 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
364 Enable or disable window manager decoration of the main window. Default
b190d3e9427c init version
pontscho
parents:
diff changeset
365 is <b>disable</b>.
b190d3e9427c init version
pontscho
parents:
diff changeset
366 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
367 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
368
b190d3e9427c init version
pontscho
parents:
diff changeset
369 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
370 <dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
371 <a name="main.hpotmeter">
b190d3e9427c init version
pontscho
parents:
diff changeset
372 <b>
b190d3e9427c init version
pontscho
parents:
diff changeset
373 hpotmeter = <i>butt, bw,bh, phases, numphases, default, x, y, w, h, msg</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
374 </b>
b190d3e9427c init version
pontscho
parents:
diff changeset
375 </a>
b190d3e9427c init version
pontscho
parents:
diff changeset
376 </dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
377 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
378 Place a horizontal potmeter of <i>w</i> * <i>h</i> size at the
b190d3e9427c init version
pontscho
parents:
diff changeset
379 <i>x</i>,<i>y</i> position. The image can be divided into
b190d3e9427c init version
pontscho
parents:
diff changeset
380 different parts for the different phases of the potmeter (for example,
b190d3e9427c init version
pontscho
parents:
diff changeset
381 you can have a pot for volume control that turns from green to red
b190d3e9427c init version
pontscho
parents:
diff changeset
382 while its value changes from the minimum to the maximum.)
b190d3e9427c init version
pontscho
parents:
diff changeset
383 hpotmeter can have a button that can be dragged horizontally.
b190d3e9427c init version
pontscho
parents:
diff changeset
384 The parameters are:
b190d3e9427c init version
pontscho
parents:
diff changeset
385 <ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
386 <li><i>butt</i> - the image to be used for the button
b190d3e9427c init version
pontscho
parents:
diff changeset
387 (must have three parts below each other, like in case of
b190d3e9427c init version
pontscho
parents:
diff changeset
388 <a href="#main.button">button</a>)</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
389 <li><i>bw</i>, <i>bh</i> - size of the button</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
390 <li><i>phases</i> - The image to be used for the different phases of the
b190d3e9427c init version
pontscho
parents:
diff changeset
391 hpotmeter. The image must be divided into <i>numphases</i> parts vertically
b190d3e9427c init version
pontscho
parents:
diff changeset
392 (see below). A special value of <kbd>NULL</kbd> can be used if you want
b190d3e9427c init version
pontscho
parents:
diff changeset
393 no such image.
b190d3e9427c init version
pontscho
parents:
diff changeset
394 </li>
b190d3e9427c init version
pontscho
parents:
diff changeset
395 <li><i>numphases</i> - number of phases stored in the <i>phases</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
396 image</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
397 <li><i>default</i> - default value for hpotmeter (in the range 0 to
b190d3e9427c init version
pontscho
parents:
diff changeset
398 100)</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
399 <li><i>x</i>, <i>y</i> - position for the hpotmeter</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
400 <li><i>w</i>, <i>h</i> - width and height of the hpotmeter</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
401 <li><i>msg</i> - the message to be generated when the value of hpotmeter
b190d3e9427c init version
pontscho
parents:
diff changeset
402 is changed</li>
b190d3e9427c init version
pontscho
parents:
diff changeset
403 </ul>
b190d3e9427c init version
pontscho
parents:
diff changeset
404 The image used for the different phases must look something like this:
b190d3e9427c init version
pontscho
parents:
diff changeset
405 <div align=center><table border=0><tr><td><pre><small>
b190d3e9427c init version
pontscho
parents:
diff changeset
406 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
407 | phase #1 |
b190d3e9427c init version
pontscho
parents:
diff changeset
408 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
409 | phase #2 |
b190d3e9427c init version
pontscho
parents:
diff changeset
410 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
411 ...
b190d3e9427c init version
pontscho
parents:
diff changeset
412 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
413 | phase #n |
b190d3e9427c init version
pontscho
parents:
diff changeset
414 +------------+
b190d3e9427c init version
pontscho
parents:
diff changeset
415 </small></pre></td></tr></table></div>
b190d3e9427c init version
pontscho
parents:
diff changeset
416 <em class=note>
b190d3e9427c init version
pontscho
parents:
diff changeset
417 <b>Note:</b> there will be a vpotmeter item too, but is it not implemented
b190d3e9427c init version
pontscho
parents:
diff changeset
418 yet.
b190d3e9427c init version
pontscho
parents:
diff changeset
419 </em>
b190d3e9427c init version
pontscho
parents:
diff changeset
420 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
421 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
422
b190d3e9427c init version
pontscho
parents:
diff changeset
423 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
424 <dt><a name="main.potmeter">
b190d3e9427c init version
pontscho
parents:
diff changeset
425 <b>potmeter = <i>phases, numphases, default, x, y, w, h, msg</i></b>
b190d3e9427c init version
pontscho
parents:
diff changeset
426 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
427 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
428 A potmeter without a button. (I guess it is ment to be turned round,
b190d3e9427c init version
pontscho
parents:
diff changeset
429 but it reacts to horizontal dragging only.)
b190d3e9427c init version
pontscho
parents:
diff changeset
430 For the description of the parameters see
b190d3e9427c init version
pontscho
parents:
diff changeset
431 <a href="#main.hpotmeter">hpotmeter</a>. <i>phases</i> can be
b190d3e9427c init version
pontscho
parents:
diff changeset
432 <code>NULL</code>, but its quite useless, since you can not see where
b190d3e9427c init version
pontscho
parents:
diff changeset
433 the potmeter is set.
b190d3e9427c init version
pontscho
parents:
diff changeset
434 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
435 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
436
b190d3e9427c init version
pontscho
parents:
diff changeset
437 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
438 <dt><a name="main.font">
b190d3e9427c init version
pontscho
parents:
diff changeset
439 <b>font = <i>fontfile, fontid</i></b>
b190d3e9427c init version
pontscho
parents:
diff changeset
440 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
441 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
442 Defines a font. <i>fontfile</i> is the name of a font description file
b190d3e9427c init version
pontscho
parents:
diff changeset
443 with <code>.fnt</code> extension (<b>no need</b> to specify the extension
b190d3e9427c init version
pontscho
parents:
diff changeset
444 here).
b190d3e9427c init version
pontscho
parents:
diff changeset
445 <i>fontid</i> is used to refer to the font
b190d3e9427c init version
pontscho
parents:
diff changeset
446 (see <a href="#main.dlabel">dlabel</a> and <a href="#main.slabel">slabel</a>).
b190d3e9427c init version
pontscho
parents:
diff changeset
447 Up to 25 fonts can be defined.
b190d3e9427c init version
pontscho
parents:
diff changeset
448 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
449 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
450
b190d3e9427c init version
pontscho
parents:
diff changeset
451 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
452 <dt><a name="main.dlabel">
b190d3e9427c init version
pontscho
parents:
diff changeset
453 <b>dlabel = <i>x, y, length, align, fontid, "text"</i></b>
b190d3e9427c init version
pontscho
parents:
diff changeset
454 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
455 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
456 Place a dynamic label at the <i>x</i>,<i>y</i> position. The label is called
b190d3e9427c init version
pontscho
parents:
diff changeset
457 dynamic because its text is refreshed periodically.
b190d3e9427c init version
pontscho
parents:
diff changeset
458 The maximum length of the label is given by <i>length</i> (its height is the
b190d3e9427c init version
pontscho
parents:
diff changeset
459 height of a character).
b190d3e9427c init version
pontscho
parents:
diff changeset
460 If the text to be displayed is wider than that, then it will be
b190d3e9427c init version
pontscho
parents:
diff changeset
461 scrolled, otherwise it is aligned within the specified space by the value
b190d3e9427c init version
pontscho
parents:
diff changeset
462 of the <i>align</i> parameter: 0 is for right, 1 is for center,
b190d3e9427c init version
pontscho
parents:
diff changeset
463 2 is for left.
b190d3e9427c init version
pontscho
parents:
diff changeset
464 <br>
b190d3e9427c init version
pontscho
parents:
diff changeset
465 The text to be displayed is given by <i>text</i>: it must be written between
b190d3e9427c init version
pontscho
parents:
diff changeset
466 double quotes (<code>"</code>) (but the <code>"</code> cannot be part of the
b190d3e9427c init version
pontscho
parents:
diff changeset
467 text). The label is displayed using the font identified by <i>fontid</i>.
b190d3e9427c init version
pontscho
parents:
diff changeset
468 You can use the following variables in the text.
b190d3e9427c init version
pontscho
parents:
diff changeset
469
b190d3e9427c init version
pontscho
parents:
diff changeset
470 <div align=center>
b190d3e9427c init version
pontscho
parents:
diff changeset
471 <table valign=top border=1>
b190d3e9427c init version
pontscho
parents:
diff changeset
472 <tr align=center><th>Variable</th><th align=left>Meaning</th></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
473 <tr><td align=center><kbd>$1</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
474 <td>play time in <em>hh:mm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
475 <tr><td align=center><kbd>$2</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
476 <td>play time in <em>mmmm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
477 <tr><td align=center><kbd>$3</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
478 <td>play time in <em>hh</em> format (hours)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
479 <tr><td align=center><kbd>$4</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
480 <td>play time in <em>mm</em> format (minutes)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
481 <tr><td align=center><kbd>$5</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
482 <td>play time in <em>ss</em> format (seconds)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
483 <tr><td align=center><kbd>$6</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
484 <td>movie's length in <em>hh:mm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
485 <tr><td align=center><kbd>$7</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
486 <td>movie's length in <em>mmmm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
487 <tr><td align=center><kbd>$8</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
488 <td>play time in <em>h:mm:ss</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
489 <tr><td align=center><kbd>$v</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
490 <td>volume in <em>xxx.xx%</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
491 <tr><td align=center><kbd>$V</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
492 <td>volume in <em>xxx.x</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
493 <tr><td align=center><kbd>$b</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
494 <td>balance in <em>xxx.xx%</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
495 <tr><td align=center><kbd>$B</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
496 <td>balance in <em>xxx.x</em> format</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
497 <tr><td align=center><kbd>$$</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
498 <td>the <kbd>$</kbd> character</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
499 <tr><td align=center><kbd>$a</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
500 <td>a character according to the audio type (none: <code>n</code>,
b190d3e9427c init version
pontscho
parents:
diff changeset
501 mono: <code>m</code>, stereo: <code>t</code>)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
502 <tr><td align=center><kbd>$t</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
503 <td>track number (in playlist)</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
504 <tr><td align=center><kbd>$o</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
505 <td>filename</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
506 <tr><td align=center><kbd>$f</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
507 <td>filename in lower case</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
508 <tr><td align=center><kbd>$F</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
509 <td>filename in upper case</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
510 <tr><td align=center><kbd>$T</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
511 <td>a character according to the stream type (file: <code>f</code>,
b190d3e9427c init version
pontscho
parents:
diff changeset
512 video CD: <code>v</code>, DVD: <code>d</code>, URL: <code>u</code>)
b190d3e9427c init version
pontscho
parents:
diff changeset
513 </td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
514 <tr><td align=center><kbd>$p</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
515 <td>the "p" character (if a movie is playing and the font has the "p"
b190d3e9427c init version
pontscho
parents:
diff changeset
516 character)
b190d3e9427c init version
pontscho
parents:
diff changeset
517 </td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
518 <tr><td align=center><kbd>$s</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
519 <td>the "s" character (if the movie is stopped and the font has the "s"
b190d3e9427c init version
pontscho
parents:
diff changeset
520 character)
b190d3e9427c init version
pontscho
parents:
diff changeset
521 </td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
522 <tr><td align=center><kbd>$e</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
523 <td>the "e" character (if playback is paused and the font has the "e"
b190d3e9427c init version
pontscho
parents:
diff changeset
524 character)
b190d3e9427c init version
pontscho
parents:
diff changeset
525 </td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
526 </table></div>
b190d3e9427c init version
pontscho
parents:
diff changeset
527 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
528 <b>Note:</b> The <kbd>$a</kbd>, <kbd>$T</kbd>, <kbd>$p</kbd>, <kbd>$s</kbd>
b190d3e9427c init version
pontscho
parents:
diff changeset
529 and <kbd>$e</kbd> variables all return characters that should be displayed
b190d3e9427c init version
pontscho
parents:
diff changeset
530 as special symbols (for example, "e" is for the pause symbol that usually
b190d3e9427c init version
pontscho
parents:
diff changeset
531 looks something like <code>||</code>). You should have a font for normal
b190d3e9427c init version
pontscho
parents:
diff changeset
532 characters and a different font for symbols.
b190d3e9427c init version
pontscho
parents:
diff changeset
533 See the section about <a href="#symbols">symbols</a> for more information.
b190d3e9427c init version
pontscho
parents:
diff changeset
534 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
535 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
536
b190d3e9427c init version
pontscho
parents:
diff changeset
537 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
538 <dt><a name="main.slabel">
b190d3e9427c init version
pontscho
parents:
diff changeset
539 <b>slabel = <i>x, y, fontid, text</i></b>
b190d3e9427c init version
pontscho
parents:
diff changeset
540 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
541 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
542 Place a static label at the <i>x</i>,<i>y</i> position.
b190d3e9427c init version
pontscho
parents:
diff changeset
543 <i>text</i> is displayed using the font identified by <i>fontid</i>.
b190d3e9427c init version
pontscho
parents:
diff changeset
544 The text is just a raw string ($x variables do not work) that must be enclosed
b190d3e9427c init version
pontscho
parents:
diff changeset
545 between double quotes (the <code>"</code> cannot be part of the text).
b190d3e9427c init version
pontscho
parents:
diff changeset
546 The label is displayed using the font identified by <i>fontid</i>.
b190d3e9427c init version
pontscho
parents:
diff changeset
547 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
548 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
549
b190d3e9427c init version
pontscho
parents:
diff changeset
550
b190d3e9427c init version
pontscho
parents:
diff changeset
551 <h3><a name="subwindow">3.2 Subwindow</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
552
b190d3e9427c init version
pontscho
parents:
diff changeset
553 The following items can be used in the
b190d3e9427c init version
pontscho
parents:
diff changeset
554 '<code>window = sub</code>' .&nbsp;.&nbsp;. '<code>end</code>' block.
b190d3e9427c init version
pontscho
parents:
diff changeset
555
b190d3e9427c init version
pontscho
parents:
diff changeset
556 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
557 <dt><a name="sub.base">
b190d3e9427c init version
pontscho
parents:
diff changeset
558 <b>base = <i>image, x, y, width, height</i></b>
b190d3e9427c init version
pontscho
parents:
diff changeset
559 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
560 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
561 The image to be displayed in the window.
b190d3e9427c init version
pontscho
parents:
diff changeset
562 The window will appear at the given <i>x</i>,<i>y</i> position
b190d3e9427c init version
pontscho
parents:
diff changeset
563 on the screen (0,0 is the top left corner). You can specify -1 for center
b190d3e9427c init version
pontscho
parents:
diff changeset
564 and -2 for right (x) and bottom (y). The window will be as large as the image.
b190d3e9427c init version
pontscho
parents:
diff changeset
565 <i>width</i> and <i>height</i> gives the size of the window; they are
b190d3e9427c init version
pontscho
parents:
diff changeset
566 optional (if they are missing, the window is the same size as the image).
b190d3e9427c init version
pontscho
parents:
diff changeset
567 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
568 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
569
b190d3e9427c init version
pontscho
parents:
diff changeset
570 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
571 <dt><a name="sub.background">
b190d3e9427c init version
pontscho
parents:
diff changeset
572 <b>background = <i>r, g, b</i></b>
b190d3e9427c init version
pontscho
parents:
diff changeset
573 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
574 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
575 Lets you set the background color. It is useful if the image is smaller than
b190d3e9427c init version
pontscho
parents:
diff changeset
576 the window.
b190d3e9427c init version
pontscho
parents:
diff changeset
577 <i>r</i>, <i>g</i> and <i>b</i> specifies the red, green and blue
b190d3e9427c init version
pontscho
parents:
diff changeset
578 component of the color (each of them is a decimal number from 0 to 255).
b190d3e9427c init version
pontscho
parents:
diff changeset
579 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
580 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
581
b190d3e9427c init version
pontscho
parents:
diff changeset
582
b190d3e9427c init version
pontscho
parents:
diff changeset
583 <h3><a name="skinmenu">3.3 Skin menu</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
584
b190d3e9427c init version
pontscho
parents:
diff changeset
585 As mentioned earlier, the menu is displayed using two images.
b190d3e9427c init version
pontscho
parents:
diff changeset
586 Normal menu entries are taken from the image specified by the <i>base</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
587 item, while the currently selected entry is taken from the image specified
b190d3e9427c init version
pontscho
parents:
diff changeset
588 by the <i>selected</i> item.
b190d3e9427c init version
pontscho
parents:
diff changeset
589 You must define the position and size of each menu entry by the <i>menu</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
590 item.
b190d3e9427c init version
pontscho
parents:
diff changeset
591
b190d3e9427c init version
pontscho
parents:
diff changeset
592 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
593 These are the items that can be used in the '<code>window = menu</code>'
b190d3e9427c init version
pontscho
parents:
diff changeset
594 .&nbsp;.&nbsp;. '<code>end</code>' block.
b190d3e9427c init version
pontscho
parents:
diff changeset
595
b190d3e9427c init version
pontscho
parents:
diff changeset
596 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
597 <dt><a name="menu.base">
b190d3e9427c init version
pontscho
parents:
diff changeset
598 <b>base = <i>image</i></b>
b190d3e9427c init version
pontscho
parents:
diff changeset
599 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
600 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
601 The image for normal menu entries.
b190d3e9427c init version
pontscho
parents:
diff changeset
602 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
603 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
604
b190d3e9427c init version
pontscho
parents:
diff changeset
605 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
606 <dt><a name="menu.selected">
b190d3e9427c init version
pontscho
parents:
diff changeset
607 <b>selected = <i>image</i></b>
b190d3e9427c init version
pontscho
parents:
diff changeset
608 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
609 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
610 The image showing the menu with all entries selected.
b190d3e9427c init version
pontscho
parents:
diff changeset
611 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
612 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
613
b190d3e9427c init version
pontscho
parents:
diff changeset
614 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
615 <dt><a name="menu.menu">
b190d3e9427c init version
pontscho
parents:
diff changeset
616 <b>menu = <i>x, y, width, height, message</i></b>
b190d3e9427c init version
pontscho
parents:
diff changeset
617 </a></dt>
b190d3e9427c init version
pontscho
parents:
diff changeset
618 <dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
619 Defines the <i>x</i>,<i>y</i> position and the size of a menu entry in
b190d3e9427c init version
pontscho
parents:
diff changeset
620 the images. <i>message</i> is the message to be generated when
b190d3e9427c init version
pontscho
parents:
diff changeset
621 the mouse button is released over the entry.
b190d3e9427c init version
pontscho
parents:
diff changeset
622 </dd>
b190d3e9427c init version
pontscho
parents:
diff changeset
623 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
624
b190d3e9427c init version
pontscho
parents:
diff changeset
625
b190d3e9427c init version
pontscho
parents:
diff changeset
626 <h2><a name="fonts">4 Fonts</a></h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
627
b190d3e9427c init version
pontscho
parents:
diff changeset
628 As mentioned in the section about the parts of a skin, a font is defined
b190d3e9427c init version
pontscho
parents:
diff changeset
629 by an image and a description
b190d3e9427c init version
pontscho
parents:
diff changeset
630 file. You can place the characters anywhere in the image, but make sure that
b190d3e9427c init version
pontscho
parents:
diff changeset
631 their position and size is given in the description file exactly.
b190d3e9427c init version
pontscho
parents:
diff changeset
632
b190d3e9427c init version
pontscho
parents:
diff changeset
633 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
634 The font description file (with .fnt extension) can have comment
b190d3e9427c init version
pontscho
parents:
diff changeset
635 lines starting with '<code>;</code>'.
b190d3e9427c init version
pontscho
parents:
diff changeset
636 The file must have a line in the form
b190d3e9427c init version
pontscho
parents:
diff changeset
637 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
638 <pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
639 image = <i>image</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
640 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
641 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
642
b190d3e9427c init version
pontscho
parents:
diff changeset
643 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
644 where <i>image</i> is the name of the image file to be used for
b190d3e9427c init version
pontscho
parents:
diff changeset
645 the font (you do not have to specify the extension).
b190d3e9427c init version
pontscho
parents:
diff changeset
646 The above line is followed by character definition lines of the form:
b190d3e9427c init version
pontscho
parents:
diff changeset
647
b190d3e9427c init version
pontscho
parents:
diff changeset
648 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
649 <pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
650 "<i>char</i>" = <i>x, y, w, h</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
651 </pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
652 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
653
b190d3e9427c init version
pontscho
parents:
diff changeset
654 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
655 Here <i>x</i> and <i>y</i> specifies the position of the
b190d3e9427c init version
pontscho
parents:
diff changeset
656 <i>char</i> character in the image (0,0 is the upper left corner).
b190d3e9427c init version
pontscho
parents:
diff changeset
657 <i>w</i> and <i>h</i> is the width and height of the character
b190d3e9427c init version
pontscho
parents:
diff changeset
658 (in pixels, of course).
b190d3e9427c init version
pontscho
parents:
diff changeset
659
b190d3e9427c init version
pontscho
parents:
diff changeset
660 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
661 Here is an example that defines the A, B, C characters using font.png.
b190d3e9427c init version
pontscho
parents:
diff changeset
662 <table width="100%" border=1><tr bgcolor=silver><td><pre>
b190d3e9427c init version
pontscho
parents:
diff changeset
663 ; can be "font" instead of "font.png"
b190d3e9427c init version
pontscho
parents:
diff changeset
664 image = font.png
b190d3e9427c init version
pontscho
parents:
diff changeset
665
b190d3e9427c init version
pontscho
parents:
diff changeset
666 ; Three characters are enough for demonstration only. :-)
b190d3e9427c init version
pontscho
parents:
diff changeset
667 "A" = 0,0, 7,13
b190d3e9427c init version
pontscho
parents:
diff changeset
668 "B" = 7,0, 7,13
b190d3e9427c init version
pontscho
parents:
diff changeset
669 "C" = 14,0, 7,13
b190d3e9427c init version
pontscho
parents:
diff changeset
670 </pre></td></tr></table>
b190d3e9427c init version
pontscho
parents:
diff changeset
671
b190d3e9427c init version
pontscho
parents:
diff changeset
672
b190d3e9427c init version
pontscho
parents:
diff changeset
673 <h3><a name="symbols">4.1 Symbols</a></h3>
b190d3e9427c init version
pontscho
parents:
diff changeset
674
b190d3e9427c init version
pontscho
parents:
diff changeset
675 Some characters have special meanings when returned by some of the variables
b190d3e9427c init version
pontscho
parents:
diff changeset
676 used in
b190d3e9427c init version
pontscho
parents:
diff changeset
677 <a href="#main.dlabel">dlabel</a>; these characters are meant to be
b190d3e9427c init version
pontscho
parents:
diff changeset
678 displayed as symbols. (For example, in case of a DVD stream, you could display
b190d3e9427c init version
pontscho
parents:
diff changeset
679 a nice DVD logo instead of the character 'd'.)
b190d3e9427c init version
pontscho
parents:
diff changeset
680
b190d3e9427c init version
pontscho
parents:
diff changeset
681 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
682 The following table lists all the characters that can be used to display
b190d3e9427c init version
pontscho
parents:
diff changeset
683 symbols (and thus require a different font).
b190d3e9427c init version
pontscho
parents:
diff changeset
684
b190d3e9427c init version
pontscho
parents:
diff changeset
685 <div align=center>
b190d3e9427c init version
pontscho
parents:
diff changeset
686 <table>
b190d3e9427c init version
pontscho
parents:
diff changeset
687 <tr><th align=center>Character</th><th align=left>Symbol</th></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
688 <tr><td align=center><kbd>p</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
689 <td align=left>play</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
690 <tr><td align=center><kbd>s</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
691 <td align=left>stop</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
692 <tr><td align=center><kbd>e</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
693 <td align=left>pause</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
694 <tr><td align=center><kbd>n</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
695 <td align=left>no sound</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
696 <tr><td align=center><kbd>m</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
697 <td align=left>mono sound</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
698 <tr><td align=center><kbd>t</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
699 <td align=left>stereo sound</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
700 <tr><td align=center><kbd>f</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
701 <td align=left>stream is a file</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
702 <tr><td align=center><kbd>v</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
703 <td align=left>stream is a video CD</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
704 <tr><td align=center><kbd>d</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
705 <td align=left>stream is a DVD</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
706 <tr><td align=center><kbd>u</kbd></td>
b190d3e9427c init version
pontscho
parents:
diff changeset
707 <td align=left>stream is a URL</td></tr>
b190d3e9427c init version
pontscho
parents:
diff changeset
708 </table>
b190d3e9427c init version
pontscho
parents:
diff changeset
709 </div>
b190d3e9427c init version
pontscho
parents:
diff changeset
710
b190d3e9427c init version
pontscho
parents:
diff changeset
711 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
712 <b>Note:</b> currently only 'p', 's', 'e', 'n', 'm' and 't' is used.
b190d3e9427c init version
pontscho
parents:
diff changeset
713 </p>
b190d3e9427c init version
pontscho
parents:
diff changeset
714
b190d3e9427c init version
pontscho
parents:
diff changeset
715 <h2><a name="guimsg">Appendix A: GUI messages</a></h2>
b190d3e9427c init version
pontscho
parents:
diff changeset
716
b190d3e9427c init version
pontscho
parents:
diff changeset
717 These are the messages that can be generated by buttons, potmeters and
b190d3e9427c init version
pontscho
parents:
diff changeset
718 menu entries.
b190d3e9427c init version
pontscho
parents:
diff changeset
719
b190d3e9427c init version
pontscho
parents:
diff changeset
720 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
721 <em class=note>
b190d3e9427c init version
pontscho
parents:
diff changeset
722 <b>Note:</b> some of the messages might not work as expected (or not
b190d3e9427c init version
pontscho
parents:
diff changeset
723 work at all). As you know, the GUI is under development.</em>
b190d3e9427c init version
pontscho
parents:
diff changeset
724
b190d3e9427c init version
pontscho
parents:
diff changeset
725 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
726 <i>Playback control:</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
727 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
728 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
729 <dt><b>evNext</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
730 <dd>Jump to next track in the playlist.
b190d3e9427c init version
pontscho
parents:
diff changeset
731
b190d3e9427c init version
pontscho
parents:
diff changeset
732 <dt><b>evPause</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
733 <dd>Pause playing.
b190d3e9427c init version
pontscho
parents:
diff changeset
734
b190d3e9427c init version
pontscho
parents:
diff changeset
735 <dt><b>evPauseSwitchToPlay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
736 <dd>Forms a switch together with <i>evPlaySwitchToPause</i>. They can be
b190d3e9427c init version
pontscho
parents:
diff changeset
737 used to have a common play/pause button. Both messages should be assigned
b190d3e9427c init version
pontscho
parents:
diff changeset
738 to buttons displayed at the very same position in the window. This
b190d3e9427c init version
pontscho
parents:
diff changeset
739 message pauses playing and the image for the <i>evPlaySwitchToPause</i> button
b190d3e9427c init version
pontscho
parents:
diff changeset
740 is displayed (to indicate that the button can be pressed to continue playing).
b190d3e9427c init version
pontscho
parents:
diff changeset
741
b190d3e9427c init version
pontscho
parents:
diff changeset
742 <dt><b>evPlay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
743 <dd>Start playing.
b190d3e9427c init version
pontscho
parents:
diff changeset
744
b190d3e9427c init version
pontscho
parents:
diff changeset
745 <dt><b>evPlaySwitchToPause</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
746 <dd>The opposite of <i>evPauseSwitchToPlay</i>. This message starts playing
b190d3e9427c init version
pontscho
parents:
diff changeset
747 and the image for the <i>evPauseSwitchToPlay</i> button is displayed (to
b190d3e9427c init version
pontscho
parents:
diff changeset
748 indicate that the button can be pressed to pause playing).
b190d3e9427c init version
pontscho
parents:
diff changeset
749
b190d3e9427c init version
pontscho
parents:
diff changeset
750 <dt><b>evPrev</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
751 <dd>Jump to previous track in the playlist.
b190d3e9427c init version
pontscho
parents:
diff changeset
752
b190d3e9427c init version
pontscho
parents:
diff changeset
753 <dt><b>evStop</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
754 <dd>Stop playing.
b190d3e9427c init version
pontscho
parents:
diff changeset
755 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
756 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
757
b190d3e9427c init version
pontscho
parents:
diff changeset
758 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
759 <i>Seeking in the stream:</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
760 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
761 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
762 <dt><b>evBackward10sec</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
763 <dt><b>evBackward1min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
764 <dt><b>evBackward10min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
765 <dd>Seek backward 10 seconds / 1 minute / 10 minutes.
b190d3e9427c init version
pontscho
parents:
diff changeset
766
b190d3e9427c init version
pontscho
parents:
diff changeset
767 <dt><b>evForward10sec</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
768 <dt><b>evForward1min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
769 <dt><b>evForward10min</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
770 <dd>Seek forward 10 seconds / 1 minute / 10 minutes.
b190d3e9427c init version
pontscho
parents:
diff changeset
771
b190d3e9427c init version
pontscho
parents:
diff changeset
772 <dt><b>evSetMoviePosition</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
773 <dd>Seek to position (can be used by a potmeter; the relative
b190d3e9427c init version
pontscho
parents:
diff changeset
774 value (0-100%) of the potmeter is used).
b190d3e9427c init version
pontscho
parents:
diff changeset
775 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
776 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
777
b190d3e9427c init version
pontscho
parents:
diff changeset
778 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
779 <i>Video control:</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
780 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
781 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
782 <dt><b>evDoubleSize</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
783 <dd>Set the movie window to double size.
b190d3e9427c init version
pontscho
parents:
diff changeset
784
b190d3e9427c init version
pontscho
parents:
diff changeset
785 <dt><b>evFullScreen</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
786 <dd>Switch fullscreen mode on/off.
b190d3e9427c init version
pontscho
parents:
diff changeset
787
b190d3e9427c init version
pontscho
parents:
diff changeset
788 <dt><b>evNormalSize</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
789 <dd>Set the movie window to its normal size.
b190d3e9427c init version
pontscho
parents:
diff changeset
790 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
791 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
792
b190d3e9427c init version
pontscho
parents:
diff changeset
793 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
794 <i>Audio control:</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
795 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
796 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
797 <dt><b>evDecAudioBufDelay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
798 <dd>Decrease audio buffer delay.
b190d3e9427c init version
pontscho
parents:
diff changeset
799
b190d3e9427c init version
pontscho
parents:
diff changeset
800 <dt><b>evDecBalance</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
801 <dd>Decrease balance.
b190d3e9427c init version
pontscho
parents:
diff changeset
802
b190d3e9427c init version
pontscho
parents:
diff changeset
803 <dt><b>evDecVolume</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
804 <dd>Decrease volume.
b190d3e9427c init version
pontscho
parents:
diff changeset
805
b190d3e9427c init version
pontscho
parents:
diff changeset
806 <dt><b>evIncAudioBufDelay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
807 <dd>Increase audio buffer delay.
b190d3e9427c init version
pontscho
parents:
diff changeset
808
b190d3e9427c init version
pontscho
parents:
diff changeset
809 <dt><b>evIncBalance</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
810 <dd>Increase balance.
b190d3e9427c init version
pontscho
parents:
diff changeset
811
b190d3e9427c init version
pontscho
parents:
diff changeset
812 <dt><b>evIncVolume</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
813 <dd>Increase volume.
b190d3e9427c init version
pontscho
parents:
diff changeset
814
b190d3e9427c init version
pontscho
parents:
diff changeset
815 <dt><b>evMute</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
816 <dd>Mute/unmute the sound.
b190d3e9427c init version
pontscho
parents:
diff changeset
817
b190d3e9427c init version
pontscho
parents:
diff changeset
818 <dt><b>evSetBalance</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
819 <dd>Set balance (can be used by a potmeter; the relative
b190d3e9427c init version
pontscho
parents:
diff changeset
820 value (0-100%) of the potmeter is used).
b190d3e9427c init version
pontscho
parents:
diff changeset
821
b190d3e9427c init version
pontscho
parents:
diff changeset
822 <dt><b>evSetVolume</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
823 <dd>Set volume (can be used by a potmeter; the relative
b190d3e9427c init version
pontscho
parents:
diff changeset
824 value (0-100%) of the potmeter is used).
b190d3e9427c init version
pontscho
parents:
diff changeset
825 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
826 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
827
b190d3e9427c init version
pontscho
parents:
diff changeset
828 <p>
b190d3e9427c init version
pontscho
parents:
diff changeset
829 <i>Miscellaneous:</i>
b190d3e9427c init version
pontscho
parents:
diff changeset
830 <blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
831 <dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
832 <dt><b>evAbout</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
833 <dd>Open the about window.
b190d3e9427c init version
pontscho
parents:
diff changeset
834
b190d3e9427c init version
pontscho
parents:
diff changeset
835 <dt><b>evEqualeaser</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
836 <dd>Turn the equalizer on/off.
b190d3e9427c init version
pontscho
parents:
diff changeset
837
b190d3e9427c init version
pontscho
parents:
diff changeset
838 <dt><b>evExit</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
839 <dd>Quit from the program.
b190d3e9427c init version
pontscho
parents:
diff changeset
840
b190d3e9427c init version
pontscho
parents:
diff changeset
841 <dt><b>evIconify</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
842 <dd>Iconify the window.
b190d3e9427c init version
pontscho
parents:
diff changeset
843
b190d3e9427c init version
pontscho
parents:
diff changeset
844 <dt><b>evLoad</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
845 <dd>Load a file (by opening a file browser window, where you can choose a
b190d3e9427c init version
pontscho
parents:
diff changeset
846 file).
b190d3e9427c init version
pontscho
parents:
diff changeset
847
b190d3e9427c init version
pontscho
parents:
diff changeset
848 <dt><b>evLoadPlay</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
849 <dd>Does the same as <i>evLoad</i>, but it automatically starts
b190d3e9427c init version
pontscho
parents:
diff changeset
850 playing after the file is loaded.
b190d3e9427c init version
pontscho
parents:
diff changeset
851
b190d3e9427c init version
pontscho
parents:
diff changeset
852 <dt><b>evNone</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
853 <dd>Empty message, it has no effect. (Except maybe in CVS versions. :-))
b190d3e9427c init version
pontscho
parents:
diff changeset
854
b190d3e9427c init version
pontscho
parents:
diff changeset
855 <dt><b>evPlayList</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
856 <dd>Open/close the playlist window.
b190d3e9427c init version
pontscho
parents:
diff changeset
857
b190d3e9427c init version
pontscho
parents:
diff changeset
858 <dt><b>evPreferences</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
859 <dd>Open the preferences window.
b190d3e9427c init version
pontscho
parents:
diff changeset
860
b190d3e9427c init version
pontscho
parents:
diff changeset
861 <dt><b>evSkinBrowser</b>
b190d3e9427c init version
pontscho
parents:
diff changeset
862 <dd>Open the skin browser window.
b190d3e9427c init version
pontscho
parents:
diff changeset
863 </dl>
b190d3e9427c init version
pontscho
parents:
diff changeset
864 </blockquote>
b190d3e9427c init version
pontscho
parents:
diff changeset
865
b190d3e9427c init version
pontscho
parents:
diff changeset
866 </body>
b190d3e9427c init version
pontscho
parents:
diff changeset
867 </html>