diff options
author | Dominik Riebeling <Dominik.Riebeling@gmail.com> | 2006-08-25 15:58:02 +0000 |
---|---|---|
committer | Dominik Riebeling <Dominik.Riebeling@gmail.com> | 2006-08-25 15:58:02 +0000 |
commit | 231adb4f7749d50e598ed70c38d742f62826107d (patch) | |
tree | daa6ac60551366da2fddc26ad940a8e85d536a30 /manual/rockbox_interface | |
parent | 53d26e5bbfc7b6dde51a9ca76ff576f5e9141291 (diff) |
First attempt for a Quick Start. Also move the playback description (formerly "Rockbox Interface") to its own file and rename it to fit better after the split.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10749 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/rockbox_interface')
-rw-r--r-- | manual/rockbox_interface/main.tex | 501 | ||||
-rw-r--r-- | manual/rockbox_interface/playback.tex | 324 |
2 files changed, 449 insertions, 376 deletions
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex index 8344d7fdae..ad5d7145e9 100644 --- a/manual/rockbox_interface/main.tex +++ b/manual/rockbox_interface/main.tex @@ -1,6 +1,8 @@ % $Id$ % -\chapter{\label{ref:rockbox_interface}The Rockbox interface} -\section{Your \dap} +\chapter{\label{ref:rockbox_interface}Quick Start} +\section{Basic overview} +\subsection{The \daps{} controls} + \begin{center} \opt{player}{ \ifpdfoutput{ @@ -85,12 +87,10 @@ Throughout this manual, the buttons on the \dap\ are labelled according to the picture above. -\subsection{The \daps{} controls} - \blind{ % \opt{h1xx}{ - If you lay the \dap\ on the table with the joystick pointing + If you lay the \dap{} on the table with the joystick pointing towards you, and the curved sides at the top, you will find the following if you start from the top-right corner and follow the side of the \dap{} in a clockwise direction: @@ -98,29 +98,29 @@ picture above. \dap, charger plug, \ButtonRec, headphone minijack plug, remote port, optical/line in, optical/line out. The joystick in the middle of the \dap\ is used to navigate menus by pressing it up, down, left and right. Pressing the - joystick down is labelled \ButtonSelect\ throughout this manual. } + joystick down is labelled \ButtonSelect{} throughout this manual. } % \opt{h300}{ - Hold the lay the \dap\ so that the side with the button pad and + Hold the lay the \dap{} so that the side with the button pad and LCD is facing towards you. The buttons on the button pad are as follows: top - left corner: \ButtonOn, bottom left corner: \ButtonOff, top right corner: - \ButtonRec, bottom right corner: \ButtonMode. In the center of the button pad - is a button labelled \ButtonSelect. Surrounding the \ButtonSelect\ button are + left corner: \ButtonOn{}, bottom left corner: \ButtonOff{}, top right corner: + \ButtonRec, bottom right corner: \ButtonMode{}. In the center of the button pad + is a button labelled \ButtonSelect{}. Surrounding the \ButtonSelect{} button are four directional buttons used to navigate up, down, left and right. - On the top panel of the \dap, from left to right, you can find the + On the top panel of the \dap{}, from left to right, you can find the following: headphone minijack plug, remote port, Line-in, Line-out. - On the bottom panel of the \dap, from left to right, you can find the + On the bottom panel of the \dap{}, from left to right, you can find the following: power jack and two USB ports. The USB port on the right is used - to connect your \dap\ to your computer. The USB port on the left is not + to connect your \dap{} to your computer. The USB port on the left is not used in Rockbox. } % \opt{ipod4g, ipod3g,ipodcolor,ipodvideo,ipodmini} { - The main controls on the \dap\ are a slightly indented scroll wheel - with a flat round button in the center. Hold the \dap\ with these controls + The main controls on the \dap{} are a slightly indented scroll wheel + with a flat round button in the center. Hold the \dap{} with these controls facing you. The top of the player will have the following, from left to @@ -130,19 +130,19 @@ picture above. \opt{ipodvideo}{hold switch, headphone jack.} \opt{ipodmini}{hold switch, remote connector, headphone jack.} - The dock connector that is used to connect your \dap\ to your computer is on - the bottom panel of the \dap. + The dock connector that is used to connect your \dap{} to your computer is on + the bottom panel of the \dap{}. - The button in the middle of the wheel is called \ButtonSelect. You can + The button in the middle of the wheel is called \ButtonSelect{}. You can operate the wheel by pressing the top, bottom, left or right sections, - or by sliding your finger around it. The top is \ButtonMenu, the bottom is - \ButtonPlay, the left is \ButtonLeft, and the right is \ButtonRight. - When the manual says to \ButtonScrollFwd, it means to slide your finger - clockwise around the wheel. \ButtonScrollBack\ means to slide your finger + or by sliding your finger around it. The top is \ButtonMenu{}, the bottom is + \ButtonPlay{}, the left is \ButtonLeft{}, and the right is \ButtonRight{}. + When the manual says to \ButtonScrollFwd{}, it means to slide your finger + clockwise around the wheel. \ButtonScrollBack{} means to slide your finger counterclockwise. Note that the wheel is sensitive, so you will need to move slowly at first and get a feel for how it works. - Note that when the hold switch is pushed toward the center of the \dap, + Note that when the hold switch is pushed toward the center of the \dap{}, ``hold'' is on, and none of the other controls do anything. Be sure ``hold'' is off before trying to use your player. } @@ -153,29 +153,28 @@ picture above. top surface. There is a Hold switch at one end, and headphone and USB jacks at the other; be sure the end with the switch is facing away from you. - The button in the middle of the wheel is called \ButtonSelect. You can + The button in the middle of the wheel is called \ButtonSelect{}. You can operate the wheel by pressing the top, bottom, left or right sections, - or by sliding your finger around it. The top is \ButtonMenu, the bottom is - \ButtonPlay, the left is \ButtonLeft, and the right is \ButtonRight. - When the manual says to \ButtonScrollFwd, it means to slide your finger + or by sliding your finger around it. The top is \ButtonMenu{}, the bottom is + \ButtonPlay, the left is \ButtonLeft, and the right is \ButtonRight{}. + When the manual says to \ButtonScrollFwd{}, it means to slide your finger clockwise around the wheel. \ButtonScrollBack{} means to slide your finger counterclockwise. Note that the wheel is sensitive, so you will need to move slowly at first and get a feel for how it works. - Note that when the Hold switch is pushed toward the center of the \dap, + Note that when the Hold switch is pushed toward the center of the \dap{}, Hold is on, and none of the other controls do anything; be sure Hold is off before trying to use your player. } % \nopt{h1xx,h300,ipodnano,ipodvideo,ipodmini,ipod4g,ipod3g,ipodcolor} { - \fixme{Write a section describing the \dap\ for blind users.} + \fixme{Write a section describing the \dap{} for blind users.} } } -\subsection{Turning the \dap\ on and off} -To turn on and shut down your \dap, the following keys are used: - +\subsection{Turning the \dap{} on and off} +To turn on your Rockbox enabled \dap{} use the following keys: \begin{table} \begin{btnmap}{}{} \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn} @@ -193,353 +192,103 @@ To turn on and shut down your \dap, the following keys are used: & Shutdown Rockbox\\ \end{btnmap} \end{table} + \label{ref:Safeshutdown}On shutdown, Rockbox automatically saves its settings. \opt{PLAYER_PAD,RECORDER_PAD,ONDIO_PAD}{ In the unlikely event of a software failure, a hardware power off can be performed by holding down - \opt{PLAYER_PAD}{\ButtonStop} + \opt{PLAYER_PAD}{\ButtonStop}% \opt{RECORDER_PAD,ONDIO_PAD}{\ButtonOff} - until the \nopt{ondiosp,ondiofm}{\dap\ power light} - \opt{ondiosp,ondiofm}{\daps\ display} goes off. -} - -\section{\label{ref:file_browser}File Browser} -\screenshot{rockbox_interface/images/ss-file-browser}{The file browser}{} -Rockbox lets you browse your music in either of two ways. The -\setting{File Browser} lets you navigate through the files and folders on -your \dap, entering folders and executing the default action on each file. -To help differentiate files, each file format is displayed with an icon. - -The \setting{Tag Cache Browser}, on the other hand, allows you to navigate -through the music on your player using categories like album, artist, genre, -etc. - -You can select whether to browse using the \setting{File Browser} or the -\setting{Tag Cache Browser} by adjusting the \setting{Show Files} setting. -If you choose the \setting{File Browser}, the \setting{Show Files} setting also -lets you select what types of files you wish to view. See -\reference{ref:ShowFiles} for more information on the \setting{Show Files} -setting. - -\note{The \setting{File Browser} allows you to manipulate your files in ways -that are not available within the \setting{Tag Cache Browser}. Read more about -\setting{Tag Cache} in \reference{ref:tagcache}. The remainder of this section deals with the \setting{File Browser}.} - -\opt{ondio}{\fixme{Add information on hotplug/multivolume support}} - -\subsection{\label{ref:controls}File Browser Controls} -\begin{table} - \begin{btnmap}{}{} - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,ONDIO_PAD,RECORDER_PAD,IAUDIO_X5_PAD} - {\ButtonUp/\ButtonDown} - \opt{PLAYER_PAD}{\ButtonLeft/\ButtonRight} - \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack/\ButtonScrollFwd} - & Go to previous/next item in list. If you are on the first/last - entry, the cursor will wrap to the last/first entry.\\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD} - {\ButtonOn+\ButtonUp/\ButtonDown} - \opt{PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD}{n/a} - \opt{ONDIO_PAD}{n/a} - & Move one page up/down on the list.\\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,IAUDIO_X5_PAD,ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonLeft} - \opt{PLAYER_PAD}{\ButtonStop} - & Go to the parent directory. \\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD} - {\ButtonRight/\ButtonSelect} - \opt{PLAYER_PAD}{\ButtonPlay} - \opt{ONDIO_PAD}{\ButtonRight} - \opt{RECORDER_PAD}{\ButtonRight/\ButtonPlay} - & Executes an action. Depending on the file type, that action may vary. - (See \reference{ref:Filemenu}) \\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,PLAYER_PAD,RECORDER_PAD}{\ButtonOn} - \opt{IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonPlay} - \opt{ONDIO_PAD}{Short press on \ButtonMenu} - & If there is a MP3 playing, returns to the While Playing Screen (WPS) - without stopping playback. \\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD} - {Hold \ButtonSelect} - \opt{RECORDER_PAD,PLAYER_PAD}{Hold \ButtonPlay/\ButtonOn+\ButtonPlay} - \opt{ONDIO_PAD}{Hold \ButtonRight} - & Enter the File Menu\\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode} - \opt{RECORDER_PAD}{\ButtonFOne} - \opt{PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,ONDIO_PAD,IPOD_VIDEO_PAD}{\ButtonMenu} - \opt{IAUDIO_X5_PAD}{Press \ButtonRec} - & Enter the Main Menu \\ - % - \opt{RECORDER_PAD}{ - \ButtonFTwo & Switches to the Browse/Play Quick Menu \\ - % - \ButtonFThree & Switches to the Display Quick Menu \\ - % - } - \end{btnmap} -\end{table} - -\opt{RECORDER_PAD}{ - The functions of the F keys are also summarised on the button bar at the - bottom of the screen. -} - -\subsection{\label{ref:Filemenu}\label{ref:PartIISectionFM}File Menu} -\screenshot{rockbox_interface/images/ss-file-menu}{The File Menu}{} - -The \setting{File Menu} allows you to perform certain operations on files or -folders. To access the \setting{File Menu}, position the selector over a file -or folder and - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD} - {hold the \ButtonSelect\ button.} - \opt{RECORDER_PAD,PLAYER_PAD}{press the \ButtonPlay/\ButtonOn+\ButtonPlay\ - buttons.} - \opt{ONDIO_PAD}{hold the \ButtonRight\ button.} - -\note{The \setting{File Menu} is a context sensitive menu. If the -\setting{File Menu} is invoked on a file, it will display options available -for files. If the \setting{File Menu} is invoked on a folder or directory, -it will display options for directories.} - -The \setting{File Menu} contains the following options (unless otherwise noted, -each option pertains both to files and directories): - -\begin{description} -\item [Playlist:] - Enters the \setting{Playlist Submenu} (see below). -\item [Rename:] - This function lets the user modify a file name. -\item [Cut:] - Copies the name of the currently selected file or directory to the clipboard - and marks it to be 'cut'. -\item [Copy:] - Copies the name of the currently selected file or directory to the clipboard - and marks it to be 'copied'. -\item [Paste:] - Only visible if a file or directory name is on the clipboard. When selected - it will move or copy the clipboard to the current directory. -\item [Delete:] - Deletes the currently selected file. This option applies only to files, and - not to directories. Rockbox will ask for confirmation before deleting a file. - Press - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD} - {\ButtonSelect} - \opt{PLAYER_PAD,RECORDER_PAD}{\ButtonPlay} - \opt{ONDIO_PAD}{\ButtonRight} - to confirm deletion or any other key to cancel. -\item [Delete Directory:] - Deletes the currently selected directory and all of the files and folders - contained in the selected directory. Deleted directories cannot be recovered. - Use this feature with caution! -\item [Open with:] - Runs a viewer plugin on the file. Normally, when a file is selected in Rockbox, - Rockbox automatically detects the file type and runs the appropriate plugin. - The \setting{Open With} function can be used to override the default action and - select a viewer by hand. For example, this function can be used to view a text file - even if the file has a non-standard extension (i.e., the file has an extension - of something other than \fname{.txt}). See \reference{ref:Viewersplugins} - for more details on viewers. -\item [Create Directory:] - Makes a new folder in the current folder on the disk. -\end{description} - -\subsection{\label{ref:Playlistsubmenu}Playlist Submenu} -\screenshot{rockbox_interface/images/ss-playlist-menu}{The Playlist Submenu}{} -The \setting{Playlist Submenu} allows you to put tracks into a ``dynamic playlist''. -If there is no music currently playing, Rockbox will create a new dynamic playlist -and put the selected track(s) into the playlist. If there is music currently playing, -Rockbox will put the selected track(s) into the current playlist. The place in which -the newly selected tracks are added to the playlist is determined by the following -options: - -\begin{description} -\item [Insert:] - Add track(s) to playlist. If no other tracks have been inserted then the - selected track will be added immediately after current playing track, - otherwise they will be added to end of insertion list. -\item [Insert next:] - Add track(s) immediately after current playing track, no matter what else has - been inserted. -\item [Insert last:] - Add track(s) to end of playlist. -\item [Queue:] - Queue is the same as Insert except queued tracks are deleted immediately from - the playlist after they've been played. Also, queued tracks are not saved to - the playlist file (see \reference{ref:playlistoptions}). -\item [Queue next:] - Queue track(s) immediately after current playing track. -\item [Queue last:] - Queue track(s) at end of playlist. -\end{description} - -The \setting{Playlist Submenu} can be used to add either single tracks or -entire directories to a playlist. If the \setting{Playlist Submenu} is -invoked on a single track, it will put only that track into the playlist. -On the other hand, if the \setting{Playlist Submenu} is invoked on a -directory, Rockbox adds all of the tracks in that directory to the playlist. - -\note{You can control whether or not Rockbox includes the contents of subdirectories -when adding an entire directory to a playlists. Set the \setting{Main Menu -$\rightarrow$ Playlist Options $\rightarrow$ Recusively Insert Directories} setting to -\setting{Yes} if you would like Rockbox to include tracks in subdirectories as well as tracks -in the currently-selected directory.} - -If you want to have Rockbox create a playlist of a whole folder (to play an entire -album, for example), use the \setting{File Browser} to select the song. When a single -song is selected from the \setting{File Browser}, Rockbox will automatically create a -playlist with all songs in the current folder. However, if you want to play only a single -song and then stop, stop playback, navigate to the song you want to play, and use the -\setting{Playlist $\rightarrow$ Insert} function to select the song. - -Dynamic playlists are saved so resume will restore them exactly as they were before -shutdown. - -\note{To view, save or reshuffle the current dynamic playlist, use the -\setting{Playlist Options} setting in the WPS Context Menu.} - -\subsection{Virtual Keyboard} -\screenshot{rockbox_interface/images/ss-virtual-keyboard}{The virtual keyboard}{} -This is the virtual keyboard that is used when entering file names in Rockbox. - -\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,RECORDER_PAD}{ - \begin{table} - \begin{btnmap}{}{} - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,RECORDER_PAD} - {\ButtonUp/\ButtonDown/\ButtonLeft/\ButtonRight} - & Move about the virtual keyboard (moves the solid cursor) \\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD} - {\ButtonOn+\ButtonLeft/\ButtonRight} - \opt{IAUDIO_X5_PAD}{Please add correct keys} - & Move about within the current file name (moves the line cursor) \\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect} - \opt{RECORDER_PAD}{\ButtonPlay} - \opt{IAUDIO_X5_PAD}{Please add correct keys} - & Inserts the currently selected keyboard letter at the current - filename cursor position \\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD}{\ButtonOff} - \opt{IAUDIO_X5_PAD}{Please add correct keys} - & Exits the virtual keyboard without saving any changes \\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{n/a} - \opt{RECORDER_PAD}{\ButtonFOne} - & SHIFT: Shifts between the upper case, lower case and accented keyboards \\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn} - \opt{RECORDER_PAD}{\ButtonFTwo} - \opt{IAUDIO_X5_PAD}{Please add correct keys} - & OK: Exits the virtual keyboard and saves any changes \\ - % - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec} - \opt{RECORDER_PAD}{\ButtonFThree} - \opt{IAUDIO_X5_PAD}{Please add correct keys} - & DEL: Deletes the character before the current filename cursor \\ - % - \opt{SWCODEC}{ - \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonMode} - \opt{IAUDIO_X5_PAD}{Please add correct keys} - & Enters Morse input mode\\ - } - \end{btnmap} - \end{table} + until the \nopt{ondiosp,ondiofm}{\dap{} power light}% + \opt{ondiosp,ondiofm}{\daps{} display} goes off.% } - -\opt{IPOD_4G_PAD,IPOD_3G_PAD}{ - \textbf{Picker area} - \begin{table} - \begin{btnmap}{}{} - \ButtonScrollFwd/\ButtonScrollBack & Move about the virtual keyboard \\ - \ButtonLeft/\ButtonRight & (moves the solid cursor). - If you move out of the picker area with \ButtonScrollFwd/\ButtonScrollBack, - you get to the line edit mode. \\ - \ButtonSelect - & Inserts the currently selected keyboard letter at the current - filename cursor position \\ - Hold \ButtonSelect - & OK: Exits the virtual keyboard and saves any changes \\ - \ButtonMenu - & Exits the virtual keyboard without saving any changes\\ - \end{btnmap} - \end{table} - \textbf{Line edit mode} - \begin{table} - \begin{btnmap}{}{} - \ButtonLeft/\ButtonRight & Move left and right\\ - \ButtonSelect & Deletes the letter to the left of the cursor\\ - \ButtonScrollFwd/\ButtonScrollBack & Returns to the picker area\\ - \end{btnmap} - \end{table} -} -\opt{ondio}{ - \textbf{Picker area} - \begin{table} - \begin{btnmap}{}{} - \ButtonUp/\ButtonDown/\ButtonLeft/\ButtonRight - & Move about the virtual keyboard (moves the solid cursor). - If you move out of the picker area with \ButtonUp/\ButtonDown, - you get to the line edit mode. \\ - \ButtonMenu - & Selects the letter underneath the cursor. \\ - Long press on \ButtonMenu - & Accepts the currently selected letter\\ - \ButtonOff - & Aborts the currently selected letter\\ - \end{btnmap} - \end{table} - \textbf{Line edit mode} - \begin{table} - \begin{btnmap}{}{} - \ButtonLeft/\ButtonRight & Move left and right\\ - \ButtonMenu & Deletes the letter to the left of the cursor\\ - Long press on \ButtonMenu & Accepts the deletion\\ - \ButtonUp/\ButtonDown & Returns to the picker area\\ - \end{btnmap} - \end{table} -}\opt{player}{ - The current filename is always listed on the first line of the display. The - second line of the display can contain the character selection bar, as in the - screenshot above, or one of a number of other options. - \begin{table} - \begin{btnmap}{}{} - \ButtonLeft/\ButtonRight & Moves the arrow to/from the filename \\ - & and changes between the character bar \\ - & and BACKSPACE, DELETE, ACCEPT and ABORT. \\ - \ButtonPlay/\ButtonStop & Varies (see below) \\ - \ButtonMenu & Shift. When the character selection bar is selected\\ - & this changes between upper case, lower case, \\ - & and accented letters. \\ - \end{btnmap} - \end{table} - - The function of the \ButtonPlay\ and \ButtonStop\ buttons depends on what the - arrow is pointing to, as follows. - - \begin{table} - \begin{center} - \begin{tabularx}{.75\textwidth}{lX} - \textbf{Selected option} & \textbf{Play/Stop function} \\\midrule - filename & Moves the cursor left (\ButtonStop) \\ - & or right (\ButtonPlay) within the filename \\ - character bar & Moves the character bar to the next (\ButtonPlay)\\ - & or previous (\ButtonStop) character. \\ - BACKSPACE & \ButtonPlay deletes the character before \\ - & the current cursor position \\ - DELETE & \ButtonPlay deletes the character at the \\ - & current cursor position\\ - ACCEPT & \ButtonPlay exits the virtual keyboard and \\ - & saves any changes \\ - ABORT & \ButtonPlay exits the virtual keyboard and \\ - & discards any changes \\\bottomrule - \end{tabularx} - \end{center} - \end{table} -} - -\input{rockbox_interface/tagcache.tex} -\input{rockbox_interface/wps.tex} - +\subsection{The first contact} + +After you have first started the \dap{} you'll be presented by the File +Browser. With the default settings only supported files are shown. Rockbox' +default view is the file browser, similar to Windows' Explorer. If you don't +have audio files on your \dap{}, or created folders you will only see a blank +screen with the statusbar at the top. If this is your case, now is a good time +to connect your \dap{} to a computer and transfer some audio files to it. + +When you have files on your \dap{} you'll see the supported ones now. Of +course you can change this view later. You can also completely switch to +a view that is based on the metadata\footnote{ID3 Tags, Vorbis comments, etc.} +of your audio files. This view is called TagCache (see +\reference{ref:tagcache}). Now you can start browsing the folder structure of +your \dap{}. + +\subsection{Basic controls} +When browsing files and moving through menus you usually get a list view +presented. The navigation in these lists are usually the same and should be +pretty intuitive. \fixme{Do we need to say that Rockbox is strange? + Nevertheless sometimes it may feel a bit strange as Rockbox follows some + conventions that aren'tt used by major companies.} + +In the tree view use \ActionStdNext{} and \ActionStdPrev{} to move around +the selection. Use \ActionStdOk{} to select an item. When browsing the file +system selecting an audio file plays it. The view switches to the ``While +playing screen'', usually abbreviated as ``WPS'' (see \reference{ref:WPS}. The +dynamic playlist gets replaced with the contents of the current folder. This +way you can easily treat folders as playlists. The created dynamic playlist can +be extended or modified while playing. This is also known as +``on-the-fly playlist''. +To go back to the file browser stop the playback with the \ActionWpsStop{} +button or return to the file browser while keeping playback running using +\ActionWpsBrowse{}. +\fixme{describe the back button in the tree view -- stop stops playback +in the file browser but not in the menus so it would be more consistent if +stop always would stop playback and left always go back (h100 buttons)} + +\subsection{Basic concepts} +\subsubsection{Main Screen} +Rockbox' main screen is the file browser. This is pretty different to most +other players that use the ``While Playing Screen'' as their main screen. +In Rockbox' view this doesn't make any sense as when you are not playing a +file, information about the currently playing file isn't available and therfore +useless. Because of this the \dap{} switches to the file browser when +playback gets stopped. There is no point showing the WPS when playback is +stopped, so this is not and will not be possible. + +\subsubsection{Playlists} +Rockbox is playlist oriented. This means that every time you play a audio file, +a so-called ``dynamic playlist'' is generated, unless you play a saved +playlist. You can modify the dynamic playlist while playing and also save +it to a file. If you don't want to use playlists you can simply play your +files folder based. +Playlists are covered in detail in \ref{ref:working_with_playlists}. + +\subsubsection{Menu} +From the menu you can customise Rockbox. Rockbox itself is very customisable. +Also there are some special menus for quick access to frequently used +functions. + +\subsubsection{Contect Menu} +Some views, especially the file browser and the WPS have a context menu. +From the file browser this can be accessed with \ActionStdContext{}. +The contents of the context menu vary, depending on the situation it gets +called. The context menu itself presents you with some operations you can +perform with the currently hightlighted file. In the file browser this is +the file (or folder) that is highlighted by the cursor. From the WPS this is +the currently playing file. Also there are some actions that don't apply +to the current file but refer to the screen from which the context menu +gets called. + +\section{Customizing Rockbox} +Rockbox' User Interface can be customized using ``Themes''. Themes usually +only affect the visual apperance, but an advanced user can create a theme +that also changes various other settings like file view, LCD settings and +all other settings that can be modified using \fname{.cfg} files. This topic +is discussed in more detail in \reference{ref:manage_settings}. +The Rockbox distribution comes with some themes that should look nice on +your \dap{}. \note{Some of the themes shipped with Rockbox need additional +fonts from the fonts package, so make sure you installed them. +Also, if you downloaded additional themes from the internet make sure you +have the needed fonts installed as otherwise the theme may get displayed +garbled.} + +\section{Menu overview} +\fixme{include an overview of the menu structure here} +%\input{rockbox_interface/menu_structure.tex} + +\input{rockbox_interface/playback.tex}
\ No newline at end of file diff --git a/manual/rockbox_interface/playback.tex b/manual/rockbox_interface/playback.tex new file mode 100644 index 0000000000..34a5c09a7e --- /dev/null +++ b/manual/rockbox_interface/playback.tex @@ -0,0 +1,324 @@ +% $Id$ % +\chapter{Browsing and playing} +\section{\label{ref:file_browser}File Browser} +\screenshot{rockbox_interface/images/ss-file-browser}{The file browser}{} +Rockbox lets you browse your music in either of two ways. The +\setting{File Browser} lets you navigate through the files and folders on +your \dap, entering folders and executing the default action on each file. +To help differentiate files, each file format is displayed with an icon. + +The \setting{Tag Cache Browser}, on the other hand, allows you to navigate +through the music on your player using categories like album, artist, genre, +etc. + +You can select whether to browse using the \setting{File Browser} or the +\setting{Tag Cache Browser} by adjusting the \setting{Show Files} setting. +If you choose the \setting{File Browser}, the \setting{Show Files} setting also +lets you select what types of files you wish to view. See +\reference{ref:ShowFiles} for more information on the \setting{Show Files} +setting. + +\note{The \setting{File Browser} allows you to manipulate your files in ways +that are not available within the \setting{Tag Cache Browser}. Read more about +\setting{Tag Cache} in \reference{ref:tagcache}. The remainder of this section deals with the \setting{File Browser}.} + +\opt{ondio}{\fixme{Add information on hotplug/multivolume support}} + +\subsection{\label{ref:controls}File Browser Controls} +\begin{table} + \begin{btnmap}{}{} + \ActionStdPrev{}/\ActionStdNext{} + & Go to previous/next item in list. If you are on the first/last + entry, the cursor will wrap to the last/first entry.\\ + % + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD} + {\ButtonOn+\ButtonUp/\ButtonDown} + \opt{PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD}{n/a} + \opt{ONDIO_PAD}{n/a} + & Move one page up/down on the list.\\ + % + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,IAUDIO_X5_PAD,ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonLeft} + \opt{PLAYER_PAD}{\ButtonStop} + & Go to the parent directory. \\ + % + \ActionStdOk{} + & Executes an action. Depending on the file type, that action may vary. + (See \reference{ref:Filemenu}) \\ + % + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,PLAYER_PAD,RECORDER_PAD}{\ButtonOn} + \opt{IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonPlay} + \opt{ONDIO_PAD}{Short press on \ButtonMenu} + & If there is a MP3 playing, returns to the While Playing Screen (WPS) + without stopping playback. \\ + % + \ActionStdContext{} + & Enter the File Menu\\ + % + \ActionStdMenu{} + & Enter the Main Menu \\ + % + \opt{RECORDER_PAD}{ + \ButtonFTwo & Switches to the Browse/Play Quick Menu \\ + % + \ButtonFThree & Switches to the Display Quick Menu \\ + % + } + \end{btnmap} +\end{table} + +\opt{RECORDER_PAD}{ + The functions of the F keys are also summarised on the button bar at the + bottom of the screen. +} + +\subsection{\label{ref:Filemenu}\label{ref:PartIISectionFM}File Menu} +\screenshot{rockbox_interface/images/ss-file-menu}{The File Menu}{} + +The \setting{File Menu} allows you to perform certain operations on files or +folders. To access the \setting{File Menu}, position the selector over a file +or folder and access the context menu with \ActionStdContext{}. + +\note{The \setting{File Menu} is a context sensitive menu. If the +\setting{File Menu} is invoked on a file, it will display options available +for files. If the \setting{File Menu} is invoked on a folder or directory, +it will display options for directories.} + +The \setting{File Menu} contains the following options (unless otherwise noted, +each option pertains both to files and directories): + +\begin{description} +\item [Playlist.] + Enters the \setting{Playlist Submenu} (see below). +\item [Rename.] + This function lets the user modify a file name. +\item [Cut.] + Copies the name of the currently selected file or directory to the clipboard + and marks it to be `cut'. +\item [Copy.] + Copies the name of the currently selected file or directory to the clipboard + and marks it to be `copied'. +\item [Paste.] + Only visible if a file or directory name is on the clipboard. When selected + it will move or copy the clipboard to the current directory. +\item [Delete.] + Deletes the currently selected file. This option applies only to files, and + not to directories. Rockbox will ask for confirmation before deleting a file. + Press \ActionStdOk{} + to confirm deletion or any other key to cancel. +\item [Delete Directory.] + Deletes the currently selected directory and all of the files and folders + contained in the selected directory. Deleted directories cannot be recovered. + Use this feature with caution! +\item [Open with.] + Runs a viewer plugin on the file. Normally, when a file is selected in Rockbox, + Rockbox automatically detects the file type and runs the appropriate plugin. + The \setting{Open With} function can be used to override the default action and + select a viewer by hand. + For example, this function can be used to view a text file + even if the file has a non-standard extension (i.e., the file has an extension + of something other than \fname{.txt}). See \reference{ref:Viewersplugins} + for more details on viewers. +\item [Create Directory.] + Create a new folder in the current folder on the disk. +\end{description} + +\subsection{\label{ref:Playlistsubmenu}Playlist Submenu} +\screenshot{rockbox_interface/images/ss-playlist-menu}{The Playlist Submenu}{} +The \setting{Playlist Submenu} allows you to put tracks into a ``dynamic +playlist''. If there is no music currently playing, Rockbox will create a +new dynamic playlist and put the selected track(s) into the playlist. +If there is music currently playing, Rockbox will put the selected track(s) +into the current playlist. The place in which +the newly selected tracks are added to the playlist is determined by +the following options: + +\begin{description} +\item [Insert.] + Add track(s) to playlist. If no other tracks have been inserted then the + selected track will be added immediately after current playing track, + otherwise they will be added to end of insertion list. +\item [Insert next.] + Add track(s) immediately after current playing track, no matter what else has + been inserted. +\item [Insert last.] + Add track(s) to end of playlist. +\item [Queue.] + Queue is the same as Insert except queued tracks are deleted immediately from + the playlist after they've been played. Also, queued tracks are not saved to + the playlist file (see \reference{ref:playlistoptions}). +\item [Queue next.] + Queue track(s) immediately after current playing track. +\item [Queue last.] + Queue track(s) at end of playlist. +\end{description} + +The \setting{Playlist Submenu} can be used to add either single tracks or +entire directories to a playlist. If the \setting{Playlist Submenu} is +invoked on a single track, it will put only that track into the playlist. +On the other hand, if the \setting{Playlist Submenu} is invoked on a +directory, Rockbox adds all of the tracks in that directory to the playlist. + +\note{You can control whether or not Rockbox includes the contents of subdirectories +when adding an entire directory to a playlists. Set the \setting{Main Menu +$\rightarrow$ Playlist Options $\rightarrow$ Recusively Insert Directories} setting to +\setting{Yes} if you would like Rockbox to include tracks in subdirectories as well as tracks +in the currently-selected directory.} + +If you want to have Rockbox create a playlist of a whole folder (to play an entire +album, for example), use the \setting{File Browser} to select the song. When a single +song is selected from the \setting{File Browser}, Rockbox will automatically create a +playlist with all songs in the current folder. However, if you want to play only a single +song and then stop, stop playback, navigate to the song you want to play, and use the +\setting{Playlist $\rightarrow$ Insert} function to select the song. + +Dynamic playlists are saved so resume will restore them exactly as they were before +shutdown. + +\note{To view, save or reshuffle the current dynamic playlist, use the +\setting{Playlist Options} setting in the WPS Context Menu.} + +\subsection{Virtual Keyboard} +\screenshot{rockbox_interface/images/ss-virtual-keyboard}{The virtual keyboard}{} +This is the virtual keyboard that is used when entering file names in Rockbox. + +\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,RECORDER_PAD}{ + \begin{table} + \begin{btnmap}{}{} + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,RECORDER_PAD} + {\ButtonUp/\ButtonDown/\ButtonLeft/\ButtonRight} + & Move about the virtual keyboard (moves the solid cursor) \\ + % + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD} + {\ButtonOn+\ButtonLeft/\ButtonRight} + \opt{IAUDIO_X5_PAD}{Please add correct keys} + & Move about within the current file name (moves the line cursor) \\ + % + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect} + \opt{RECORDER_PAD}{\ButtonPlay} + \opt{IAUDIO_X5_PAD}{Please add correct keys} + & Inserts the currently selected keyboard letter at the current + filename cursor position \\ + % + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD}{\ButtonOff} + \opt{IAUDIO_X5_PAD}{Please add correct keys} + & Exits the virtual keyboard without saving any changes \\ + % + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{n/a} + \opt{RECORDER_PAD}{\ButtonFOne} + & SHIFT: Shifts between the upper case, lower case and accented keyboards \\ + % + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn} + \opt{RECORDER_PAD}{\ButtonFTwo} + \opt{IAUDIO_X5_PAD}{Please add correct keys} + & OK: Exits the virtual keyboard and saves any changes \\ + % + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec} + \opt{RECORDER_PAD}{\ButtonFThree} + \opt{IAUDIO_X5_PAD}{Please add correct keys} + & DEL: Deletes the character before the current filename cursor \\ + % + \opt{SWCODEC}{ + \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn+\ButtonMode} + \opt{IAUDIO_X5_PAD}{Please add correct keys} + & Enters Morse input mode\\ + } + \end{btnmap} + \end{table} +} + +\opt{IPOD_4G_PAD,IPOD_3G_PAD}{ + \textbf{Picker area} + \begin{table} + \begin{btnmap}{}{} + \ButtonScrollFwd/\ButtonScrollBack & Move about the virtual keyboard \\ + \ButtonLeft/\ButtonRight & (moves the solid cursor). + If you move out of the picker area with \ButtonScrollFwd/\ButtonScrollBack, + you get to the line edit mode. \\ + \ButtonSelect + & Inserts the currently selected keyboard letter at the current + filename cursor position \\ + Hold \ButtonSelect + & OK: Exits the virtual keyboard and saves any changes \\ + \ButtonMenu + & Exits the virtual keyboard without saving any changes\\ + \end{btnmap} + \end{table} + \textbf{Line edit mode} + \begin{table} + \begin{btnmap}{}{} + \ButtonLeft/\ButtonRight & Move left and right\\ + \ButtonSelect & Deletes the letter to the left of the cursor\\ + \ButtonScrollFwd/\ButtonScrollBack & Returns to the picker area\\ + \end{btnmap} + \end{table} +} +\opt{ondio}{ + \textbf{Picker area} + \begin{table} + \begin{btnmap}{}{} + \ButtonUp/\ButtonDown/\ButtonLeft/\ButtonRight + & Move about the virtual keyboard (moves the solid cursor). + If you move out of the picker area with \ButtonUp/\ButtonDown, + you get to the line edit mode. \\ + \ButtonMenu + & Selects the letter underneath the cursor. \\ + Long press on \ButtonMenu + & Accepts the currently selected letter\\ + \ButtonOff + & Aborts the currently selected letter\\ + \end{btnmap} + \end{table} + \textbf{Line edit mode} + \begin{table} + \begin{btnmap}{}{} + \ButtonLeft/\ButtonRight & Move left and right\\ + \ButtonMenu & Deletes the letter to the left of the cursor\\ + Long press on \ButtonMenu & Accepts the deletion\\ + \ButtonUp/\ButtonDown & Returns to the picker area\\ + \end{btnmap} + \end{table} +}\opt{player}{ + The current filename is always listed on the first line of the display. The + second line of the display can contain the character selection bar, as in the + screenshot above, or one of a number of other options. + \begin{table} + \begin{btnmap}{}{} + \ButtonLeft/\ButtonRight & Moves the arrow to/from the filename \\ + & and changes between the character bar \\ + & and BACKSPACE, DELETE, ACCEPT and ABORT. \\ + \ButtonPlay/\ButtonStop & Varies (see below) \\ + \ButtonMenu & Shift. When the character selection bar is selected\\ + & this changes between upper case, lower case, \\ + & and accented letters. \\ + \end{btnmap} + \end{table} + + The function of the \ButtonPlay\ and \ButtonStop\ buttons depends on what the + arrow is pointing to, as follows. + + \begin{table} + \begin{center} + \begin{tabularx}{.75\textwidth}{lX} + \textbf{Selected option} & \textbf{Play/Stop function} \\\midrule + filename & Moves the cursor left (\ButtonStop) \\ + & or right (\ButtonPlay) within the filename \\ + character bar & Moves the character bar to the next (\ButtonPlay)\\ + & or previous (\ButtonStop) character. \\ + BACKSPACE & \ButtonPlay deletes the character before \\ + & the current cursor position \\ + DELETE & \ButtonPlay deletes the character at the \\ + & current cursor position\\ + ACCEPT & \ButtonPlay exits the virtual keyboard and \\ + & saves any changes \\ + ABORT & \ButtonPlay exits the virtual keyboard and \\ + & discards any changes \\\bottomrule + \end{tabularx} + \end{center} + \end{table} +} + +\input{rockbox_interface/tagcache.tex} +\input{rockbox_interface/wps.tex} +\ +\section{Using Playlists} +\fixme{adjust and add the section about working with playlists} |