summaryrefslogtreecommitdiff
path: root/manual/rockbox_interface/main.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/rockbox_interface/main.tex')
-rw-r--r--manual/rockbox_interface/main.tex804
1 files changed, 804 insertions, 0 deletions
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
new file mode 100644
index 0000000000..3e8e4de0d4
--- /dev/null
+++ b/manual/rockbox_interface/main.tex
@@ -0,0 +1,804 @@
1\chapter{\label{ref:PARTII}The Rockbox interface}
2\clearpage
3\section{Your Jukebox}
4\begin{minipage}{16.554cm}
5{\centering\itshape
6 [Warning: Image ignored] % Unhandled or unsupported graphics:
7%\includegraphics[width=7.904cm,height=10.723cm]{images/rockbox-manual-img8.jpg}
8 [Warning: Image ignored] % Unhandled or unsupported graphics:
9%\includegraphics[width=7.87cm,height=10.703cm]{images/rockbox-manual-img9.jpg}
10 \newline
11Jukebox Player Jukebox Recorder
12\par}
13
14{\centering\itshape
15 [Warning: Image ignored] % Unhandled or unsupported graphics:
16%\includegraphics[width=7.87cm,height=10.7cm]{images/rockbox-manual-img10.jpg}
17 \newline
18Ondio 128
19\par}
20\end{minipage}
21
22Throughout this manual, the buttons on the Jukebox are labelled
23according to the pictures above. There are minor cosmetic differences
24between Jukebox models, but the buttons are in approximately the same
25position as on the picture.\\
26
27To turn on a Jukebox containing Rockbox, hold down the ON key
28for 2{}-3 seconds. (Flashed Jukeboxes only require a tap of the ON key
29{--} see page \textup{\pageref{ref:FlashingRockboxReal}} for more
30information about flashing Rockbox.)
31\label{ref:Safeshutdown}On shutdown, Rockbox automatically saves its settings and turns off the hard drive safely. To tell Rockbox to shut the Jukebox down, do the following:
32
33\begin{center}\begin{tabular}{|p{5.905cm}|p{10.558001cm}|}
34\hline
35{\centering\bfseries\itshape
36model
37\par}
38&
39{\centering\bfseries\itshape
40POWER OFF
41\par}
42\\\hline
43{\centering
44V2 / FM RECORDER/ ONDIO
45\par}
46&
47Hold the OFF key for 2{}-3 seconds
48\\\hline
49{\centering
50V1 RECORDER
51\par}
52&
53Double{}-tap the OFF key when playback is stopped
54\\\hline
55{\centering
56PLAYER
57\par}
58&
59From the Rockbox Main Menu select \textbf{Shutdown}
60\\\hline
61\end{tabular}\end{center}
62
63In the unlikely event of a software failure, a hardware power off can be
64performed by holding down STOP until the Jukebox power light goes off.
65This works for all models of Jukebox.\\
66
67For further details about connecting, charging and caring for your
68Jukebox, please see the Archos manual that came with it.
69
70\section{\label{ref:PartIIFB}File Browser}
71{\centering\itshape
72 [Warning: Image ignored] % Unhandled or unsupported graphics:
73%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img11.png}
74 [Warning: Image ignored] % Unhandled or unsupported graphics:
75%\includegraphics[width=4.15cm,height=1.981cm]{images/rockbox-manual-img12.png}
76 \newline
77Recorder file browser Player file browser
78\par}
79The file browser helps you navigate through the files on your Jukebox,
80entering folders and executing the default action on each file. To help
81us differentiate files, each file format is displayed with an icon. You
82can select which file types are displayed (see page
83\pageref{ref:ShowFiles}).
84
85\subsection{\label{ref:PartIISectionCtrls}Controls}
86\opt{Rec}{
87\begin{center}\begin{tabular}{|p{4cm}|p{10cm}|}
88\hline
89\tabelth{KEY} & \tabelth{FUNCTION} \\ \hline
90%
91\tabeltc{UP/DOWN} &
92Go to previous/next item in list. If you are on the first/last entry,
93the cursor will wrap to the last/first entry. \\ \hline
94%
95\tabeltc{ON+UP/DOWN} &
96Move one page up/down on the list.\\ \hline
97%
98\tabeltc{LEFT} & Go to the parent directory. \\ \hline
99%
100\tabeltc{PLAY/RIGHT} &
101Executes an action. Depending on the file type, that action may vary.
102(See page \pageref{ref:Filemenu}) \\ \hline
103%
104\tabeltc{centering} &
105If there is a MP3 playing, returns to the While Playing Screen (WPS)
106without stopping playback. \\ \hline
107%
108\tabeltc{ON+PLAY/HOLD PLAY} & Enters the File Menu \\ \hline
109%
110\tabeltc{F1} & Switches to the Main Menu \\ \hline
111%
112\tabeltc{F2} & Switches to the Browse/Play Quick Menu \\ \hline
113%
114\tabeltc{F3} & Switches to the Display Quick Menu \\ \hline
115%
116\end{tabular}\end{center}
117}
118%
119\opt{PS}{
120\begin{tabular}[c]{|p{4.314cm}|p{12.288cm}|}
121\hline
122{\centering\bfseries\itshape
123KEY
124\par}
125&
126{\centering\bfseries\itshape
127FUNCTION
128\par}
129\\\hline
130{\centering
131MINUS/PLUS
132\par}
133&
134Go to previous/next item in list. If you are on the first/last entry,
135the cursor will wrap to the last/first entry.
136\\\hline
137{\centering
138STOP
139\par}
140&
141Go to the parent directory.
142\\\hline
143{\centering
144PLAY
145\par}
146&
147Executes an action. Depending on the file type, that action may vary.
148(See page \pageref{ref:Filemenu})
149\\\hline
150{\centering
151ON
152\par}
153&
154If there is a MP3 playing, returns to the While Playing Screen (WPS)
155without stopping playback.
156\\\hline
157{\centering
158ON+PLAY/HOLD PLAY
159\par}
160&
161Enters the File Menu
162\\\hline
163{\centering
164Menu
165\par}
166&
167Switches to the Main Menu
168\\\hline
169\end{tabular}
170The functions of the F keys are also summarised on the button bar at the
171bottom of the screen.
172}
173
174
175\subsection{\label{ref:Filemenu}\label{ref:PartIISectionFM}File Menu}
176{\centering\itshape
177 [Warning: Image ignored] % Unhandled or unsupported graphics:
178%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img13.png}
179 [Warning: Image ignored] % Unhandled or unsupported graphics:
180%\includegraphics[width=4.15cm,height=1.951cm]{images/rockbox-manual-img14.png}
181 \newline
182Recorder file menu Player file menu
183\par}
184
185This menu operates on the file that was selected in the browser at the
186time ON+PLAY was pressed to enter it. It can also be accessed by
187holding down the PLAY key for a short while. It offers the following
188options:
189
190\begin{itemize}
191\item \textbf{Open with:} Runs a viewer plugin on the file.
192Normally the filetype of a file is detected and the appropriate plugin
193is run automatically when you press play on it. Use this menu if for
194some reason you want to override the default action and select a viewer
195by hand. See page \textmd{\pageref{ref:Viewersplugins}} for more details on viewers.
196For example, this would be used to run the VBRfix plugin to recreate the
197Xing header for an MP3 file, which can fix problems such as
198fast{}-forward and rewind not working correctly on a particular MP3 file or the play time of a track being listed incorrectly.
199\item \textbf{Playlist:} Change to the Playlist submenu (see below).
200\item \textbf{Rename:} This function lets the user modify a file name.
201\item \textbf{Delete:} Only files can be deleted, not folders. Rockbox will ask for confirmation before deleting a file. Press PLAY to confirm deletion or any other key to cancel.
202\item \textbf{Delete Directory: }Deletes the folder pointed to by the cursor and all the files and folders contained in it. Use with caution.
203\item \textbf{Create Directory:} Makes a new folder in the current folder on
204the disk.
205\end{itemize}
206
207
208\subsection{\label{ref:Playlistsubmenu}Playlist Submenu}
209If the playlist submenu is invoked on a directory, it will act on all the files within that directory. If invoked on a playlist it will act on all the files in that playlist. Otherwise it acts only on the current file.
210
211{\centering\itshape
212 [Warning: Image ignored] % Unhandled or unsupported graphics:
213%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img15.png}
214 [Warning: Image ignored] % Unhandled or unsupported graphics:
215%\includegraphics[width=4.15cm,height=1.951cm]{images/rockbox-manual-img16.png}
216 \newline
217 Recorder playlist submenu Player playlist submenu
218\par}
219
220This menu provides the following options:
221
222\begin{itemize}
223\item \textbf{Insert:} Add track(s) to playlist. If no other tracks have been
224inserted then the selected track will be added immediately after
225current playing track, otherwise they will be added to end of insertion
226list.
227\item \textbf{Insert next: }Add track(s) immediately after current playing
228track, no matter what else has been inserted.
229\item \textbf{Insert last: }Add track(s) to end of playlist.
230\item \textbf{Queue: } Queue is the same as Insert except queued
231tracks are deleted immediately from the playlist after
232they've been played. Also, queued tracks are not saved to the playlist file (see page \pageref{ref:playlistoptions}).
233\item \textbf{Queue next:} Queue track(s) immediately after current playing
234track.
235\item \textbf{Queue last: }Queue track(s) at end of playlist.
236\end{itemize}
237
238You can insert a track, directory or playlist even if nothing is
239currently playing. In this case, a new playlist is created with only
240the selected tracks and then play is started.
241
242Note: The dynamic playlist is saved so resume will restore it exactly as
243before shutdown. Stopped playlists can be resumed from File Browser by
244pressing ON.
245
246
247
248
249\subsection{Virtual Keyboard}
250{\centering\itshape
251 [Warning: Image ignored] % Unhandled or unsupported graphics:
252%\includegraphics[width=4.165cm,height=2.177cm]{images/rockbox-manual-img17.png}
253 \textmd{ } [Warning: Image ignored]
254% Unhandled or unsupported graphics:
255%\includegraphics[width=4.598cm,height=2.071cm]{images/rockbox-manual-img18.png}
256 \newline
257 Recorder keyboard Player Keyboard
258\par}
259
260This is the virtual keyboard that is used when entering file names in
261Rockbox.
262
263\opt{Rec}{
264
265\begin{tabular}[c]{|p{3.8799999cm}|p{12.653cm}|}
266\hline
267{\centering\bfseries\itshape
268KEY
269\par}
270&
271{\centering\bfseries\itshape
272FUNCTION
273\par}
274\\\hline
275{\centering
276ARROW KEYS
277\par}
278&
279Move about the virtual keyboard (moves the solid cursor)
280\\\hline
281{\centering
282ON+LEFT/RIGHT
283\par}
284&
285Move about within the current file name (moves the line cursor)
286\\\hline
287{\centering
288PLAY
289\par}
290&
291Inserts the currently selected keyboard letter at the current filename
292cursor position
293\\\hline
294{\centering
295STOP
296\par}
297&
298Exits the virtual keyboard without saving any changes
299\\\hline
300{\centering
301ON
302\par}
303&
304No action
305\\\hline
306{\centering
307F1
308\par}
309&
310SHIFT: Shifts between the upper case, lower case and accented keyboards
311\\\hline
312{\centering
313F2
314\par}
315&
316OK: Exits the virtual keyboard and saves any changer
317\\\hline
318{\centering
319F3
320\par}
321&
322DEL: Deletes the character before the current filename cursor
323\\\hline
324\end{tabular}
325}
326
327
328\opt{PS}{
329The current filename is always listed on the first line of the display.
330The second line of the display can contain the character selection bar,
331as in the screenshot above, or one of a number of other options.
332
333\begin{center}\begin{tabular}{|p{3.86cm}|p{12.708cm}|}
334\hline
335{\centering\bfseries\itshape
336KEY
337\par}
338&
339{\centering\bfseries\itshape
340FUNCTION
341\par}
342\\\hline
343{\centering
344MINUS/PLUS
345\par}
346&
347Moves the arrow to/from the filename and changes between the character
348bar and BACKSPACE, DELETE, ACCEPT and ABORT.
349\\\hline
350{\centering
351PLAY/STOP
352\par}
353&
354Varies (see below)
355\\\hline
356{\centering
357ON
358\par}
359&
360Nothing
361\\\hline
362{\centering
363Menu
364\par}
365&
366Shift. When the character selection bar is selected this changes
367between upper case, lower case, and accented letters.
368\\\hline
369\end{tabular}\end{center}
370The function of the PLAY and STOP buttons depends on what the arrow is
371pointing to, as follows.
372
373\begin{center}\begin{tabular}{|p{4.243cm}|p{12.359cm}|}
374\hline
375{\centering\bfseries\itshape
376SELECTED OPTION
377\par}
378&
379{\centering\bfseries\itshape
380PLAY/STOP FUNCTION
381\par}
382\\\hline
383{\centering
384filename
385\par}
386&
387Moves the cursor left (STOP) or right (PLAY) within the filename
388\\\hline
389{\centering
390character bar
391\par}
392&
393Moves the character bar to the next (PLAY) or previous (STOP) character.
394\\\hline
395{\centering
396BACKSPACE
397\par}
398&
399PLAY deletes the character before the current cursor position
400\\\hline
401{\centering
402DELETE
403\par}
404&
405PLAY deletes the character at the current cursor position
406\\\hline
407{\centering
408ACCEPT
409\par}
410&
411PLAY exits the virtual keyboard and saves any changes
412\\\hline
413{\centering
414ABORT
415\par}
416&
417PLAY exits the virtual keyboard and discards any changes
418\\\hline
419\end{tabular}\end{center}
420}
421
422\section{\label{ref:WPS}\label{ref:PartIISectionWPS}While Playing
423Screen}
424The While Playing Screen (WPS) displays various pieces of information
425about the currently playing MP3 file:
426%
427\opt{Rec}{
428\begin{itemize}
429\item Status bar: Battery level, charger status, volume, play mode, repeat
430mode, shuffle mode and clock.
431\item Scrolling path+filename of the current song.
432\item The ID3 track name.
433\item The ID3 album name.
434\item The ID3 artist name.
435\item Bit rate. VBR files display average bitrate and ``(avg)''
436\item Elapsed and total time.
437\item A slidebar progress meter representing where in the song you are.
438\item Peak meter.
439\end{itemize}
440
441Notes:
442
443\begin{itemize}
444\item The number of lines shown depends on the size of the font used.
445\item The peak meter is only visible if you turn off the status bar or if
446using a small font that gives 8 or more display lines.
447\end{itemize}
448}
449%
450\opt{PS}{
451\begin{itemize}
452\item Playlist index/Playlist size: Artist {}- Title.
453\item Current{}-time Progress{}-indicator Left.
454\end{itemize}
455
456See page \textmd{\pageref{ref:ConfiguringtheWPS}} for
457details of customising your WPS (While Playing Screen).
458}
459
460\subsection{\label{ref:PartIISectionWPSCtrls}WPS Key Controls}
461
462\opt{Rec}{
463\begin{flushleft}\begin{tabular}{|p{3.407cm}|p{13.093cm}|}
464\hline
465{\centering\bfseries\itshape
466KEY
467\par}
468&
469{\centering\bfseries\itshape
470ACTION
471\par}
472\\\hline
473{\centering
474UP/DOWN
475\par}
476&
477Volume up/down
478\\\hline
479{\centering
480LEFT
481\par}
482&
483(quick press) Go to beginning of track, or if pressed while in the first
484seconds of a track, go to previous track
485\\\hline
486{\centering
487LEFT (hold)
488\par}
489&
490Rewind in track
491\\\hline
492{\centering
493RIGHT
494\par}
495&
496(quick press) Go to next track.
497\\\hline
498{\centering
499RIGHT (hold)
500\par}
501&
502Fast forward in track.
503\\\hline
504{\centering
505PLAY
506\par}
507&
508Toggle play/pause
509\\\hline
510{\centering
511ON
512\par}
513&
514(quick press) Go to file browser
515\\\hline
516{\centering
517ON (hold)
518\par}
519&
520Show pitch setting screen
521\\\hline
522{\centering
523STOP
524\par}
525&
526Stop playback
527\\\hline
528{\centering
529F1
530\par}
531&
532Go to Main menu
533\\\hline
534{\centering
535F2
536\par}
537&
538Toggles Play/browse quick menu
539\\\hline
540{\centering
541F3
542\par}
543&
544Toggles Display quick menu
545\\\hline
546{\centering
547F1+DOWN
548\par}
549&
550Key lock on/off
551\\\hline
552{\centering
553F1+PLAY
554\par}
555&
556Mute on/off
557\\\hline
558{\centering
559F1+ON
560\par}
561&
562Enter ID3 viewer
563\\\hline
564\end{tabular}\end{flushleft}
565}
566%
567\opt{PS}{
568\begin{center}\begin{tabular}{|p{3.27cm}|p{13.29cm}|}
569\hline
570{\centering\bfseries\itshape
571KEY
572\par}
573&
574{\centering\bfseries\itshape
575ACTION
576\par}
577\\\hline
578{\centering
579MENU+PLUS
580\par}
581&
582Increases volume
583\\\hline
584{\centering
585MENU+MINUS
586\par}
587&
588Decreases volume
589\\\hline
590{\centering
591MINUS
592\par}
593&
594(quick press) Go to beginning of track, or if pressed while in the first
595seconds of a track, go to previous track.
596\\\hline
597{\centering
598MINUS (hold)
599\par}
600&
601Rewind in track
602\\\hline
603{\centering
604PLUS
605\par}
606&
607(quick press) Go to next track.
608\\\hline
609{\centering
610PLUS (hold)
611\par}
612&
613Fast{}-forward in track.
614\\\hline
615{\centering
616PLAY
617\par}
618&
619Toggle play/pause
620\\\hline
621{\centering
622ON
623\par}
624&
625Quick press = Go to file browser
626\\\hline
627{\centering
628OFF
629\par}
630&
631Stop playback
632\\\hline
633{\centering
634MENU
635\par}
636&
637Go to Main menu
638\\\hline
639{\centering
640MENU+STOP
641\par}
642&
643Key lock on/off
644\\\hline
645{\centering
646MENU+PLAY
647\par}
648&
649Mute on/off
650\\\hline
651{\centering
652MENU+ON
653\par}
654&
655Enter ID3 viewer
656\\\hline
657\end{tabular}\end{center}
658}
659
660\opt{Rec,Rec2,FMRec,OndioSP,OndioFM,H120}{
661\subsection{Peak Meter}
662The peak meter can be displayed on the While Playing Screen and consists
663of several indicators. For a picture of the peak meter, please see the
664While Recording Screen on page \pageref{ref:Whilerecordingscreen}.
665
666\begin{itemize}
667\item \textbf{The bar: }This is the wide horizontal bar. It represents the
668current volume value.
669\item \textbf{The peak indicator:} This is a little vertical line at the right
670end of the bar. It indicates the peak volume value that occurred
671recently.
672\item \textbf{The clip indicator: }This is a little black block that is
673displayed at the very right of the scale when an overflow occurs. It
674usually doesn't show up during normal playback unless
675you play an audio file that is distorted heavily. If you encounter
676clipping while recording your recording will sound distorted. You
677should lower the gain. Note that the clip detection is not very
678precise. Clipping might occur without being indicated.
679\item \textbf{The scale: }Between the indicators of the right and left channel
680there are little dots. These dots represent important volume values. In
681linear mode each dot is a 10\% mark. In dbfs mode the dots represent
682the following values (from right to left): 0db, {}-3db, {}-6db, {}-9db,
683{}-12db, {}-18db, {}-24db, {}-30db, {}-40db, {}-50db, {}-60db.
684\end{itemize}
685}
686
687\subsection{\label{ref:ID3viewer}ID3 Viewer}
688{\centering\itshape
689 [Warning: Image ignored] % Unhandled or unsupported graphics:
690%\includegraphics[width=3.833cm,height=2.191cm]{images/rockbox-manual-img21.png}
691 \newline
692The ID3 viewer
693\par}
694
695This screen is accessible from the WPS screen by pressing F1+ON (recorder) or MENU+ON (player). It provides a detailed view of all the identity information about the current track that is stored in an MP3 file. Use the LEFT and RIGHT (recorder) or PLUS and MINUS (player) keys to move through the information and the STOP key to exit the viewer.
696
697
698\opt{Rec,Rec2,FMRec,H120}{
699\section{\label{ref:QuickScreenMenus}Quick Screen Menus}
700
701{\centering\itshape
702 [Warning: Image ignored] % Unhandled or unsupported graphics:
703%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img22.png}
704 \textmd{ } [Warning: Image ignored]
705% Unhandled or unsupported graphics:
706%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img23.png}
707 \newline
708F2 Quick Screen Menu F3 Quick Screen Menu
709\par}
710
711Rockbox handles function buttons in a different way to the Archos
712software. F1 is always bound to the menu function, while F2 and F3
713enable two quick menus.
714
715F2 displays some browse and play settings which are likely to be changed
716frequently. This settings are Shuffle mode, Repeat mode and the Show
717files options
718
719Shuffle mode plays each track in the currently playing list in a random
720order rather than in the order shown in the browser.
721
722Repeat mode repeats either a single track (One) or the entire playlist
723(All).
724
725Show files determines what type files can be seen in the browser. This
726can be just MP3 files and directories (Music), Playlists, MP3 files and directories (Playlists), any files that Rockbox supports (Supported) or all files on the disk (All).
727
728See page \pageref{ref:PlaybackOptions} for more information about these
729settings.
730
731\begin{center}\begin{tabular}{|p{2.852cm}|p{8.387cm}|}
732\hline
733{\centering\bfseries\itshape
734KEY
735\par}
736&
737{\centering\bfseries\itshape
738ACTION
739\par}
740\\\hline
741{\centering
742LEFT
743\par}
744&
745Controls Shuffle mode setting
746\\\hline
747{\centering
748RIGHT
749\par}
750&
751Controls Repeat mode setting
752\\\hline
753{\centering
754DOWN
755\par}
756&
757Controls Show file setting
758\\\hline
759\end{tabular}\end{center}
760F3 controls frequently used display options.
761
762Scroll bar turns the display of the Scroll bar on the left of the screen
763on or off.
764
765Status bar turns the status display at the top of the screen on or off.
766
767Upside down inverts the screen so that the top of the display appears
768nearest to the buttons. This is sometimes useful when storing the
769Jukebox in a pocket. Key assignments swap over with the display
770orientation where it is logical for them to do so.
771
772See page \pageref{ref:Displayoptions} for more information about these
773settings.
774
775\begin{tabular}[c]{|p{2.852cm}|p{8.387cm}|}
776\hline
777{\centering\bfseries\itshape
778KEY
779\par}
780&
781{\centering\bfseries\itshape
782ACTION
783\par}
784\\\hline
785{\centering
786LEFT
787\par}
788&
789Controls scroll bar display
790\\\hline
791{\centering
792RIGHT
793\par}
794&
795Controls status bar display
796\\\hline
797{\centering
798DOWN
799\par}
800&
801Controls upside down screen setting
802\\\hline
803\end{tabular}
804}