summaryrefslogtreecommitdiffstats log msg author committer range
blob: a65ffb8993d3b1db78edb23767422a4cb68872ea (plain)
 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298  % $Id$ % \chapter{\label{ref:rockbox_interface}Quick Start} \section{Basic overview} \subsection{The \daps{} controls} \begin{center} % include the front image. Using \specimg makes this fairly easy, % but requires to use the exact value of \specimg in the filename! % The extension is selected in the preamble, so no further \ifpdfoutput % is necessary. \includegraphics[height=8cm]{rockbox_interface/images/\specimg-front} \end{center} Throughout this manual, the buttons on the \dap{} are labelled according to the picture above. When a table of button actions says Long'' before the button it means that you should make a long press on that button, in other words, press it for approximately 1 second. In detail the buttons are described in the following paragraph. \blind{ % \opt{h1xx}{ 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: On the right side the buttons \ButtonOn{}, \ButtonOff{}, \ButtonMode{} and the hold switch. Next comes on the bottom the USB port, a small hole for resetting the \dap{}, charger plug. On the left side located is the button \ButtonRec{}. At least the top has headphone mini-jack plug, remote port, optical/line in and 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. Its directions are labelled \ButtonRight{}, \ButtonDown{}, \ButtonLeft{} and \ButtonUp{}.} % \opt{h300}{ Hold or 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 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 following: headphone mini jack plug, remote port, Line-in, Line-out. 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 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 facing you. The top of the player will have the following, from left to right: \opt{ipod4g, ipod3g ,ipodcolor}{remote connector, headphone jack, hold switch.} \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 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 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{}, hold'' is on, and none of the other controls do anything. Be sure hold'' is off before trying to use your player. } % \opt{ipodnano}{ The main controls on the \dap{} are a slightly indented wheel with a flat round button in the center. Hold the \dap{} with these controls on the 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 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 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{}, Hold is on, and none of the other controls do anything; be sure Hold is off before trying to use your player. } % \opt{ondio}{ The main characteristic of the Ondio case is the dent on its lower right side which is the MMC slot. Holding the \dap{} with this slot in the described position you'll find the following: On the curved top it has the headphone jack to the left, the \ButtonOff{} button is in the middle% \opt{HAVE_RECORDING}{ and the line in jack to the right}. Apart from the already mentioned MMC slot you will find the USB connector on the \daps{} right side. Placed on the upper side of the device right below the flat display there is the main button pad of the \dap{}. A strong deepening marks the center of it and helps to operate the directional keys from there. \ButtonLeft{} and \ButtonRight{} form some sort of a strip and divide \ButtonUp{} and \ButtonDown{}. The raised button positioned in the lower left of this round crosspad is labelled \ButtonMenu{}.} % \opt{h10,h10_5gb}{ Hold or lay the \dap{} so that the side with the scroll pad and LCD is facing towards you. In the centre below the lcd is the scroll pad. It is oriented vertically. Touching the top and bottom half of it acts as the \ButtonScrollUp{} and \ButtonScrollDown{} buttons respectively. On the left of the scroll pad is the \ButtonLeft{} button and on the right is the \ButtonRight{} button. There are three buttons on the right hand side of the \dap{}. From top to bottom, they are: \ButtonRew{}, \ButtonPlay{} and \ButtonFF{}. On the left hand side is the \ButtonPower{} button. On the top panel of the \dap{}, from left to right, you can find the following: hold switch, \opt{h10}{reset pin hole, }remote port and headphone mini jack plug. On the bottom panel of the \dap{}, is the data cable port.} % \nopt{h1xx,h300,ipodnano,ipodvideo,ipodmini,ipod4g,ipod3g,ipodcolor,ondio,h10,h10_5gb} { \fixme{Write a section describing the \dap{} for blind users.} } } \subsection{Turning the \dap{} on and off} To turn on and off your Rockbox enabled \dap{} use the following keys: \begin{table} \begin{btnmap}{}{} \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}% \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu{} / \ButtonSelect}% \opt{ONDIO_PAD}{\ButtonOff}\opt{RECORDER_PAD,PLAYER_PAD}% {Hold \ButtonOn\ for 2--3s}% \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,GIGABEAT_PAD} {\ButtonPower}% & Start Rockbox\\ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{Hold \ButtonOff}% \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Hold \ButtonPlay}% \opt{ONDIO_PAD,recorderv2fm}{Hold \ButtonOff}% \opt{recorder}{Double tap \ButtonOff\ when playback is stopped}% \opt{PLAYER_PAD}{From the Main Menu, select \textbf{Shutdown}}% \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,GIGABEAT_PAD}% {Hold \ButtonPower}% & Shutdown Rockbox\\ \end{btnmap} \end{table} \label{ref:Safeshutdown}On shutdown, Rockbox automatically saves its settings. \nopt{gigabeat,x5,e200,archos} { \opt{ipod} { Rockbox has a dual-boot feature. To boot into the original firmware, shut down the device as described above. Turn on the hold'' switch immediately after turning the player on. Once Rockbox displays the message Loading original firmware ...'' you may turn the hold'' switch off. Rockbox will boot into the original firmware. \note{The described method of dual-booting works with Rockbox bootloader version 2, which was released 16 December 2006. If you have the older bootloader, boot the original firmware by pressing \ButtonMenu{} immediately after turning on your Ipod. Do not release the \ButtonMenu{} button until you see the Loading original firmware...'' message on the screen.} Regardless of which method you use to boot to the original firmware, you can return to Rockbox by pressing and holding \ButtonMenu{} and \ButtonSelect{} simultaneously until the player reboots. } \opt{h1xx} { Rockbox has a dual-boot feature. To boot into the original firmware, press and hold the \ButtonRec{} button, and then press the \ButtonOn{} button. } \opt{h300} { Rockbox has a dual-boot feature. To boot into the original firmware, press and hold the \ButtonRec{} button, and then press and hold the \ButtonOn{} button. } \opt{h10,h10_5gb} { It is possible to configure Rockbox to dual-boot, so that you can choose at start-up whether to run the original firmware or Rockbox. In order to dual-boot, you must first configure your player for dual-boot capability by following the directions on this wiki page: \url{http://www.rockbox.org/twiki/bin/view/Main/H10InstallationBeta}. Once your player is properly configured to dual-boot, you can boot to the original firmware by holding \ButtonLeft{} while turning on the player. } } \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{RECORDER_PAD,ONDIO_PAD}{\ButtonOff} until the \nopt{ondiosp,ondiofm}{\dap{} power light}% \opt{ondiosp,ondiofm}{\daps{} display} goes off.% } \subsection{The first contact} After you have first started the \dap{} you'll be presented by the \setting{Main Menu}. From this menu you can reach every function of Rockbox, for more information (see \reference{ref:main_menu}). To browse the files on you \dap{} select \setting{Files} (see\reference{ref:file_browser}), and to browse in a view that is based on the meta-data\footnote{ID3 Tags, Vorbis comments, etc.} of your audio files, select \setting{Database} (see \reference{ref:database}). \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. 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 \setting{File Browser} stop the playback with the \ActionWpsStop{} button or return to the file browser while keeping playback running using \ActionWpsBrowse{}. In list views you can go back one step with \ActionTreeParentDirectory. \subsection{Basic concepts} \subsubsection{Playlists} Rockbox is playlist oriented. This means that every time you play an 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 \reference{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{Context 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 highlighted 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. One example is the playback menu, which can be called using the context menu from within the WPS. \section{Customising Rockbox} Rockbox' User Interface can be customised using Themes''. Themes usually only affect the visual appearance, 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}