manual/rockbox_interface/browsing_and_playing.tex

   1 % $Id$ %
   2 \chapter{Browsing and playing}
   3 \section{\label{ref:file_browser}File Browser}
   4 \screenshot{rockbox_interface/images/ss-file-browser}{The file browser}{}
   5 Rockbox lets you browse your music in either of two ways. The
   6 \setting{File Browser} lets you navigate through the files and directories on
   7 your \dap, entering directories and executing the default action on each file.
   8 To help differentiate files, each file format is displayed with an icon.
   9
  10 The \setting{Database Browser}, on the other hand, allows you to navigate
  11 through the music on your player using categories like album, artist, genre,
  12 etc.
  13
  14 You can select whether to browse using the \setting{File Browser} or the
  15 \setting{Database Browser} by selecting either \setting{Files} or
  16 \setting{Database} in the \setting{Main Menu}.
  17 If you choose the \setting{File Browser}, the \setting{Show Files} setting
  18 lets you select what types of files you wish to view. See
  19 \reference{ref:ShowFiles} for more information on the \setting{Show Files}
  20 setting.
  21
  22 \note{The \setting{File Browser} allows you to manipulate your files in ways
  23 that are not available within the \setting{Database Browser}. Read more about
  24 \setting{Database} in \reference{ref:database}. The remainder of this section
  25 deals with the \setting{File Browser}.}
  26
  27 \opt{ondio}{
  28 Unlike the Archos Firmware, Rockbox provides multivolume support for the
  29 MultiMediaCard, this means the \dap{} can access both data volumes (internal
  30 memory and the MMC), thus being able to for instance, build playlists with
  31 files from both volumes.
  32 In the \setting{File Browser} a new directory will appear as soon as the device
  33 has read the content after inserting the card. This new directory's name is
  34 generated as \fname{<MMC1>}, and will behave exactly as any other directory
  35 on the \dap{}.
  36 }
  37
  38 \opt{h10,h10_5gb}{\note{
  39 If your \dap{} is a MTP model, the Music directory where all your music is stored
  40 may be hidden in the \setting{File Browser}. This may be fixed by either
  41 either changing its properties (on a computer) to not hidden, or by changing
  42 the \setting{Show Files} setting to all.
  43 }}
  44
  45 \subsection{\label{ref:controls}File Browser Controls}
  46 \begin{table}
  47     \begin{btnmap}{}{}
  48       \ActionStdPrev{}/\ActionStdNext{}
  49       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdPrev{}/\ActionRCStdNext{}}
  50          & Go to previous/next item in list. If you are on the first/last
  51            entry, the cursor will wrap to the last/first entry.\\
  52       %
  53       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD}
  54         {
  55           \ButtonOn+\ButtonUp{}/ \ButtonDown
  56           \opt{HAVEREMOTEKEYMAP}{&
  57             \opt{IRIVER_RC_H100_PAD}{\ButtonRCSource{}/ \ButtonRCBitrate}
  58           }
  59           & Move one page up/down in the list.\\
  60         }
  61       \opt{IRIVER_H10_PAD}
  62         {
  63           \ButtonRew{}/ \ButtonFF
  64           & Move one page up/down in the list.\\
  65         }
  66       %
  67       \ActionTreeParentDirectory
  68       \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeParentDirectory}
  69       & Go to the parent directory.\\
  70       %
  71       \ActionTreeEnter
  72       \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeEnter}
  73       & Execute the default action on the selected file or enter a
  74         directory.\\
  75       %
  76       \ActionTreeWps
  77       \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeWps}
  78          & If there is an audio file playing, return to the
  79          \setting{While Playing Screen} (WPS) without stopping playback.\\
  80       %
  81       \nopt{player,c200}%
  82         {%
  83           \ActionTreeStop
  84           \opt{HAVEREMOTEKEYMAP}{& \ActionRCTreeStop}
  85           & Stop audio playback.\\%
  86         }%
  87       %
  88       \ActionStdContext{}
  89       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdContext}
  90       & Enter the \setting{Context Menu}\\
  91       %
  92       \ActionStdMenu{}
  93       \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdMenu}
  94       & Enters the \setting{Main Menu}\\
  95       %
  96       \opt{quickscreen}{
  97         \ActionStdQuickScreen
  98         \opt{HAVEREMOTEKEYMAP}{& \ActionRCStdQuickScreen}
  99         & Switch to the \setting{Quick Screen}
 100         (see \reference{ref:QuickScreen}) \\
 101       }
 102       \opt{RECORDER_PAD}{
 103         \ButtonFThree & Switch to the \setting{Quick Screen}.\\
 104         %
 105       }
 106       %
 107       \opt{SANSA_E200_PAD}{
 108         \ActionStdRec & Switch to the \setting{Recording Screen}.\\
 109       %
 110       }
 111     \end{btnmap}
 112 \end{table}
 113
 114 \opt{RECORDER_PAD}{
 115   The functions of the F keys are also summarised on the button bar at the
 116   bottom of the screen.
 117 }
 118
 119 \subsection{\label{ref:Contextmenu}\label{ref:PartIISectionFM}Context Menu}
 120 \screenshot{rockbox_interface/images/ss-context-menu}{The Context Menu}{}
 121
 122 The \setting{Context Menu} allows you to perform certain operations on files or
 123 directories.  To access the \setting{Context Menu}, position the selector over a file
 124 or directory and access the context menu with \ActionStdContext{}.\\
 125
 126 \note{The \setting{Context Menu} is a context sensitive menu.  If the
 127 \setting{Context Menu} is invoked on a file, it will display options available
 128 for files.  If the \setting{Context Menu} is invoked on a directory,
 129 it will display options for directories.\\}
 130
 131 The \setting{Context Menu} contains the following options (unless otherwise noted,
 132 each option pertains both to files and directories):
 133
 134 \begin{description}
 135 \item [Playlist.]
 136   Enters the \setting{Playlist Submenu} (see \reference{ref:playlist_submenu}).
 137 \item [Playlist Catalog.]
 138   Enters the \setting{Playlist Catalog Submenu} (see
 139   \reference{ref:playlist_catalog}).
 140 \item [Rename.]
 141   This function lets the user modify the name of a file or directory.
 142 \item [Cut.]
 143   Copies the name of the currently selected file or directory to the clipboard
 144   and marks it to be `cut'.
 145 \item [Copy.]
 146   Copies the name of the currently selected file or directory to the clipboard
 147   and marks it to be `copied'.
 148 \item [Paste.]
 149   Only visible if a file or directory name is on the clipboard. When selected
 150   it will move or copy the clipboard to the current directory.
 151 \item [Delete.]
 152   Deletes the currently selected file. This option applies only to files, and
 153   not to directories. Rockbox will ask for confirmation before deleting a file.
 154   Press \ActionYesNoAccept{}
 155   to confirm deletion or any other key to cancel.
 156 \item [Delete Directory.]
 157   Deletes the currently selected directory and all of the files and subdirectories
 158   it may contain. Deleted directories cannot be recovered. Use this feature with
 159   caution!
 160 \opt{lcd_non-mono}{
 161 \item [Set As Backdrop.]
 162   Set the selected \fname{bmp} file as background image. The bitmaps need to meet the
 163   conditions explained in \reference{ref:LoadingBackdrops}.
 164 }
 165 \item [Open with.]
 166   Runs a viewer plugin on the file. Normally, when a file is selected in Rockbox,
 167   Rockbox automatically detects the file type and runs the appropriate plugin.
 168   The \setting{Open With} function can be used to override the default action and
 169   select a viewer by hand.
 170   For example, this function can be used to view a text file
 171   even if the file has a non-standard extension (i.e., the file has an extension
 172   of something other than \fname{.txt}). See \reference{ref:Viewersplugins}
 173   for more details on viewers.
 174 \item [Create Directory.]
 175   Create a new directory in the current directory on the disk.
 176 \item [Properties.]
 177   Shows properties such as size and the time and date of the last modification
 178   for the selected file. If used on a directory, the number of files and
 179   subdirectories will be shown, as well as the total size.
 180 \opt{recording}{
 181   \item [Set As Recording Directory.]
 182     Save recordings in the selected directory.
 183 }
 184 \item [Add to Shortcuts.]
 185   Adds a link to the selected item in the \fname{shortcuts.link} file.
 186   If the file does not already exist it will be created in the root directory.
 187   Note that if you create a shortcut to a file, Rockbox will not open it upon
 188   selecting, but simply bring you to it's location in the \setting{File Browser}.
 189 \end{description}
 190
 191 \subsection{\label{sec:virtual_keyboard}Virtual Keyboard}
 192 \screenshot{rockbox_interface/images/ss-virtual-keyboard}{The virtual keyboard}{}
 193 This is the virtual keyboard that is used when entering text in Rockbox, for
 194 example when renaming a file or creating a new directory.
 195 \nopt{player}{The virtual keyboard can be easily changed by making a text file
 196  with the required layout. More information on how to achieve this can be found
 197  on the Rockbox website at \wikilink{LoadableKeyboardLayouts}.}
 198
 199 \opt{morse_input}{
 200   Also you can switch to Morse code input mode by changing the
 201   \setting{Use Morse Code Input} setting%
 202   \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD%
 203       ,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_E200_PAD}%
 204     { or by pressing \ActionKbdMorseInput{} in the virtual keyboard}%
 205   .
 206 }
 207
 208 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
 209     ,MROBE100_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD}{
 210   \begin{table}
 211     \begin{btnmap}{}{}
 212       \ActionKbdLeft{} / \ActionKbdRight{} / \ActionKbdUp{} / \ActionKbdDown
 213       \opt{HAVEREMOTEKEYMAP}{
 214       & \ActionRCKbdLeft{} / \ActionRCKbdRight{} / \ActionRCKbdUp{} / \ActionRCKbdDown}
 215       & Move the cursor on the virtual keyboard. \\
 216       %
 217       \ActionKbdPageFlip
 218       \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdPageFlip}
 219       & Flip to the next page of characters (if there is more than one). \\
 220       %
 221       \ActionKbdCursorLeft{} / \ActionKbdCursorRight
 222       \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdCursorLeft{} / \ActionRCKbdCursorRight}
 223       & Move the line cursor within the text line. \\
 224       %
 225       \ActionKbdSelect
 226       \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdSelect}
 227       & Insert the selected keyboard letter at the current line cursor position. \\
 228       %
 229       \ActionKbdBackSpace
 230       \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdBackSpace}
 231       & Delete the character before the line cursor. \\
 232       %
 233       \ActionKbdDone
 234       \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdDone}
 235       & Exit the virtual keyboard and saves any changes. \\
 236       %
 237       \ActionKbdAbort
 238       \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdAbort}
 239       & Exit the virtual keyboard without saving any changes. \\
 240       %
 241       \opt{morse_input}{
 242         \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
 243             ,MROBE100_PAD,SANSA_E200_PAD}{
 244           \ActionKbdMorseInput
 245           \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdMorseInput}
 246           & Toggle keyboard input mode and Morse code input mode. \\
 247         }
 248         %
 249         \ActionKbdMorseSelect
 250         \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdMorseSelect}
 251         & Tap to select a character in Morse code input mode. \\
 252         %
 253       }
 254     \end{btnmap}
 255   \end{table}
 256 }
 257 \opt{ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,IAUDIO_X5_PAD,IAUDIO_M3_PAD}{
 258   \textbf{Picker area}
 259   \begin{table}
 260     \begin{btnmap}{}{}
 261       \ActionKbdLeft{} / \ActionKbdRight
 262       \opt{HAVEREMOTEKEYMAP}{& }
 263       & Move the cursor on the virtual keyboard.
 264         If you move out of the picker area, you get the previous/next page of
 265         characters (if there is more than one). \\
 266       %
 267       \ActionKbdUp{} / \ActionKbdDown
 268       \opt{HAVEREMOTEKEYMAP}{& }
 269       & Move the cursor on the virtual keyboard.
 270         If you move out of the picker area you get to the line edit mode. \\
 271       %
 272       \ActionKbdSelect
 273       \opt{HAVEREMOTEKEYMAP}{& }
 274       & Insert the selected keyboard letter at the current line cursor position. \\
 275       %
 276       \ActionKbdDone
 277       \opt{HAVEREMOTEKEYMAP}{& }
 278       & Exit the virtual keyboard and save any changes. \\
 279       %
 280       \ActionKbdAbort
 281       \opt{HAVEREMOTEKEYMAP}{& }
 282       & Exit the virtual keyboard without saving any changes. \\
 283       %
 284       \opt{morse_input}{
 285         \opt{IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}{
 286           \ActionKbdMorseInput
 287           \opt{HAVEREMOTEKEYMAP}{& }
 288           & Toggle keyboard input mode and Morse code input mode. \\
 289         }
 290         %
 291         \ActionKbdMorseSelect
 292         \opt{HAVEREMOTEKEYMAP}{& \ActionRCKbdMorseSelect}
 293         & Tap to select a character in Morse code input mode. \\
 294         %
 295       }
 296     \end{btnmap}
 297   \end{table}
 298
 299   \textbf{Line edit mode}
 300   \begin{table}
 301     \begin{btnmap}{}{}
 302       \ActionKbdLeft{} / \ActionKbdRight
 303       \opt{HAVEREMOTEKEYMAP}{& }
 304       & Move the line cursor within the text line. \\
 305       %
 306       \ActionKbdSelect
 307       \opt{HAVEREMOTEKEYMAP}{& }
 308       & Delete the character before the line cursor. \\
 309       %
 310       \ActionKbdUp{} / \ActionKbdDown
 311       \opt{HAVEREMOTEKEYMAP}{& }
 312       & Return to the picker area. \\
 313       %
 314     \end{btnmap}
 315   \end{table}
 316 }
 317 \opt{player}{
 318   The current text line to be entered or edited is always listed on the first
 319   line of the display. The second line of the display can contain the character
 320   selection bar, as in the screenshot above.
 321   \begin{table}
 322     \begin{btnmap}{}{}
 323       \ButtonOn & Toggle picker- and line edit mode. \\
 324       \ButtonLeft{} / \ButtonRight
 325         & Move back and forth in the selected line (picker of input line). \\
 326       \ButtonPlay
 327         & Pick character in character bar, or act as backspace in the text line. \\
 328       Long \ButtonPlay & Accept \\
 329       \ButtonStop & Cancel \\
 330       \ButtonMenu & Flip picker lines. \\
 331     \end{btnmap}
 332   \end{table}
 333 }
 334
 335 \input{rockbox_interface/tagcache.tex}
 336 \input{rockbox_interface/wps.tex}
 337
 338 %Include playlist section
 339 \input{working_with_playlists/main.tex}