]> git.donarmstrong.com Git - dactyl.git/blob - melodactyl/locale/en-US/player.xml
Initial import of 1.0~b6
[dactyl.git] / melodactyl / locale / en-US / player.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>
3
4 <!DOCTYPE document SYSTEM "dactyl://content/dtd">
5
6 <document
7     name="player"
8     title="&dactyl.appName; Player mode"
9     xmlns="&xmlns.dactyl;"
10     xmlns:html="&xmlns.html;">
11
12 <h1 tag="player-mode player">Player mode</h1>
13 <toc start="2"/>
14
15 <p>
16     The following features apply to Player mode which is activated when the
17     media tab has focus.
18 </p>
19
20 <h2 tag="playing-tracks">Playing tracks</h2>
21
22 <item>
23     <tags>p_x :playerp :playerplay</tags>
24     <spec>:<oa>count</oa>playerp<oa>lay</oa></spec>
25     <spec><oa>count</oa>x</spec>
26     <description>
27         <p>
28             Play the current track.
29         </p>
30     </description>
31 </item>
32
33 <item>
34     <tags>p_z :playerpr :playerprev</tags>
35     <spec>:<oa>count</oa>playerpr<oa>ev</oa></spec>
36     <spec><oa>count</oa>z</spec>
37     <description>
38         <p>
39             Play the previous track.
40         </p>
41     </description>
42 </item>
43
44 <item>
45     <tags>p_b :playern :playernext</tags>
46     <spec>:playern<oa>ext</oa></spec>
47     <spec>b</spec>
48     <description>
49         <p>
50             Play the next track.
51         </p>
52     </description>
53 </item>
54
55 <item>
56     <tags>p_c :playerpa :playerpause</tags>
57     <spec>:playerpa<oa>use</oa></spec>
58     <spec>c</spec>
59     <description>
60         <p>
61             Pause/unpause the current track.
62         </p>
63     </description>
64 </item>
65
66 <item>
67     <tags>p_v :playerps :playerstop</tags>
68     <spec>:playerps<oa>top</oa></spec>
69     <spec>v</spec>
70     <description>
71         <p>
72             Stop playing the current track.
73         </p>
74     </description>
75 </item>
76
77 <item>
78     <tags>p_s</tags>
79     <spec>s</spec>
80     <description>
81         <p>
82             Toggle shuffle mode.
83         </p>
84     </description>
85 </item>
86
87 <item>
88     <tags>p_r</tags>
89     <spec>r</spec>
90     <description>
91         <p>
92             Toggle repeat mode.
93         </p>
94     </description>
95 </item>
96
97 <item>
98     <tags>p_i</tags>
99     <spec>i</spec>
100     <description>
101         <p>
102             Select the currently playing track.
103         </p>
104     </description>
105 </item>
106
107 <h2 tag="queue queueing">Queueing tracks</h2>
108
109 <item>
110     <tags>p_Q :qu :queue</tags>
111     <spec>:qu<oa>eue</oa> <a>artist</a> <oa>album</oa> <oa>track</oa></spec>
112     <spec>Q</spec>
113     <description>
114         <p>
115             Queue tracks by artist/album/track. If only <a>artist</a> is
116             specified then all tracks for that artist are played in album
117             order. If <oa>album</oa> is also specified then all tracks for that
118             album are played. A specific track can be specified with
119             <oa>track</oa>.
120         </p>
121     </description>
122 </item>
123
124 <h2 tag="filter filtering">Filtering the library</h2>
125
126 <item>
127     <tags>p_f :f :filter</tags>
128     <spec>:f<oa>ilter</oa> <a>keywords</a></spec>
129     <spec>f</spec>
130     <description>
131         <p>
132             Filter and show the tracks as a view. The tracks are filtered by
133             the <a>keywords</a> provided as arguments. This text search applies
134             over the default filter properties, namely: Genre, Artist, Album
135             and Track.
136         </p>
137     </description>
138 </item>
139
140 <h2 tag="seeking">Seeking to a track position</h2>
141
142 <item>
143     <tags><![CDATA[p_<Left> p_h]]></tags>
144     <spec><oa>count</oa>h</spec>
145     <description>
146         <p>
147             Seek +10s.
148         </p>
149     </description>
150 </item>
151
152 <item>
153     <tags><![CDATA[p_<Right> p_l]]></tags>
154     <spec><oa>count</oa>l</spec>
155     <description>
156         <p>
157             Seek -10s.
158         </p>
159     </description>
160 </item>
161
162 <item>
163     <tags><![CDATA[p_<S-Left> p_H]]></tags>
164     <spec><oa>count</oa>H</spec>
165     <description>
166         <p>
167             Seek +1m.
168         </p>
169     </description>
170 </item>
171
172 <item>
173     <tags><![CDATA[p_<S-Right> p_L]]></tags>
174     <spec><oa>count</oa>L</spec>
175     <description>
176         <p>
177             Seek -1m.
178         </p>
179     </description>
180 </item>
181
182 <item>
183     <tags>:see :seek</tags>
184     <spec>:see<oa>k</oa> <a>[HH:]MM:SS]</a></spec>
185     <spec>:see<oa>k</oa> +<a>time[hms]</a> | -<a>time[hms]</a></spec>
186     <description>
187         <p>
188             Seek to an absolute or relative position in a track. The position
189             can be given in seconds (s), minutes (m), or hours (h). If the unit
190             is not specified then seconds is assumed. The position is absolute
191             unless the value is prefixed with "-" or "+".
192         </p>
193         <p>
194             Positions may also be specified in <a>[HH:]MM:SS</a> format.
195         </p>
196     </description>
197 </item>
198
199 <h2 tag="volume">Adjusting the volume</h2>
200
201 <item>
202     <tags>p_+ p_=</tags>
203     <spec>+</spec>
204     <spec>=</spec>
205     <description>
206         <p>
207             Increase volume by 5% of the maximum.
208         </p>
209     </description>
210 </item>
211
212 <item>
213     <tags>p_-</tags>
214     <spec>-</spec>
215     <description>
216         <p>
217             Decrease volume by 5% of the maximum.
218         </p>
219     </description>
220 </item>
221
222 <item>
223     <tags>:vol :volume</tags>
224     <spec>vol<oa>[ume]</oa> <a>value</a></spec>
225     <spec>vol<oa>[ume]</oa> +<a>value</a> | -<a>value</a></spec>
226     <description>
227         <p>
228             Set the player volume. <a>value</a> can be an absolute value
229             between 0 and 100% or a relative value if prefixed with "-" or "+".
230         </p>
231     </description>
232 </item>
233
234 <h2 tag="playlists">Managing playlists</h2>
235
236 <item>
237     <tags>:load</tags>
238     <spec>:load <oa>playlist</oa></spec>
239     <description>
240         <p>
241             Load <a>playlist</a>. If no playlist is specified then the main
242             library view is loaded.
243         </p>
244     </description>
245 </item>
246
247 <h2 tag="media-view view">Changing media views</h2>
248
249 <item>
250     <tags>:mediav :mediaview</tags>
251     <spec>:mediav<oa>ew</oa> <a>view</a></spec>
252     <description>
253         <p>
254             Change the media view to <a>view</a>. This can only be run when the
255             media tab is the current tab.
256         </p>
257     </description>
258 </item>
259
260 <h2 tag="search">Search commands</h2>
261
262 <item>
263     <tags>p_/</tags>
264     <spec>/<a>pattern</a></spec>
265     <description>
266         <p>
267             Search forward for a track matching <a>pattern</a> in the visible
268             media view.
269         </p>
270     </description>
271 </item>
272
273 <!--
274 <item>
275     <tags>p_?</tags>
276     <spec>?<a>pattern</a></spec>
277     <description>
278         <p>
279             Search backwards for a track matching <a>pattern</a> in the visible
280             media view.
281         </p>
282     </description>
283 </item>
284 -->
285
286 <item>
287     <tags>p_n</tags>
288     <spec>n</spec>
289     <description>
290         <p>
291             Find the next track. Repeats the last search. If the search hits
292             BOTTOM of the view, it continues from TOP.
293         </p>
294     </description>
295 </item>
296
297 <item>
298     <tags>p_N</tags>
299     <spec>N</spec>
300     <description>
301         <p>
302             Find the previous track. Repeats the last search in the opposite
303             direction. If the search hits TOP of the view, it continues from
304             BOTTTOM.
305         </p>
306     </description>
307 </item>
308
309 <h2 tag="rating">Rating tracks</h2>
310
311 <item>
312     <tags><![CDATA[p_<C-5> p_<C-4> p_<C-3> p_<C-2> p_<C-1> p_<C-0>]]></tags>
313     <spec><![CDATA[<C-0>]]></spec>
314     <spec><![CDATA[<C-1>]]></spec>
315     <spec><![CDATA[<C-2>]]></spec>
316     <spec><![CDATA[<C-3>]]></spec>
317     <spec><![CDATA[<C-4>]]></spec>
318     <spec><![CDATA[<C-5>]]></spec>
319     <description>
320         <p>
321             Rate the current track with N stars.
322         </p>
323     </description>
324 </item>
325
326 </document>
327
328 <!-- vim:se sts=4 sw=4 et: -->