diff options
Diffstat (limited to 'manual/rockbox_interface/wps.tex')
-rw-r--r-- | manual/rockbox_interface/wps.tex | 265 |
1 files changed, 265 insertions, 0 deletions
diff --git a/manual/rockbox_interface/wps.tex b/manual/rockbox_interface/wps.tex new file mode 100644 index 0000000000..8e8315cf53 --- /dev/null +++ b/manual/rockbox_interface/wps.tex | |||
@@ -0,0 +1,265 @@ | |||
1 | % $Id$ % | ||
2 | \section{\label{ref:WPS}While Playing Screen} | ||
3 | The While Playing Screen (WPS) displays various pieces of information about the | ||
4 | currently playing audio file. | ||
5 | % | ||
6 | \opt{HAVE_LCD_BITMAP}{% | ||
7 | The apperance of the WPS can be configured using wps configuration files. | ||
8 | The items shown depend on your configuration -- all item can be turned on | ||
9 | or off independently. Refer to \pageref{ref:wps_tags} for details on how | ||
10 | to change the display of the WPS. | ||
11 | \begin{itemize} | ||
12 | \item Status bar: The Status bar shows Battery level, charger status, | ||
13 | volume, play mode, repeat mode, shuffle mode\opt{CONFIG_RTC}{ and clock}. | ||
14 | In contrast to all other item the status bar is always at the top of | ||
15 | the screen. | ||
16 | \item (Scrolling) path and filename of the current song. | ||
17 | \item The ID3 track name. | ||
18 | \item The ID3 album name. | ||
19 | \item The ID3 artist name. | ||
20 | \item Bit rate. VBR files display average bitrate and ``(avg)'' | ||
21 | \item Elapsed and total time. | ||
22 | \item A slidebar progress meter representing where in the song you are. | ||
23 | \item Peak meter. | ||
24 | \end{itemize} | ||
25 | } | ||
26 | \opt{recorder,recorderv2fm,ondio}{ | ||
27 | \note{ | ||
28 | \begin{itemize} | ||
29 | \item The number of lines shown depends on the size of the font used. | ||
30 | \item The peak meter is only visible if you turn off the status bar or if | ||
31 | using a small font that gives 8 or more display lines. | ||
32 | \end{itemize} | ||
33 | } | ||
34 | } | ||
35 | % | ||
36 | \opt{player}{ | ||
37 | \note{ | ||
38 | \begin{itemize} | ||
39 | \item Playlist index/Playlist size: Artist {}- Title. | ||
40 | \item Current{}-time Progress{}-indicator Left. | ||
41 | \end{itemize} | ||
42 | } | ||
43 | } | ||
44 | |||
45 | See page \pageref{ref:ConfiguringtheWPS} for details of customising | ||
46 | your WPS (While Playing Screen). | ||
47 | |||
48 | |||
49 | \subsection{\label{ref:WPS_Key_Controls}WPS Key Controls} | ||
50 | |||
51 | \begin{table} | ||
52 | \begin{btnmap}{}{} | ||
53 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,ONDIO_PAD}{\ButtonUp/\ButtonDown} | ||
54 | \opt{IAUDIO_X5_PAD}{Please add correct keys} | ||
55 | \opt{IPOD_4G_PAD}{Please add correct keys} | ||
56 | \opt{PLAYER_PAD}{\ButtonMenu+\ButtonRight/\ButtonLeft} | ||
57 | & Volume up/down \\ | ||
58 | % | ||
59 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,ONDIO_PAD,RECORDER_PAD,PLAYER_PAD}{\ButtonLeft} | ||
60 | \opt{IPOD_4G_PAD}{Please add correct keys} | ||
61 | & Go to beginning of track, or if pressed while in the first seconds of a track, | ||
62 | go to previous track. \\ | ||
63 | % | ||
64 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,ONDIO_PAD,RECORDER_PAD,PLAYER_PAD}{Hold \ButtonLeft} | ||
65 | \opt{IPOD_4G_PAD}{Please add correct keys} | ||
66 | & Rewind in track \\ | ||
67 | % | ||
68 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,ONDIO_PAD,RECORDER_PAD,PLAYER_PAD}{\ButtonRight} | ||
69 | \opt{IPOD_4G_PAD}{Please add correct keys} | ||
70 | & Go to next track. \\ | ||
71 | % | ||
72 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,ONDIO_PAD,RECORDER_PAD,PLAYER_PAD}{Hold \ButtonRight} | ||
73 | \opt{IPOD_4G_PAD}{Please add correct keys} | ||
74 | & Fast forward in track. \\ | ||
75 | % | ||
76 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn} | ||
77 | \opt{IPOD_4G_PAD,IAUDIO_X5_PAD,RECORDER_PAD,PLAYER_PAD}{\ButtonPlay} | ||
78 | \opt{ONDIO_PAD}{\ButtonOff} | ||
79 | & Toggle play/pause \\ | ||
80 | % | ||
81 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect} | ||
82 | \opt{ONDIO_PAD}{\ButtonMenu} | ||
83 | \opt{RECORDER_PAD,PLAYER_PAD}{\ButtonOn} | ||
84 | \opt{IAUDIO_X5_PAD}{Please add correct keys} | ||
85 | \opt{IPOD_4G_PAD}{Please add correct keys} | ||
86 | & Go to file browser \\ | ||
87 | % | ||
88 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{Hold \ButtonSelect} | ||
89 | \opt{ONDIO_PAD}{Hold \ButtonMenu} | ||
90 | \opt{RECORDER_PAD,PLAYER_PAD}{Hold \ButtonOn} | ||
91 | \opt{IAUDIO_X5_PAD}{Please add correct keys} | ||
92 | \opt{IPOD_4G_PAD}{Please add correct keys} | ||
93 | & Enter WPS context menu \\ | ||
94 | % | ||
95 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{Hold \ButtonOn} | ||
96 | \opt{IAUDIO_X5_PAD}{Please add correct keys} | ||
97 | \opt{IPOD_4G_PAD}{Please add correct keys} | ||
98 | \opt{PLAYER_PAD}{n/a} | ||
99 | \opt{ONDIO_PAD}{In WPS context menu} | ||
100 | & Show pitch setting screen \\ | ||
101 | % | ||
102 | \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff} | ||
103 | \opt{ONDIO_PAD}{Hold \ButtonOff} | ||
104 | \opt{IAUDIO_X5_PAD}{Please add correct keys} | ||
105 | \opt{IPOD_4G_PAD}{Please add correct keys} | ||
106 | \opt{PLAYER_PAD}{\ButtonStop} | ||
107 | & Stop playback \\ | ||
108 | % | ||
109 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect} | ||
110 | \opt{RECORDER_PAD}{\ButtonFOne} | ||
111 | \opt{PLAYER_PAD,ONDIO_PAD}{\ButtonMenu} | ||
112 | \opt{IAUDIO_X5_PAD}{Please add correct keys} | ||
113 | \opt{IPOD_4G_PAD}{Please add correct keys} | ||
114 | & Go to Main menu \\ | ||
115 | % | ||
116 | %These actions need definitions for the other targets | ||
117 | \opt{RECORDER_PAD}{ | ||
118 | \ButtonFTwo & Toggles Play/browse quick menu \\ | ||
119 | \ButtonFThree & Toggles Display quick menu \\ | ||
120 | \ButtonFOne+\ButtonDown & Key lock on/off \\ | ||
121 | \ButtonFOne+\ButtonPlay & Mute on/off \\ | ||
122 | \ButtonFOne+\ButtonOn & Enter ID3 viewer \\ | ||
123 | } | ||
124 | \opt{PLAYER_PAD}{ | ||
125 | \ButtonMenu+\ButtonStop & Key lock on/off \\ | ||
126 | \ButtonMenu+\ButtonPlay & Mute on/off \\ | ||
127 | \ButtonMenu+\ButtonOn & Enter ID3 viewer \\ | ||
128 | } | ||
129 | \end{btnmap} | ||
130 | \end{table} | ||
131 | |||
132 | |||
133 | \opt{HAVE_LCD_BITMAP}{ | ||
134 | \subsection{\label{ref:peak_meter}Peak Meter} | ||
135 | The peak meter can be displayed on the While Playing Screen and consists of | ||
136 | several indicators. For a picture of the peak meter, please see the While | ||
137 | Recording Screen on page \pageref{ref:Whilerecordingscreen}. | ||
138 | |||
139 | \begin{description} | ||
140 | \item [The bar:] | ||
141 | This is the wide horizontal bar. It represents the current volume value. | ||
142 | \item [The peak indicator:] | ||
143 | This is a little vertical line at the rightend of the bar. It indicates the | ||
144 | peak volume value that occurred recently. | ||
145 | \item [The clip indicator:] | ||
146 | This is a little black block that is displayed at the very right of the | ||
147 | scale when an overflow occurs. It usually doesn't show up during normal | ||
148 | playback unless you play an audio file that is distorted heavily. If you | ||
149 | encounter clipping while recording your recording will sound distorted. You | ||
150 | should lower the gain. Note that the clip detection is not very precise. | ||
151 | Clipping might occur without being indicated. | ||
152 | \item [The scale:] | ||
153 | Between the indicators of the right and left channel there are little dots. | ||
154 | These dots represent important volume values. In linear mode each dot is a | ||
155 | 10\% mark. In dbfs mode the dots represent the following values (from right | ||
156 | to left): 0db, {}-3db, {}-6db, {}-9db, {}-12db, {}-18db, {}-24db, {}-30db, | ||
157 | {}-40db, {}-50db, {}-60db. | ||
158 | \end{description} | ||
159 | } | ||
160 | \subsection{\label{sec:quickscreens}Quickscreens} | ||
161 | |||
162 | \subsubsection{\label{sec:contextmenu}Context Menu} | ||
163 | Like the context menu for the file browser this context menu allows you | ||
164 | to quickly access some often used functions. | ||
165 | \opt{SWCODEC}{These include the ID3 Viewer and the pitch screen.} | ||
166 | |||
167 | \opt{SWCODEC}{ | ||
168 | \subsubsection{\label{sec:pitchscreen}Pitch Screen} | ||
169 | The Pitch Screen allows you to quickly change the pitch of your \dap. The | ||
170 | pitch value can be adjusted between 50\% and 200\%. | ||
171 | \begin{table} | ||
172 | \begin{btnmap}{}{} | ||
173 | \opt{h1xx,h300,RECORDER_PAD,ONDIO_PAD,PLAYER_PAD}{\ButtonUp/\ButtonDown} | ||
174 | \opt{IPOD_4G_PAD,x5}{\fixme{tbd}} | ||
175 | & Increase / Decrease Pitch by 0.1\% \\ | ||
176 | % | ||
177 | \opt{h1xx,h300,RECORDER_PAD,ONDIO_PAD,PLAYER_PAD}{\ButtonLeft/\ButtonRight} | ||
178 | \opt{IPOD_4G_PAD,x5}{\fixme{tbd}} | ||
179 | & Increase / Decrease Pitch by 2.0\% \\ | ||
180 | % | ||
181 | \opt{RECORDER_PAD,ONDIO_PAD,PLAYER_PAD}{\fixme{\ButtonOn+\ButtonStop}} | ||
182 | \opt{h1xx,h300}{\ButtonOn+\ButtonOff} | ||
183 | \opt{IPOD_4G_PAD,x5}{\fixme{tbd}} | ||
184 | & Reset Pitch to 100\% \\ | ||
185 | % | ||
186 | \opt{RECORDER_PAD,ONDIO_PAD,PLAYER_PAD}{\ButtonStop} | ||
187 | \opt{h1xx,h300}{\ButtonOff} | ||
188 | \opt{IPOD_4G_PAD,x5}{\fixme{tbd}} | ||
189 | & Leave Pitch screen \\ | ||
190 | % | ||
191 | \end{btnmap} | ||
192 | \end{table} | ||
193 | } | ||
194 | |||
195 | \subsubsection{\label{ref:ID3viewer}ID3 Viewer} | ||
196 | \screenshot{rockbox_interface/images/ss-id3-viewer}{The ID3 viewer}{} | ||
197 | This screen is accessible from the WPS screen, and provides a detailed view of | ||
198 | all the identity information about the current track. This info is known as | ||
199 | meta data and is stored in audio file formats to keep information on artist, | ||
200 | album etc. To access this screen, \opt{h1xx,h300}{hold \ButtonSelect\ to | ||
201 | access the WPS context menu, and select the id3-viewer from there.} | ||
202 | \opt{RECORDER_PAD}{press \ButtonFOne+\ButtonOn} | ||
203 | \opt{PLAYER_PAD}{press \ButtonMenu+\ButtonOn.} | ||
204 | \opt{IAUDIO_X5_PAD,IPOD_4G_PAD}{\fixme{Please correct this information}} | ||
205 | \opt{ONDIO_PAD}{hold \ButtonMenu to access the WPS context menu, and | ||
206 | select the id3-viewer from there.} | ||
207 | \opt{RECORDER_PAD,PLAYER_PAD,ONDIO_PAD}{Use \ButtonLeft\ and \ButtonRight\ | ||
208 | to move through the information.} | ||
209 | |||
210 | %********************QUICKSCREENS*********************************************** | ||
211 | \opt{RECORDER_PAD}{ | ||
212 | \section{\label{ref:QuickScreenMenus}Quick Screen Menus} | ||
213 | \screenshot{rockbox_interface/images/ss-quick-screen-112x64x1.png}{The quick screen}{} | ||
214 | \screenshot{rockbox_interface/images/ss-quick-screen2-112x64x1.png}{The quick screen}{} | ||
215 | Rockbox handles function buttons in a different way to the Archos software. | ||
216 | \ButtonFOne\ is always bound to the menu function, while \ButtonFTwo\ and | ||
217 | \ButtonFThree\ enable two quick menus. | ||
218 | |||
219 | \ButtonFTwo\ displays some browse and play settings which are likely to be | ||
220 | changed frequently. This settings are Shuffle mode, Repeat mode and the Show | ||
221 | files options | ||
222 | |||
223 | Shuffle mode plays each track in the currently playing list in a random order | ||
224 | rather than in the order shown in the browser. | ||
225 | |||
226 | Repeat mode repeats either a single track (One) or the entire playlist (All). | ||
227 | |||
228 | Show files determines what type files can be seen in the browser. This can be | ||
229 | just MP3 files and directories (Music), Playlists, MP3 files and directories | ||
230 | (Playlists), any files that Rockbox supports (Supported) or all files on the | ||
231 | disk (All). | ||
232 | |||
233 | See page \pageref{ref:PlaybackOptions} for more information about these | ||
234 | settings. | ||
235 | |||
236 | \begin{table} | ||
237 | \begin{btnmap}{}{} | ||
238 | \ButtonLeft & Controls Shuffle mode setting \\ | ||
239 | \ButtonRight & Controls Repeat mode setting \\ | ||
240 | \ButtonDown & Controls Show file setting \\ | ||
241 | \end{btnmap} | ||
242 | \end{table} | ||
243 | |||
244 | \ButtonFThree\ controls frequently used display options. | ||
245 | |||
246 | Scroll bar turns the display of the Scroll bar on the left of the screen on | ||
247 | or off. | ||
248 | |||
249 | Status bar turns the status display at the top of the screen on or off. Upside | ||
250 | down inverts the screen so that the top of the display appears nearest to the | ||
251 | buttons. This is sometimes useful when storing the \dap\ in a pocket. Key | ||
252 | assignments swap over with the display orientation where it is logical for | ||
253 | them to do so. | ||
254 | |||
255 | See page \pageref{ref:Displayoptions} for more information about these | ||
256 | settings. | ||
257 | |||
258 | \begin{table} | ||
259 | \begin{btnmap}{}{} | ||
260 | \ButtonLeft & Controls scroll bar display \\ | ||
261 | \ButtonRight & Controls status bar display \\ | ||
262 | \ButtonDown & Controls upside down screen setting \\ | ||
263 | \end{btnmap} | ||
264 | \end{table} | ||
265 | } | ||