annotate DOCS/xml/en/skin.xml @ 33174:29c59e557575

Revise skin documentation. Move example behind positioning explanation (this was already the case in the German translation) and add explanation on X and Y parameters.
author ib
date Fri, 15 Apr 2011 09:24:00 +0000
parents 1dec9b8e53c6
children da4608a8c4df
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20535
c0687e92d463 convert DOCS/xml/en and help_mp-en.h to UTF-8
kraymer
parents: 19076
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
10913
49b1a67e7381 Add revision keyword to english xml files, to ease translation synchronization
lumag
parents: 10875
diff changeset
2 <!-- $Revision$ -->
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
3 <appendix id="skin">
11540
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
4 <title><application>MPlayer</application> skin format</title>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
5
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
6 <sect1 id="skin-overview">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
7 <title>Overview</title>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
8
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
9 <!-- ********** -->
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
10
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
11 <sect2 id="skin-overview-components">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
12 <title>Skin components</title>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
13
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
14 <para>
11715
ff768aa3c2fc missing <application> tags
paszczi
parents: 11540
diff changeset
15 Skins are quite free-format (unlike the fixed-format skins of
ff768aa3c2fc missing <application> tags
paszczi
parents: 11540
diff changeset
16 <application>Winamp</application>/<application>XMMS</application>,
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
17 for example), so it is up to you to create something great.
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
18 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
19
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
20 <para>
12405
e7bdd6e9c6f9 wrong number, pointed out by Scognito
diego
parents: 11715
diff changeset
21 Currently there are four windows to be decorated: the
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
22 <link linkend="skin-file-main">main window</link>, the
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
23 <link linkend="skin-file-subwindow">subwindow</link>, the
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
24 <link linkend="skin-file-main">playbar</link>, and the
32872
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
25 <link linkend="skin-file-menu">skin menu</link>.
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
26
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
27 <itemizedlist>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
28 <listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
29 <para>
32872
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
30 The <emphasis role="bold">main window</emphasis> is where you can control
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
31 <application>MPlayer</application>. The <emphasis role="bold">playbar</emphasis>
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
32 shows up in fullscreen mode when moving the mouse to the bottom of
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
33 the screen. The background of the windows is an image.
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
34 Various items can (and must) be placed in the window:
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
35 <emphasis>buttons</emphasis>, <emphasis>potmeters</emphasis> (sliders) and
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
36 <emphasis>labels</emphasis>.
11540
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
37 For every item, you must specify its position and size.
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
38 </para>
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29243
diff changeset
39
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
40 <para>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
41 A <emphasis role="bold">button</emphasis> has three states (pressed, released,
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
42 disabled), thus its image must be divided into three parts vertically. See the
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
43 <link linkend="skin-button">button</link> item for details.
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
44 </para>
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29243
diff changeset
45
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
46 <para>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
47 A <emphasis role="bold">potmeter</emphasis> (mainly used for the seek bar and
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
48 volume/balance control) can have any number of phases by dividing its image
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
49 into different parts below each other. See
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
50 <link linkend="skin-hpotmeter">hpotmeter</link> and
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
51 <link linkend="skin-potmeter">potmeter</link> for details.
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
52 </para>
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29243
diff changeset
53
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
54 <para>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
55 <emphasis role="bold">Labels</emphasis> are a bit special: The characters
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
56 needed to draw them are taken from an image file, and the characters in the
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
57 image are described by a
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
58 <link linkend="skin-fonts">font description file</link>.
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
59 The latter is a plain text file which specifies the x,y position and size of
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
60 each character in the image (the image file and its font description file
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
61 form a font <emphasis>together</emphasis>).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
62 See <link linkend="skin-dlabel">dlabel</link>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
63 and <link linkend="skin-slabel">slabel</link> for details.
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
64 </para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
65
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
66 <note><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
67 All images can have full transparency as described in the section about
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
68 <link linkend="skin-overview-formats">image formats</link>. If the X server
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
69 doesn't support the XShape extension, the parts marked transparent will be
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
70 black. If you'd like to use this feature, the width of the main window's
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
71 background image must be dividable by 8.
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
72 </para></note>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
73 </listitem>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
74
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
75 <listitem><para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
76 The <emphasis role="bold">subwindow</emphasis> is where the movie appears. It
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
77 can display a specified image if there is no movie loaded (it is quite boring
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
78 to have an empty window :-)) <emphasis role="bold">Note:</emphasis>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
79 transparency is <emphasis role="bold">not allowed</emphasis> here.
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
80 </para></listitem>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
81
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
82 <listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
83 <para>
11540
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
84 The <emphasis role="bold">skin menu</emphasis> is just a way to control
32872
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
85 <application>MPlayer</application> by means of menu entries (which can be
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
86 activated by a middle mouse button click). Two images
11540
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
87 are required for the menu: one of them is the base image that shows the
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
88 menu in its normal state, the other one is used to display the selected
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
89 entries. When you pop up the menu, the first image is shown. If you move
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
90 the mouse over the menu entries, the currently selected entry is copied
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
91 from the second image over the menu entry below the mouse pointer
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
92 (the second image is never shown as a whole).
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
93 </para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
94 <para>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
95 A menu entry is defined by its position and size in the image (see the
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
96 section about the <link linkend="skin-file-menu">skin menu</link> for
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
97 details).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
98 </para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
99 </listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
100 </itemizedlist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
101 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
102
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
103 <para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
104 There is an important thing not mentioned yet: For buttons, potmeters and
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
105 menu entries to work, <application>MPlayer</application> must know what to
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
106 do if they are clicked. This is done by <link linkend="skin-gui">messages</link>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
107 (events). For these items you must define the messages to be generated when
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
108 they are clicked.
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
109 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
110 </sect2>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
111
29242
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
112 <sect2 id="skin-overview-formats">
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
113 <title>Image formats</title>
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
114
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
115 <para>Images must be truecolor (24 or 32 bpp) PNGs.</para>
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
116 <para>
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
117 In the main window and in the playbar (see below) you can use images with
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
118 `transparency': Regions filled with the color #FF00FF (magenta) are fully
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
119 transparent when viewed by <application>MPlayer</application>. This means
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
120 that you can even have shaped windows if your X server has the XShape extension.
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
121 </para>
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
122 </sect2>
75dce2e34e81 Move image formats section to a more appropriate place.
diego
parents: 26958
diff changeset
123
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
124 <!-- ********** -->
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
125
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
126 <sect2 id="skin-files">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
127 <title>Files</title>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
128
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
129 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
130 You need the following files to build a skin:
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
131 <itemizedlist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
132 <listitem><para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
133 The configuration file named <link linkend="skin-file">skin</link> tells
11540
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
134 <application>MPlayer</application> how to put different parts of the skin
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
135 together and what to do if you click somewhere in the window.
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
136 </para></listitem>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
137 <listitem><para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
138 The background image for the main window.
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
139 </para></listitem>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
140 <listitem><para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
141 Images for the items in the main window (including one or more font
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
142 description files needed to draw labels).
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
143 </para></listitem>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
144 <listitem><para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
145 The image to be displayed in the subwindow (optional).
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
146 </para></listitem>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
147 <listitem><para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
148 Two images for the skin menu (they are needed only if you want to create
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
149 a menu).
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
150 </para></listitem>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
151 </itemizedlist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
152 With the exception of the skin configuration file, you can name the other
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
153 files whatever you want (but note that font description files must have
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
154 a <filename>.fnt</filename> extension).
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
155 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
156 </sect2>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
157 </sect1>
12815
3c99b7a8c840 trailing whitespace removed (cosmetics)
diego
parents: 12438
diff changeset
158
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
159
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
160 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
161
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
162
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
163 <sect1 id="skin-file">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
164 <title>The skin file</title>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
165
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
166 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
167 As mentioned above, this is the skin configuration file. It is line oriented;
33068
d32c24fea761 Correct documentation on comments.
ib
parents: 32910
diff changeset
168 comments start with a '<literal>;</literal>' character and continue until
33080
60b2e408bd78 Allow number sign as comment character.
ib
parents: 33070
diff changeset
169 the end of the line, or start with a '<literal>#</literal>' character at the
60b2e408bd78 Allow number sign as comment character.
ib
parents: 33070
diff changeset
170 beginning of the line (in that case only spaces and tabs are allowed before the
60b2e408bd78 Allow number sign as comment character.
ib
parents: 33070
diff changeset
171 '<literal>#</literal>').
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
172 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
173
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
174 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
175 The file is made up of sections. Each section describes the skin for an
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
176 application and has the following form:
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
177 <programlisting>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
178 section = <replaceable>section name</replaceable>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
179 .
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
180 .
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
181 .
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
182 end
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
183 </programlisting>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
184 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
185
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
186 <para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
187 Currently there is only one application, so you need only one section: its name
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
188 is <emphasis role="bold">movieplayer</emphasis>.
10111
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
189 </para>
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
190
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
191 <para>
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
192 Within this section each window is described by a block of the following form:
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
193 <programlisting>
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
194 window = <replaceable>window name</replaceable>
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
195 .
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
196 .
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
197 .
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
198 end
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
199 </programlisting>
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
200 </para>
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
201
a570a78537aa various fixes and updates
nicolas
parents: 9675
diff changeset
202 <para>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
203 where <replaceable>window name</replaceable> can be one of these strings:
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
204 <itemizedlist>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
205 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
206 <emphasis role="bold">main</emphasis> - for the main window
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
207 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
208 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
209 <emphasis role="bold">sub</emphasis> - for the subwindow
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
210 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
211 <listitem><para>
32872
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
212 <emphasis role="bold">playbar</emphasis> - for the playbar
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
213 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
214 <listitem><para>
32872
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
215 <emphasis role="bold">menu</emphasis> - for the skin menu
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
216 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
217 </itemizedlist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
218 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
219
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
220 <para>
32872
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
221 (The sub, playbar and menu blocks are optional - you do not need to decorate
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
222 the subwindow, have a playbar or create a menu. A default menu is always
e91f07a9d5cd Improve skin documentation.
ib
parents: 32740
diff changeset
223 available by a right mouse button click.)
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
224 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
225
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
226 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
227 Within a window block, you can define each item for the window by a line in
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
228 this form:
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
229 <programlisting>item = parameter</programlisting>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
230 Where <literal>item</literal> is a string that identifies the type of the GUI
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
231 item, <literal>parameter</literal> is a numeric or textual value (or a list of
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
232 values separated by commas).
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
233 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
234
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
235 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
236 Putting the above together, the whole file looks something like this:
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
237 <programlisting>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
238 section = movieplayer
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
239 window = main
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
240 ; ... items for main window ...
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
241 end
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
242
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
243 window = sub
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
244 ; ... items for subwindow ...
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
245 end
12815
3c99b7a8c840 trailing whitespace removed (cosmetics)
diego
parents: 12438
diff changeset
246
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
247 window = menu
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
248 ; ... items for menu ...
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
249 end
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
250
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
251 window = playbar
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
252 ; ... items for playbar ...
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
253 end
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
254 end
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
255 </programlisting>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
256 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
257
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
258 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
259 The name of an image file must be given without leading directories - images
17974
9a5a62f480e6 Rename the default GUI skins directory from 'Skin' to 'skins', keeping
diego
parents: 17276
diff changeset
260 are searched for in the <filename class="directory">skins</filename> directory.
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
261 You may (but you need not) specify the extension of the file. If the file does
11540
d480f7e36b74 <application> attack
wight
parents: 11444
diff changeset
262 not exist, <application>MPlayer</application> tries to load the file
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
263 <filename>&lt;filename&gt;.&lt;ext&gt;</filename>, where <literal>png</literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
264 and <literal>PNG</literal> are tried for <filename>&lt;ext&gt;</filename>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
265 (in this order). The first matching file will be used.
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
266 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
267
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
268 <para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
269 Finally some words about positioning. The main window and the subwindow can be
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
270 placed in the different corners of the screen by giving <literal>X</literal>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
271 and <literal>Y</literal> coordinates. <literal>0</literal> is top or left,
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
272 <literal>-1</literal> is center and <literal>-2</literal> is right or bottom, as
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
273 shown in this illustration:
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
274 <informalfigure>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
275 <screen>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
276 (0, 0)----(-1, 0)----(-2, 0)
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
277 | | |
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
278 | | |
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
279 (0,-1)----(-1,-1)----(-2,-1)
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
280 | | |
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
281 | | |
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
282 (0,-2)----(-1,-2)----(-2,-2)
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
283 </screen>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
284 </informalfigure>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
285 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
286
33174
29c59e557575 Revise skin documentation.
ib
parents: 33171
diff changeset
287 <para>
29c59e557575 Revise skin documentation.
ib
parents: 33171
diff changeset
288 Here is an example to make this clear. Suppose that you have an image called
29c59e557575 Revise skin documentation.
ib
parents: 33171
diff changeset
289 <filename>main.png</filename> that you use for the main window:
29c59e557575 Revise skin documentation.
ib
parents: 33171
diff changeset
290 <programlisting>base = main, -1, -1</programlisting>
29c59e557575 Revise skin documentation.
ib
parents: 33171
diff changeset
291 <application>MPlayer</application> tries to load <filename>main</filename>,
29c59e557575 Revise skin documentation.
ib
parents: 33171
diff changeset
292 <filename>main.png</filename>, <filename>main.PNG</filename> files and centers it.
29c59e557575 Revise skin documentation.
ib
parents: 33171
diff changeset
293 </para>
29c59e557575 Revise skin documentation.
ib
parents: 33171
diff changeset
294
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
295 <!-- ********** -->
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
296
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
297 <sect2 id="skin-file-main">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
298 <title>Main window and playbar</title>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
299
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
300 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
301 Below is the list of entries that can be used in the
11444
d6ef9000aed5 &nbsp; removed for added consistency, we do not use them anywhere else.
diego
parents: 10913
diff changeset
302 '<literal>window = main</literal>' ... '<literal>end</literal>',
d6ef9000aed5 &nbsp; removed for added consistency, we do not use them anywhere else.
diego
parents: 10913
diff changeset
303 and the '<literal>window = playbar</literal>' ... '<literal>end</literal>'
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
304 blocks.
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
305 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
306
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
307 <variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
308 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
309 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
310 <anchor id="skin-main-base"/>base = image, X, Y
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
311 </literal></term>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
312 <listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
313 <para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
314 Lets you specify the background image to be used for the main window.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
315 The window will appear at the given <literal>X,Y</literal> position on
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
316 the screen The window will have the size of the image.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
317 </para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
318 <note><para>
33171
1dec9b8e53c6 Revise skin documentation.
ib
parents: 33080
diff changeset
319 These coordinates do not currently work for the subwindow.
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
320 </para></note>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
321 <warning><para>Transparent regions in the image (colored #FF00FF) appear black
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
322 on X servers without the XShape extension. The image's width must be dividable
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
323 by 8.</para></warning>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
324 </listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
325 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
326
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
327 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
328 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
329 <anchor id="skin-button"/>button = image, X, Y, width, height, message
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
330 </literal></term>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
331 <listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
332 <para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
333 Place a button of <literal>width</literal> * <literal>height</literal> size at
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
334 position <literal>X,Y</literal>. The specified <literal>message</literal> is
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
335 generated when the button is clicked. The image given by
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
336 <literal>image</literal> must have three parts below each other (according to
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
337 the possible states of the button), like this:
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
338 </para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
339 <informalfigure>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
340 <screen>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
341 +------------+
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
342 | pressed |
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
343 +------------+
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
344 | released |
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
345 +------------+
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
346 | disabled |
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
347 +------------+<!--
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
348 --></screen>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
349 </informalfigure>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
350 </listitem>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
351 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
352
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
353 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
354 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
355 <anchor id="skin-decoration"/>decoration = enable|disable
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
356 </literal></term>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
357 <listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
358 <para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
359 Enable or disable window manager decoration of the main window. Default is
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
360 <emphasis role="bold">disable</emphasis>.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
361 </para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
362 <note><para>
33171
1dec9b8e53c6 Revise skin documentation.
ib
parents: 33080
diff changeset
363 This doesn't work for the subwindow, there is no need to.
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
364 </para></note>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
365 </listitem>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
366 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
367
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
368 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
369 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
370 <anchor id="skin-hpotmeter"/>hpotmeter = button, bwidth, bheight, phases, numphases, default, X, Y, width, height, message
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
371 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
372 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
373 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
374 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
375
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
376 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
377 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
378 <anchor id="skin-vpotmeter"/>vpotmeter = button, bwidth, bheight, phases, numphases, default, X, Y, width, height, message
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
379 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
380 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
381 Place a horizontal (hpotmeter) or vertical (vpotmeter) potmeter of
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
382 <literal>width</literal> * <literal>height</literal> size at position
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
383 <literal>X,Y</literal>. The image can be divided into different parts for the
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
384 different phases of the potmeter (for example, you can have a pot for volume
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
385 control that turns from green to red while its value changes from the minimum
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
386 to the maximum.). <literal>hpotmeter</literal> can have a button that can be
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
387 dragged horizontally. The parameters are:
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
388 <itemizedlist>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
389 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
390 <literal>button</literal> - the image to be used for the
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
391 button (must have three parts below each other, like in case of
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
392 <link linkend="skin-button">button</link>)
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
393 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
394 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
395 <literal>bwidth</literal>, <literal>bheight</literal> - size
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
396 of the button
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
397 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
398 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
399 <literal>phases</literal> - the image to be used for the
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
400 different phases of the hpotmeter. A special value of <literal>NULL</literal>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
401 can be used if you want no such image. The image must be divided into
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
402 <literal>numphases</literal> parts vertically like this:
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
403 <informalfigure><screen>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
404 +------------+
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
405 | phase #1 |
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
406 +------------+
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
407 | phase #2 |
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
408 +------------+
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
409 ...
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
410 +------------+
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
411 | phase #n |
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
412 +------------+<!--
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
413 --></screen></informalfigure>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
414 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
415 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
416 <literal>numphases</literal> - number of phases stored in the
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
417 <literal>phases</literal> image
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
418 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
419 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
420 <literal>default</literal> - default value for hpotmeter
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
421 (in the range <literal>0</literal> to <literal>100</literal>)
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
422 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
423 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
424 <literal>X</literal>, <literal>Y</literal> - position for the hpotmeter
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
425 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
426 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
427 <literal>width</literal>, <literal>height</literal> - width and height
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
428 of the <literal>hpotmeter</literal>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
429 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
430 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
431 <literal>message</literal> - the message to be generated when the
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
432 value of <literal>hpotmeter</literal> is changed
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
433 </para></listitem>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
434 </itemizedlist>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
435 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
436 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
437
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
438 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
439 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
440 <anchor id="skin-potmeter"/>potmeter = phases, numphases, default, X, Y, width, height, message
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
441 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
442 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
443 A <literal>hpotmeter</literal> without a button. (I guess it is meant to be
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
444 turned around, but it reacts to horizontal dragging only.) For the description
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
445 of the parameters see <link linkend="skin-hpotmeter">hpotmeter</link>.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
446 <literal>phases</literal> can be <literal>NULL</literal>, but it is quite
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
447 useless, since you cannot see where the <literal>potmeter</literal> is set.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
448 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
449 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
450
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
451 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
452 <term><literal>
32740
01e248c1b369 Remove needless fontid.
ib
parents: 32734
diff changeset
453 <anchor id="skin-font"/>font = fontfile
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
454 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
455 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
456 Defines a font. <literal>fontfile</literal> is the name of a font description
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
457 file with a <filename>.fnt</filename> extension (do not specify the extension
32740
01e248c1b369 Remove needless fontid.
ib
parents: 32734
diff changeset
458 here) and is used to refer to the font
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
459 (see <link linkend="skin-dlabel">dlabel</link>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
460 and <link linkend="skin-slabel">slabel</link>). Up to 25 fonts can be defined.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
461 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
462 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
463
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
464 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
465 <term><literal>
32740
01e248c1b369 Remove needless fontid.
ib
parents: 32734
diff changeset
466 <anchor id="skin-slabel"/>slabel = X, Y, fontfile, "text"
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
467 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
468 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
469 Place a static label at the position <literal>X,Y</literal>.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
470 <literal>text</literal> is displayed using the font identified by
32740
01e248c1b369 Remove needless fontid.
ib
parents: 32734
diff changeset
471 <literal>fontfile</literal>. The text is just a raw string
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
472 (<literal>$x</literal> variables do not work) that must be enclosed between
21596
f551403d82a9 replace &quot; with ", better readability
torinthiel
parents: 21521
diff changeset
473 double quotes (but the " character cannot be part of the text). The
32740
01e248c1b369 Remove needless fontid.
ib
parents: 32734
diff changeset
474 label is displayed using the font identified by <literal>fontfile</literal>.
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
475 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
476 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
477
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
478 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
479 <term><literal>
32910
f34e21c5dc2f Improve documentation on dlabel.
ib
parents: 32872
diff changeset
480 <anchor id="skin-dlabel"/>dlabel = X, Y, width, align, fontfile, "text"
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
481 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
482 <listitem>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
483 <para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
484 Place a dynamic label at the position <literal>X,Y</literal>. The label is
32910
f34e21c5dc2f Improve documentation on dlabel.
ib
parents: 32872
diff changeset
485 called dynamic because its text is refreshed periodically. The maximum width
f34e21c5dc2f Improve documentation on dlabel.
ib
parents: 32872
diff changeset
486 of the label is given by <literal>width</literal> (its height is the height
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
487 of a character). If the text to be displayed is wider than that, it will be
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
488 scrolled,
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
489 otherwise it is aligned within the specified space by the value of the
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
490 <literal>align</literal> parameter: <literal>0</literal> is for right,
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
491 <literal>1</literal> is for center, <literal>2</literal> is for left.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
492 </para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
493 <para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
494 The text to be displayed is given by <literal>text</literal>: It must be
21596
f551403d82a9 replace &quot; with ", better readability
torinthiel
parents: 21521
diff changeset
495 written between double quotes (but the " character cannot be part of the
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
496 text). The label is displayed using the font identified by
32740
01e248c1b369 Remove needless fontid.
ib
parents: 32734
diff changeset
497 <literal>fontfile</literal>. You can use the following variables in the text:
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
498 </para>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
499
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
500 <informaltable>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
501 <tgroup cols="2">
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
502 <thead>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
503 <row><entry>Variable</entry><entry>Meaning</entry></row>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
504 </thead>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
505 <tbody>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
506 <row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
507 <entry>$1</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
508 <entry>play time in <emphasis>hh:mm:ss</emphasis> format</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
509 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
510 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
511 <entry>$2</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
512 <entry>play time in <emphasis>mmmm:ss</emphasis> format</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
513 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
514 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
515 <entry>$3</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
516 <entry>play time in <emphasis>hh</emphasis> format (hours)</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
517 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
518 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
519 <entry>$4</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
520 <entry>play time in <emphasis>mm</emphasis> format (minutes)</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
521 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
522 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
523 <entry>$5</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
524 <entry>play time in <emphasis>ss</emphasis> format (seconds)</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
525 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
526 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
527 <entry>$6</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
528 <entry>movie length in <emphasis>hh:mm:ss</emphasis> format</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
529 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
530 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
531 <entry>$7</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
532 <entry>movie length in <emphasis>mmmm:ss</emphasis> format</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
533 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
534 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
535 <entry>$8</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
536 <entry>play time in <emphasis>h:mm:ss</emphasis> format</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
537 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
538 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
539 <entry>$v</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
540 <entry>volume in <emphasis>xxx.xx</emphasis>% format</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
541 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
542 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
543 <entry>$V</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
544 <entry>volume in <emphasis>xxx.xx</emphasis> format</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
545 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
546 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
547 <entry>$b</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
548 <entry>balance in <emphasis>xxx.xx</emphasis>% format</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
549 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
550 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
551 <entry>$B</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
552 <entry>balance in <emphasis>xxx.xx</emphasis> format</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
553 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
554 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
555 <entry>$$</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
556 <entry>the $ character</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
557 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
558 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
559 <entry>$a</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
560 <entry>a character according to the audio type (none: <literal>n</literal>,
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
561 mono: <literal>m</literal>, stereo: <literal>t</literal>)</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
562 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
563 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
564 <entry>$t</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
565 <entry>track number (in playlist)</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
566 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
567 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
568 <entry>$o</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
569 <entry>filename</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
570 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
571 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
572 <entry>$f</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
573 <entry>filename in lower case</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
574 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
575 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
576 <entry>$F</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
577 <entry>filename in upper case</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
578 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
579 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
580 <entry>$T</entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
581 <entry>
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
582 a character according to the stream type (file: <literal>f</literal>,
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
583 Video CD: <literal>v</literal>, DVD: <literal>d</literal>,
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
584 URL: <literal>u</literal>)
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
585 </entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
586 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
587 <row>
30990
0ad2da052b2e the great MPlayer tab removal: part I
diego
parents: 29263
diff changeset
588 <entry>$p</entry>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
589 <entry>the <keycap>p</keycap> character (if a movie is playing and the font
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
590 has the <keycap>p</keycap> character)</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
591 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
592 <row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
593 <entry>$s</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
594 <entry>the <keycap>s</keycap> character (if the movie is stopped and the
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
595 font has the <keycap>s</keycap> character)</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
596 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
597 <row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
598 <entry>$e</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
599 <entry>the <keycap>e</keycap> character (if playback is paused and the font
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
600 has the <keycap>e</keycap> character)</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
601 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
602 <row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
603 <entry>$x</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
604 <entry>movie width</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
605 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
606 <row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
607 <entry>$y</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
608 <entry>movie height</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
609 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
610 <row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
611 <entry>$C</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
612 <entry>name of the codec used</entry>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
613 </row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
614 </tbody>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
615 </tgroup>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
616 </informaltable>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
617
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
618 <note><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
619 The <literal>$a, $T, $p, $s</literal> and <literal>$e</literal>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
620 variables all return characters that should be displayed as special symbols
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
621 (for example, <keycap>e</keycap> is for the pause symbol that usually looks
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
622 something like ||). You should have a font for normal characters and
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
623 a different font for symbols. See the section about
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
624 <link linkend="skin-fonts-symbols">symbols</link> for more information.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
625 </para></note>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
626 </listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
627 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
628 </variablelist>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
629 </sect2>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
630
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
631 <!-- ********** -->
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
632
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
633 <sect2 id="skin-file-subwindow">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
634 <title>Subwindow</title>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
635
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
636 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
637 The following entries can be used in the
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
638 '<literal>window = sub</literal>' . . . '<literal>end</literal>' block.
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
639 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
640
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
641 <variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
642 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
643 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
644 <anchor id="skin-sub-base"/>base = image, X, Y, width, height
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
645 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
646 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
647 The image to be displayed in the window. The window will appear at the given
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
648 <literal>X,Y</literal> position on the screen (<literal>0,0</literal> is the
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
649 top left corner). You can specify <literal>-1</literal> for center and
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
650 <literal>-2</literal> for right (<literal>X</literal>) and bottom
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
651 (<literal>Y</literal>). The window will be as large as the image.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
652 <literal>width</literal> and <literal>height</literal>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
653 denote the size of the window; they are optional (if they are missing, the
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
654 window is the same size as the image).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
655 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
656 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
657
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
658 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
659 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
660 <anchor id="skin-background"/>background = R, G, B
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
661 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
662 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
663 Lets you set the background color. It is useful if the image is smaller than
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
664 the window. <literal>R</literal>, <literal>G</literal> and
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
665 <literal>B</literal> specifies the red, green and blue component of the color
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
666 (each of them is a decimal number from 0 to 255).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
667 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
668 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
669 </variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
670 </sect2>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
671
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
672 <!-- ********** -->
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
673
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
674 <sect2 id="skin-file-menu">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
675 <title>Skin menu</title>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
676
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
677 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
678 As mentioned earlier, the menu is displayed using two images. Normal menu
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
679 entries are taken from the image specified by the <literal>base</literal> item,
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
680 while the currently selected entry is taken from the image specified by the
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
681 <literal>selected</literal> item. You must define the position and size of each
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
682 menu entry through the menu item.
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
683 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
684
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
685 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
686 The following entries can be used in the
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
687 '<literal>window = menu</literal>'. . .'<literal>end</literal>' block.
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
688 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
689
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
690 <variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
691 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
692 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
693 <anchor id="skin-menu-base"/>base = image
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
694 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
695 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
696 The image for normal menu entries.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
697 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
698 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
699
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
700 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
701 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
702 <anchor id="skin-selected"/>selected = image
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
703 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
704 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
705 The image showing the menu with all entries selected.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
706 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
707 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
708
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
709 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
710 <term><literal>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
711 <anchor id="skin-menu"/>menu = X, Y, width, height, message
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
712 </literal></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
713 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
714 Defines the <literal>X,Y</literal> position and the size of a menu entry in
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
715 the image. <literal>message</literal> is the message to be generated when the
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
716 mouse button is released over the entry.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
717 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
718 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
719 </variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
720 </sect2>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
721 </sect1>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
722
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
723
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
724 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
725
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
726
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
727 <sect1 id="skin-fonts">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
728 <title>Fonts</title>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
729 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
730 As mentioned in the section about the parts of a skin, a font is defined by an
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
731 image and a description file. You can place the characters anywhere in the
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
732 image, but make sure that their position and size is given in the description
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
733 file exactly.
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
734 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
735
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
736 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
737 The font description file (with <filename>.fnt</filename> extension) can have
33080
60b2e408bd78 Allow number sign as comment character.
ib
parents: 33070
diff changeset
738 comments like the skin configuration file starting with '<literal>;</literal>'
60b2e408bd78 Allow number sign as comment character.
ib
parents: 33070
diff changeset
739 (or '<literal>#</literal>', but only at the beginning of the line). The file must have a line
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
740 in the form
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
741 <anchor id="skin-font-image"/>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
742 <programlisting>image = <replaceable>image</replaceable></programlisting>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
743 Where <literal><replaceable>image</replaceable></literal> is the name of the
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
744 image file to be used for the font (you do not have to specify the extension).
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
745 <anchor id="skin-font-char"/>
21596
f551403d82a9 replace &quot; with ", better readability
torinthiel
parents: 21521
diff changeset
746 <programlisting>"char" = X, Y, width, height</programlisting>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
747 Here <literal>X</literal> and <literal>Y</literal> specify the position of the
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
748 <literal>char</literal> character in the image (<literal>0,0</literal> is the
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
749 upper left corner). <literal>width</literal> and <literal>height</literal> are
32734
cc58a1e919d9 Allow character in the font description file to be in UTF-8.
ib
parents: 30990
diff changeset
750 the dimensions of the character in pixels. The character may be in UTF-8
cc58a1e919d9 Allow character in the font description file to be in UTF-8.
ib
parents: 30990
diff changeset
751 encoding.
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
752 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
753
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
754 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
755 This example defines the A, B, C characters using <filename>font.png</filename>.
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
756 <programlisting>
21596
f551403d82a9 replace &quot; with ", better readability
torinthiel
parents: 21521
diff changeset
757 ; Can be "font" instead of "font.png".
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
758 image = font.png
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
759
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
760 ; Three characters are enough for demonstration purposes :-)
21596
f551403d82a9 replace &quot; with ", better readability
torinthiel
parents: 21521
diff changeset
761 "A" = 0,0, 7,13
f551403d82a9 replace &quot; with ", better readability
torinthiel
parents: 21521
diff changeset
762 "B" = 7,0, 7,13
f551403d82a9 replace &quot; with ", better readability
torinthiel
parents: 21521
diff changeset
763 "C" = 14,0, 7,13
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
764 </programlisting>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
765 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
766
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
767 <!-- ********** -->
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
768
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
769 <sect2 id="skin-fonts-symbols">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
770 <title>Symbols</title>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
771
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
772 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
773 Some characters have special meanings when returned by some of the variables
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
774 used in <link linkend="skin-dlabel">dlabel</link>. These characters are meant
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
775 to be shown as symbols so that things like a nice DVD logo can be displayed
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
776 instead of the character '<literal>d</literal>' for a DVD stream.
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
777 </para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
778
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
779 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
780 The following table lists all the characters that can be used to display
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
781 symbols (and thus require a different font).
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
782 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
783
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
784 <informaltable>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
785 <tgroup cols="2">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
786 <thead>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
787 <row><entry>Character</entry><entry>Symbol</entry></row>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
788 </thead>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
789 <tbody>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
790 <row><entry><keycap>p</keycap></entry><entry>play</entry></row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
791 <row><entry><keycap>s</keycap></entry><entry>stop</entry></row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
792 <row><entry><keycap>e</keycap></entry><entry>pause</entry></row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
793 <row><entry><keycap>n</keycap></entry><entry>no sound</entry></row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
794 <row><entry><keycap>m</keycap></entry><entry>mono sound</entry></row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
795 <row><entry><keycap>t</keycap></entry><entry>stereo sound</entry></row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
796 <row><entry><keycap>f</keycap></entry><entry>stream is a file</entry></row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
797 <row><entry><keycap>v</keycap></entry><entry>stream is a Video CD</entry></row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
798 <row><entry><keycap>d</keycap></entry><entry>stream is a DVD</entry></row>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
799 <row><entry><keycap>u</keycap></entry><entry>stream is a URL</entry></row>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
800 </tbody>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
801 </tgroup>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
802 </informaltable>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
803 </sect2>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
804 </sect1>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
805
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
806
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
807 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
808
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
809
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
810 <sect1 id="skin-gui">
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
811 <title>GUI messages</title>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
812
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
813 <para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
814 These are the messages that can be generated by buttons, potmeters and
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
815 menu entries.
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
816 </para>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
817
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
818 <variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
819 <title>Playback control:</title>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
820 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
821 <term><emphasis role="bold">evNext</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
822 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
823 Jump to next track in the playlist.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
824 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
825 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
826
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
827 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
828 <term><emphasis role="bold">evPause</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
829 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
830 Forms a switch together with <literal>evPlaySwitchToPause</literal>. They can
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
831 be used to have a common play/pause button. Both messages should be assigned
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
832 to buttons displayed at the very same position in the window. This message
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
833 pauses playing and the image for the <literal>evPlaySwitchToPause</literal>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
834 button is displayed (to indicate that the button can be pressed to continue
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
835 playing).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
836 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
837 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
838
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
839 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
840 <term><emphasis role="bold">evPlay</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
841 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
842 Start playing.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
843 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
844 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
845
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
846 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
847 <term><emphasis role="bold">evPlaySwitchToPause</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
848 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
849 The opposite of <literal>evPauseSwitchToPlay</literal>. This message starts
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
850 playing and the image for the <literal>evPauseSwitchToPlay</literal> button
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
851 is displayed (to indicate that the button can be pressed to pause playing).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
852 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
853 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
854
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
855 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
856 <term><emphasis role="bold">evPrev</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
857 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
858 Jump to previous track in the playlist.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
859 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
860 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
861
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
862 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
863 <term><emphasis role="bold">evStop</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
864 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
865 Stop playing.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
866 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
867 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
868 </variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
869
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
870 <variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
871 <title>Seeking:</title>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
872 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
873 <term><emphasis role="bold">evBackward10sec</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
874 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
875 Seek backward 10 seconds.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
876 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
877 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
878
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
879 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
880 <term><emphasis role="bold">evBackward1min</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
881 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
882 Seek backward 1 minute.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
883 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
884 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
885
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
886 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
887 <term><emphasis role="bold">evBackward10min</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
888 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
889 Seek backward 10 minutes.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
890 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
891 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
892
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
893 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
894 <term><emphasis role="bold">evForward10sec</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
895 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
896 Seek forward 10 seconds.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
897 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
898 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
899
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
900 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
901 <term><emphasis role="bold">evForward1min</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
902 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
903 Seek forward 1 minute.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
904 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
905 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
906
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
907 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
908 <term><emphasis role="bold">evForward10min</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
909 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
910 Seek forward 10 minutes.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
911 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
912 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
913
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
914 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
915 <term><emphasis role="bold">evSetMoviePosition</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
916 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
917 Seek to position (can be used by a potmeter; the
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
918 relative value (0-100%) of the potmeter is used).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
919 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
920 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
921 </variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
922
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
923 <variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
924 <title>Video control:</title>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
925 <varlistentry>
14589
9635dcba8f29 Add half size entry to the GMPlayer menu.
diego
parents: 13752
diff changeset
926 <term><emphasis role="bold">evHalfSize</emphasis></term>
9635dcba8f29 Add half size entry to the GMPlayer menu.
diego
parents: 13752
diff changeset
927 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
928 Set the movie window to half size.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
929 </para></listitem>
14589
9635dcba8f29 Add half size entry to the GMPlayer menu.
diego
parents: 13752
diff changeset
930 </varlistentry>
9635dcba8f29 Add half size entry to the GMPlayer menu.
diego
parents: 13752
diff changeset
931 <varlistentry>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
932 <term><emphasis role="bold">evDoubleSize</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
933 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
934 Set the movie window to double size.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
935 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
936 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
937 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
938 <term><emphasis role="bold">evFullScreen</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
939 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
940 Switch fullscreen mode on/off.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
941 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
942 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
943 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
944 <term><emphasis role="bold">evNormalSize</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
945 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
946 Set the movie window to its normal size.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
947 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
948 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
949 </variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
950
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
951 <variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
952 <title>Audio control:</title>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
953 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
954 <term><emphasis role="bold">evDecAudioBufDelay</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
955 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
956 Decrease audio buffer delay.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
957 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
958 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
959
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
960 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
961 <term><emphasis role="bold">evDecBalance</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
962 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
963 Decrease balance.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
964 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
965 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
966
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
967 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
968 <term><emphasis role="bold">evDecVolume</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
969 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
970 Decrease volume.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
971 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
972 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
973
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
974 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
975 <term><emphasis role="bold">evIncAudioBufDelay</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
976 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
977 Increase audio buffer delay.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
978 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
979 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
980
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
981 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
982 <term><emphasis role="bold">evIncBalance</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
983 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
984 Increase balance.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
985 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
986 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
987
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
988 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
989 <term><emphasis role="bold">evIncVolume</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
990 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
991 Increase volume.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
992 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
993 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
994
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
995 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
996 <term><emphasis role="bold">evMute</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
997 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
998 Mute/unmute the sound.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
999 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1000 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1001
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1002 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1003 <term><emphasis role="bold">evSetBalance</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1004 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1005 Set balance (can be used by a potmeter; the
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1006 relative value (0-100%) of the potmeter is used).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1007 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1008 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1009
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1010 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1011 <term><emphasis role="bold">evSetVolume</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1012 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1013 Set volume (can be used by a potmeter; the relative
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1014 value (0-100%) of the potmeter is used).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1015 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1016 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1017 </variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1018
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1019 <variablelist>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1020 <title>Miscellaneous:</title>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1021 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1022 <term><emphasis role="bold">evAbout</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1023 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1024 Open the about window.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1025 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1026 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1027
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1028 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1029 <term><emphasis role="bold">evDropSubtitle</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1030 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1031 Disables the currently used subtitle.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1032 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1033 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1034
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1035 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1036 <term><emphasis role="bold">evEqualizer</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1037 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1038 Turn the equalizer on/off.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1039 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1040 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1041
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1042 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1043 <term><emphasis role="bold">evExit</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1044 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1045 Quit the program.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1046 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1047 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1048
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1049 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1050 <term><emphasis role="bold">evIconify</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1051 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1052 Iconify the window.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1053 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1054 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1055
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1056 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1057 <term><emphasis role="bold">evLoad</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1058 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1059 Load a file (by opening a file browser window, where you can choose a file).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1060 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1061 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1062
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1063 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1064 <term><emphasis role="bold">evLoadPlay</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1065 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1066 Does the same as <literal>evLoad</literal>, but it automatically starts
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1067 playing after the file is loaded.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1068 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1069 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1070
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1071 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1072 <term><emphasis role="bold">evLoadSubtitle</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1073 <listitem><para>
26958
b89c59df8ba6 Run the whole documentation through ispell.
diego
parents: 21596
diff changeset
1074 Loads a subtitle file (with the file selector).
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1075 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1076 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1077
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1078 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1079 <term><emphasis role="bold">evLoadAudioFile</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1080 <listitem><para>
26958
b89c59df8ba6 Run the whole documentation through ispell.
diego
parents: 21596
diff changeset
1081 Loads an audio file (with the file selector).
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1082 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1083 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1084
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1085 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1086 <term><emphasis role="bold">evNone</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1087 <listitem><para>
33070
bcbe6228cc82 Revise German documentation concerning events.
ib
parents: 33068
diff changeset
1088 Empty message, it has no effect.
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1089 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1090 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1091
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1092 <varlistentry>
13752
e193600132d5 Important typo noticed by Piero di Vita <scognito at libero dot it>
diego
parents: 12815
diff changeset
1093 <term><emphasis role="bold">evPlaylist</emphasis></term>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1094 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1095 Open/close the playlist window.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1096 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1097 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1098
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1099 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1100 <term><emphasis role="bold">evPlayDVD</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1101 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1102 Tries to open the disc in the given DVD-ROM drive.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1103 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1104 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1105
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1106 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1107 <term><emphasis role="bold">evPlayVCD</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1108 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1109 Tries to open the disc in the given CD-ROM drive.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1110 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1111 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1112
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1113 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1114 <term><emphasis role="bold">evPreferences</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1115 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1116 Open the preferences window.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1117 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1118 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1119
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1120 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1121 <term><emphasis role="bold">evSetAspect</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1122 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1123 Sets displayed image aspect.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1124 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1125 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1126
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1127 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1128 <term><emphasis role="bold">evSetURL</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1129 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1130 Displays the URL dialog window.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1131 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1132 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1133
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1134 <varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1135 <term><emphasis role="bold">evSkinBrowser</emphasis></term>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1136 <listitem><para>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1137 Open the skin browser window.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1138 </para></listitem>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1139 </varlistentry>
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1140 </variablelist>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1141 </sect1>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1142
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1143
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1144 <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1145
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1146
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1147 <sect1 id="skin-quality">
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1148 <title>Creating quality skins</title>
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1149
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1150 <para>
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1151 So you have read up on creating skins for the
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1152 <application>MPlayer</application> GUI, done your best with the
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1153 <application>Gimp</application> and wish to submit your skin to us?
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1154 Read on for some guidelines to avoid common mistakes and produce
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1155 a high quality skin.
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1156 </para>
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1157
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1158 <para>
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1159 We want skins that we add to our repository to conform to certain
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1160 quality standards. There are also a number of things that you can do
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1161 to make our lives easier.
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1162 </para>
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1163
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1164 <para>
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1165 As an example you can look at the <systemitem>Blue</systemitem> skin,
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1166 it satisfies all the criteria listed below since version 1.5.
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1167 </para>
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1168
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1169 <itemizedlist>
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1170 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1171 Each skin should come with a
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1172 <filename>README</filename> file that contains information about
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1173 you, the author, copyright and license notices and anything else
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1174 you wish to add. If you wish to have a changelog, this file is a
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1175 good place.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1176 </para></listitem>
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1177
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1178 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1179 There should be a file <filename>VERSION</filename>
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1180 with nothing more than the version number of the skin on a single
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1181 line (e.g. 1.0).
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1182 </para></listitem>
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1183
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1184 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1185 Horizontal and vertical controls (sliders like volume
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1186 or position) should have the center of the knob properly centered on
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1187 the middle of the slider. It should be possible to move the knob to
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1188 both ends of the slider, but not past it.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1189 </para></listitem>
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1190
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1191 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1192 Skin elements should have the right sizes declared
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1193 in the skin file. If this is not the case you can click outside of
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1194 e.g. a button and still trigger it or click inside its area and not
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1195 trigger it.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1196 </para></listitem>
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1197
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1198 <listitem><para>
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1199 The <filename>skin</filename> file should be
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1200 prettyprinted and not contain tabs. Prettyprinted means that the
21521
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1201 numbers should line up neatly in columns.
b210a229fbcb General reformatting round:
torinthiel
parents: 20535
diff changeset
1202 </para></listitem>
17276
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1203 </itemizedlist>
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1204
3f842e148e1c Guide on creating quality skins.
diego
parents: 17159
diff changeset
1205 </sect1>
9675
62c5a17038ba XML version of MPlayer's doc
nicolas
parents:
diff changeset
1206 </appendix>