summaryrefslogtreecommitdiff
path: root/manual/rockbox_interface/wps.tex
diff options
context:
space:
mode:
authorSolomon Peachy <pizza@shaftnet.org>2020-07-15 19:40:55 -0400
committerSolomon Peachy <pizza@shaftnet.org>2020-07-24 21:20:13 +0000
commit092c340a2062fa98b7387fc5fd63578ddae7d0b6 (patch)
tree98ec96946eeb2ae709cb0528cc6998e21bb9b290 /manual/rockbox_interface/wps.tex
parent17f7cc92c258bc456a27c3e7c5a19c9409851879 (diff)
downloadrockbox-092c340a2062fa98b7387fc5fd63578ddae7d0b6.tar.gz
rockbox-092c340a2062fa98b7387fc5fd63578ddae7d0b6.zip
[1/4] Remove SH support and all archos targets
This removes all code specific to SH targets Change-Id: I7980523785d2596e65c06430f4638eec74a06061
Diffstat (limited to 'manual/rockbox_interface/wps.tex')
-rw-r--r--manual/rockbox_interface/wps.tex141
1 files changed, 25 insertions, 116 deletions
diff --git a/manual/rockbox_interface/wps.tex b/manual/rockbox_interface/wps.tex
index c82a9cb9f4..1f62dc17a4 100644
--- a/manual/rockbox_interface/wps.tex
+++ b/manual/rockbox_interface/wps.tex
@@ -9,17 +9,10 @@ currently playing audio file.
9 or off independently. Refer to \reference{ref:wps_tags} for details on how 9 or off independently. Refer to \reference{ref:wps_tags} for details on how
10 to change the display of the WPS. 10 to change the display of the WPS.
11 \begin{itemize} 11 \begin{itemize}
12 \nopt{ondio}{ 12 \item Status bar: The Status bar shows Battery level, charger status,
13 \item Status bar: The Status bar shows Battery level, charger status, 13 volume, play mode, repeat mode, shuffle mode\opt{rtc}{ and clock}.
14 volume, play mode, repeat mode, shuffle mode\opt{rtc}{ and clock}. 14 In contrast to all other items, the status bar is always at the top of
15 In contrast to all other items, the status bar is always at the top of 15 the screen.
16 the screen.
17 }
18 \opt{ondio}{
19 \item Status bar: The Status bar shows Battery level, USB power mode, key
20 lock status, memory access indicator. In contrast to all other items, the
21 status bar is always at the top of the screen.
22 }
23 \item (Scrolling) path and filename of the current song. 16 \item (Scrolling) path and filename of the current song.
24 \item The ID3 track name. 17 \item The ID3 track name.
25 \item The ID3 album name. 18 \item The ID3 album name.
@@ -30,24 +23,7 @@ currently playing audio file.
30 \item Peak meter. 23 \item Peak meter.
31 \end{itemize} 24 \end{itemize}
32} 25}
33\opt{recorder,recorderv2fm,ondio}{
34 \note{
35 \begin{itemize}
36 \item The number of lines shown depends on the size of the font used.
37 \item The peak meter is only visible if you turn off the status bar or if
38 using a small font that gives 8 or more display lines.
39 \end{itemize}
40 }
41}
42% 26%
43\opt{player}{
44 \note{
45 \begin{itemize}
46 \item Playlist index/Playlist size: Artist {}- Title.
47 \item Current{}-time Progress{}-indicator Left.
48 \end{itemize}
49 }
50}
51 27
52See \reference{ref:ConfiguringtheWPS} for details of customising 28See \reference{ref:ConfiguringtheWPS} for details of customising
53your WPS (While Playing Screen). 29your WPS (While Playing Screen).
@@ -81,7 +57,7 @@ your WPS (While Playing Screen).
81 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsPlay} 57 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsPlay}
82 & Toggle play/pause.\\ 58 & Toggle play/pause.\\
83 % 59 %
84 \ActionWpsStop 60 \ActionWpsStop
85 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsStop} 61 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsStop}
86 & Stop playback.\\ 62 & Stop playback.\\
87 % 63 %
@@ -93,11 +69,10 @@ your WPS (While Playing Screen).
93 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsContext} 69 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsContext}
94 & Enter \setting{WPS Context Menu}.\\ 70 & Enter \setting{WPS Context Menu}.\\
95 % 71 %
96 \opt{ONDIO_PAD}{\ActionWpsContext{} twice}% 72 \ActionWpsMenu
97 \nopt{ONDIO_PAD}{\ActionWpsMenu}%
98 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsMenu} 73 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsMenu}
99 & Enter \setting{Main Menu}% 74 & Enter \setting{Main Menu}%
100 \opt{ONDIO_PAD}{ via the \setting{WPS Context Menu}}.\\% 75 .\\%
101 % 76 %
102 \opt{quickscreen}{% 77 \opt{quickscreen}{%
103 \ActionWpsQuickScreen 78 \ActionWpsQuickScreen
@@ -107,25 +82,14 @@ your WPS (While Playing Screen).
107 % 82 %
108 % software hold targets 83 % software hold targets
109 \nopt{hold_button}{% 84 \nopt{hold_button}{%
110 \opt{RECORDER_PAD}{\ButtonFOne+\ButtonDown}
111 \opt{PLAYER_PAD}{\ButtonMenu+\ButtonStop}
112 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown}
113 \opt{SANSA_CLIP_PAD}{\ButtonHome+\ButtonSelect} 85 \opt{SANSA_CLIP_PAD}{\ButtonHome+\ButtonSelect}
114 \opt{SANSA_FUZEPLUS_PAD}{\ButtonPower} 86 \opt{SANSA_FUZEPLUS_PAD}{\ButtonPower}
115 & Key lock (software hold switch) on/off.\\ 87 & Key lock (software hold switch) on/off.\\
116 }% 88 }%
117 %These actions need definitions for the other targets
118 \opt{RECORDER_PAD}{%
119 \ButtonFThree & Toggles Display quick screen.\\%
120 \ButtonFOne+\ButtonPlay & Mute on/off.\\%
121 }%
122 \opt{PLAYER_PAD}{%
123 \ButtonMenu+\ButtonPlay & Mute on/off.\\%
124 }%
125 % We explicitly list all the appropriate targets here and do no condition 89 % We explicitly list all the appropriate targets here and do no condition
126 % on the 'pitchscreen' feature since some players have the feature but do 90 % on the 'pitchscreen' feature since some players have the feature but do
127 % not have the button to go from the WPS to the pitch screen. 91 % not have the button to go from the WPS to the pitch screen.
128 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,MROBE100_PAD% 92 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,MROBE100_PAD%
129 ,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_C200_PAD,SANSA_FUZEPLUS_PAD}{% 93 ,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_C200_PAD,SANSA_FUZEPLUS_PAD}{%
130 \ActionWpsPitchScreen 94 \ActionWpsPitchScreen
131 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsPitchScreen} 95 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsPitchScreen}
@@ -137,9 +101,9 @@ your WPS (While Playing Screen).
137 \opt{HAVEREMOTEKEYMAP}{&} 101 \opt{HAVEREMOTEKEYMAP}{&}
138 & Show current \setting{Playlist}.\\% 102 & Show current \setting{Playlist}.\\%
139 }% 103 }%
140 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD% 104 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD%
141 ,SANSA_E200_PAD,SANSA_C200_PAD,SANSA_FUZEPLUS_PAD}{% 105 ,SANSA_E200_PAD,SANSA_C200_PAD,SANSA_FUZEPLUS_PAD}{%
142 \ActionWpsIdThreeScreen 106 \ActionWpsIdThreeScreen
143 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsIdThreeScreen} 107 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsIdThreeScreen}
144 & Enter \setting{ID3 Viewer}.\\% 108 & Enter \setting{ID3 Viewer}.\\%
145 }% 109 }%
@@ -168,7 +132,7 @@ your WPS (While Playing Screen).
168 % 132 %
169 \opt{SANSA_E200_PAD,SANSA_C200_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{ 133 \opt{SANSA_E200_PAD,SANSA_C200_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{
170 \ActionStdRec 134 \ActionStdRec
171 \opt{HAVEREMOTEKEYMAP}{&} 135 \opt{HAVEREMOTEKEYMAP}{&}
172 & Switch to the \setting{Recording Screen}.\\ 136 & Switch to the \setting{Recording Screen}.\\
173 }% 137 }%
174 \end{btnmap} 138 \end{btnmap}
@@ -177,7 +141,7 @@ your WPS (While Playing Screen).
177\opt{lcd_bitmap}{ 141\opt{lcd_bitmap}{
178 \subsection{\label{ref:peak_meter}Peak Meter} 142 \subsection{\label{ref:peak_meter}Peak Meter}
179 The peak meter can be displayed on the While Playing Screen and consists of 143 The peak meter can be displayed on the While Playing Screen and consists of
180 several indicators. 144 several indicators.
181 \opt{recording}{ 145 \opt{recording}{
182 For a picture of the peak meter, please see the While 146 For a picture of the peak meter, please see the While
183 Recording Screen in \reference{ref:while_recording_screen}. 147 Recording Screen in \reference{ref:while_recording_screen}.
@@ -187,12 +151,12 @@ your WPS (While Playing Screen).
187 suffers when this feature is enabled. For this \dap{} it is highly recommended 151 suffers when this feature is enabled. For this \dap{} it is highly recommended
188 to not use peak meter.} 152 to not use peak meter.}
189 } 153 }
190 154
191 \begin{description} 155 \begin{description}
192 \item [The bar:] 156 \item [The bar:]
193 This is the wide horizontal bar. It represents the current volume value. 157 This is the wide horizontal bar. It represents the current volume value.
194 \item [The peak indicator:] 158 \item [The peak indicator:]
195 This is a little vertical line at the right end of the bar. It indicates 159 This is a little vertical line at the right end of the bar. It indicates
196 the peak volume value that occurred recently. 160 the peak volume value that occurred recently.
197 \item [The clip indicator:] 161 \item [The clip indicator:]
198 This is a little black block that is displayed at the very right of the 162 This is a little black block that is displayed at the very right of the
@@ -234,7 +198,7 @@ menu, you can find the \setting{Playlist Viewer Settings}.
234 for playlist entries 198 for playlist entries
235 \end{description} 199 \end{description}
236 200
237 201
238\subsubsection{Playlist catalogue} 202\subsubsection{Playlist catalogue}
239 \begin{description} 203 \begin{description}
240 \item [View catalogue.] This lists all playlists that are part of the 204 \item [View catalogue.] This lists all playlists that are part of the
@@ -249,12 +213,12 @@ menu, you can find the \setting{Playlist Viewer Settings}.
249 213
250\subsubsection{Sound Settings} 214\subsubsection{Sound Settings}
251This is a shortcut to the \setting{Sound Settings Menu}, where you can configure volume, 215This is a shortcut to the \setting{Sound Settings Menu}, where you can configure volume,
252bass, treble, and other settings affecting the sound of your music. 216bass, treble, and other settings affecting the sound of your music.
253See \reference{ref:configure_rockbox_sound} for more information. 217See \reference{ref:configure_rockbox_sound} for more information.
254 218
255\subsubsection{Playback Settings} 219\subsubsection{Playback Settings}
256This is a shortcut to the \setting{Playback Settings Menu}, where you can configure shuffle, 220This is a shortcut to the \setting{Playback Settings Menu}, where you can configure shuffle,
257repeat, party mode, skip length and other settings affecting the playback of your music. 221repeat, party mode, skip length and other settings affecting the playback of your music.
258 222
259\subsubsection{Rating} 223\subsubsection{Rating}
260The menu entry is only shown if \setting{Gather Runtime Information} is 224The menu entry is only shown if \setting{Gather Runtime Information} is
@@ -271,19 +235,17 @@ This screen is accessible from the WPS screen, and provides a detailed view of
271all the identity information about the current track. This info is known as 235all the identity information about the current track. This info is known as
272meta data and is stored in audio file formats to keep information on artist, 236meta data and is stored in audio file formats to keep information on artist,
273album etc. To access this screen, % 237album etc. To access this screen, %
274\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,% 238\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,%
275 SANSA_C200_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_FUZEPLUS_PAD}{ 239 SANSA_C200_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_FUZEPLUS_PAD}{
276 press \ActionWpsIdThreeScreen. }% 240 press \ActionWpsIdThreeScreen. }%
277\opt{PLAYER_PAD,ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD,IAUDIO_M3_PAD,% 241\opt{IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD,IAUDIO_M3_PAD,%
278 GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_CLIP_PAD,PBELL_VIBE500_PAD,% 242 GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_CLIP_PAD,PBELL_VIBE500_PAD,%
279 MPIO_HD200_PAD,MPIO_HD300_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}% 243 MPIO_HD200_PAD,MPIO_HD300_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}%
280 {press \ActionWpsContext{} to access the 244 {press \ActionWpsContext{} to access the
281 \setting{WPS Context Menu} and select \setting{Show Track Info}. } 245 \setting{WPS Context Menu} and select \setting{Show Track Info}. }
282\opt{RECORDER_PAD,PLAYER_PAD,ONDIO_PAD}{Use \ButtonLeft\ and \ButtonRight\
283 to move through the information.}%
284 246
285\subsubsection{Open With...} 247\subsubsection{Open With...}
286This \setting{Open With} function is the same as the \setting{Open With} 248This \setting{Open With} function is the same as the \setting{Open With}
287function in the file browser's \setting{Context Menu}. 249function in the file browser's \setting{Context Menu}.
288 250
289\subsubsection{Delete} 251\subsubsection{Delete}
@@ -294,7 +256,7 @@ This may even be the whole track.
294 256
295\opt{pitchscreen}{ 257\opt{pitchscreen}{
296 \subsubsection{\label{sec:pitchscreen}Pitch} 258 \subsubsection{\label{sec:pitchscreen}Pitch}
297 259
298 The \setting{Pitch Screen} allows you to change the rate of playback 260 The \setting{Pitch Screen} allows you to change the rate of playback
299 (i.e. the playback speed and at the same time the pitch) of your 261 (i.e. the playback speed and at the same time the pitch) of your
300 \dap. The rate value can be adjusted 262 \dap. The rate value can be adjusted
@@ -304,20 +266,20 @@ This may even be the whole track.
304 266
305 The rate can be changed in two modes: procentual and semitone. 267 The rate can be changed in two modes: procentual and semitone.
306 Initially, procentual mode is active. 268 Initially, procentual mode is active.
307 269
308 \opt{swcodec}{ 270 \opt{swcodec}{
309 If you've enabled the \setting{Timestretch} option in 271 If you've enabled the \setting{Timestretch} option in
310 \setting{Sound Settings} and have since rebooted, you can also use 272 \setting{Sound Settings} and have since rebooted, you can also use
311 timestretch mode. This allows you to change the playback speed 273 timestretch mode. This allows you to change the playback speed
312 without affecting the pitch, and vice versa. 274 without affecting the pitch, and vice versa.
313 275
314 In timestretch mode there are separate displays for pitch and 276 In timestretch mode there are separate displays for pitch and
315 speed, and each can be altered independently. Due to the 277 speed, and each can be altered independently. Due to the
316 limitations of the algorithm, speed is limited to be between 35\% 278 limitations of the algorithm, speed is limited to be between 35\%
317 and 250\% of the current pitch value. Pitch must maintain the 279 and 250\% of the current pitch value. Pitch must maintain the
318 same ratio as well as remain between 50\% and 200\%. 280 same ratio as well as remain between 50\% and 200\%.
319 } 281 }
320 282
321 The value of the \opt{swcodec}{rate, pitch and speed}\nopt{swcodec}{rate} 283 The value of the \opt{swcodec}{rate, pitch and speed}\nopt{swcodec}{rate}
322 is not persistent, i.e. after the \dap\ is turned on it will 284 is not persistent, i.e. after the \dap\ is turned on it will
323 always be set to 100\%. \opt{swcodec}{ However, the rate, pitch and speed 285 always be set to 100\%. \opt{swcodec}{ However, the rate, pitch and speed
@@ -386,56 +348,3 @@ This may even be the whole track.
386 } 348 }
387 349
388} 350}
389
390%********************QUICKSCREENS***********************************************
391\opt{RECORDER_PAD}{
392 \section{\label{ref:QuickScreens}Quick Screens}
393 \screenshot{rockbox_interface/images/ss-quick-screen-112x64x1.png}{The F2 quick screen}{}
394 \screenshot{rockbox_interface/images/ss-quick-screen2-112x64x1.png}{The F3 quick screen}{}
395 Rockbox handles function buttons in a different way to the Archos software.
396 \ButtonFOne\ is always bound to the menu function, while \ButtonFTwo\ and
397 \ButtonFThree\ enable two quick screens.
398
399 \ButtonFTwo\ displays some browse and play settings which are likely to be
400 changed frequently. This settings are Shuffle mode, Repeat mode and the Show
401 files options
402
403 Shuffle mode plays each track in the currently playing list in a random order
404 rather than in the order shown in the browser.
405
406 Repeat mode repeats either a single track (One) or the entire playlist (All).
407
408 Show files determines what type files can be seen in the browser. This can be
409 just MP3 files and directories (Music), Playlists, MP3 files and directories
410 (Playlists), any files that Rockbox supports (Supported) or all files on the
411 disk (All).
412
413 See \reference{ref:PlaybackOptions} for more information about these
414 settings.
415
416 \begin{btnmap}
417 \ButtonLeft & Control Shuffle mode setting. \\
418 \ButtonRight & Control Repeat mode setting. \\
419 \ButtonDown & Control Show file setting. \\
420 \end{btnmap}
421
422 \ButtonFThree\ controls frequently used display options.
423
424 Scroll bar turns the display of the Scroll bar on the left of the screen on
425 or off.
426
427 Status bar turns the status display at the top of the screen on or off.
428 Upside down inverts the screen so that the top of the display appears nearest
429 to the buttons. This is sometimes useful when storing the \dap\ in a pocket.
430 Key assignments swap over with the display orientation where it is logical
431 for them to do so.
432
433 See \reference{ref:Displayoptions} for more information about these
434 settings.
435
436 \begin{btnmap}
437 \ButtonLeft & Control scroll bar display. \\
438 \ButtonRight & Control status bar display. \\
439 \ButtonDown & Control upside down screen setting. \\
440 \end{btnmap}
441}