annotate DOCS/skin.html @ 9340:29f3745fd2c6

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