Change two occurences of m3u to m3u8, as this is what Rockbox saves in. Thanks to...
[kugel-rb.git] / manual / working_with_playlists / main.tex
blob7cde45d38d305ec90d10fdbd43a71fb486548f1f
1 % $Id$ %
2 \section{\label{ref:working_with_playlists}Working with Playlists}
3 \fixme{This section is currently in a half written state, with possible errors
4 and a lot of stuff missing. Please help us fix this chapter by submitting
5 additions/corrections to the tracker}
7 \subsection{Playlist terminology}
8 Some common terms that are used in Rockbox when referring to
9 playlists:
11 \begin{description}
12 \item[Directory.] A playlist! One of the keys to getting the most out of
13 Rockbox is understanding that Rockbox \emph{always} considers the song that
14 it is playing to be part of a playlist, and in some situations, Rockbox will
15 create a playlist automatically. For example, if you are playing the
16 contents of a directory, Rockbox will automatically create a playlist
17 containing all songs in it. This means that just about anything
18 that is described in this chapter with respect to playlists also applies to
19 directories.
21 \item[Dynamic playlist.] A dynamic playlist is a playlist that is created
22 ``On the fly.'' Any time you insert or queue tracks using the
23 \setting{Playlist submenu} (see \reference{ref:playlist_submenu}), you are
24 creating (or adding to) a dynamic playlist.
26 \item[Insert.] In Rockbox, to \setting{Insert} an item into a playlist means
27 putting an item into a playlist and leaving it there, even after it is
28 played. As you will see later in this chapter, Rockbox can \setting{Insert}
29 into a playlist in several places.
31 \item[Queue.] In Rockbox, to \setting{Queue} a song means to put the song
32 into a playlist and then to remove the song from the playlist once it has
33 been played. The only difference between \setting{Insert} and
34 \setting{Queue} is that the \setting{Queue} option removes the song from the
35 playlist once it has been played, and the \setting{Insert} option does not.
36 \end{description}
38 \subsection{Creating playlists}
40 Rockbox can create playlists in four different ways.
42 \subsubsection{By selecting (``playing'') a song from the File Browser}
43 Whenever a song is selected from the \setting{File Browser} with
44 \ActionTreeEnter, Rockbox will automatically create a playlist containing
45 all of the songs in that directory and start playback with the selected
46 song.
48 \note{If you already have created a dynamic playlist, playing a new
49 song will \emph{erase} the current dynamic playlist and create a new one.
50 If you want to add a song to the current playlist
51 rather than erasing the current
52 playlist, see the section below on how to add music to a playlist.}
54 \subsubsection{By using Insert and Queue functions}
55 If playback is stopped, the \setting{Insert} and \setting{Queue} functions
56 can be used as described in \ref{ref:playlist_submenu}
57 to create a new playlist instead of adding to an existing one.
58 This will \emph{erase} any dynamic playlist.
60 \subsubsection{\label{ref:playlist_catalog}By using the Playlist catalog}
61 The \setting{Playlist catalog} makes it possible to modify and create playlists
62 that are not currently playing. To do this select \setting{Playlist catalog}
63 in the \setting{Context Menu}. There you will have two choices,
64 \setting{Add to playlist} adds the selected track or directory to an existing
65 playlist and \setting{Add to a new playlist} creates a new playlist containing
66 the selected track or directory.
68 \note{All playlists in the \setting{Playlist catalog} are stored by default
69 in the \fname{/Playlists} directory in the root of your \daps{} disk and
70 playlists stored in other locations are not included in the catalog. It is
71 however possible to move existing playlists there (see
72 \reference{ref:Contextmenu}).}
74 \subsubsection{By using the Main Menu}
75 To create a playlist containing all music on your \dap{}, you can use the
76 \setting{Create Playlist} command in the \setting{Playlists} menu found
77 in the \setting{Main Menu}. The created playlist will be named
78 \fname{root.m3u8} and saved in the root of your \daps{} disk.
80 \subsection{Adding music to playlists}
82 \subsubsection{\label{ref:playlist_submenu}Adding music to a dynamic playlist}
83 \screenshot{rockbox_interface/images/ss-playlist-menu}{The Playlist Submenu}{}
84 The \setting{Playlist Submenu} is a submenu in the \setting{Context Menu} (see
85 \reference{ref:Contextmenu}), it allows you to put tracks into a
86 ``dynamic playlist''. If there is no music currently playing, Rockbox will
87 create a new dynamic playlist and put the selected track(s) into it.
88 If there is music currently playing, Rockbox will put the
89 selected track(s) into the current playlist. The place in which the newly
90 selected tracks are added to the playlist is determined by the following
91 options:
93 \begin{description}
94 \item [Insert.] Add track(s) immediately after any tracks added via the most
95 recent \setting{Insert} operation. If no tracks have yet been added via an
96 \setting{Insert}, new tracks will be added immediately after the current
97 playing track. If playback is stopped a new dynamic playlist will get
98 created with the selected tracks.
100 \item [Insert Next.] Add track(s) immediately after current playing
101 track, no matter what else has been inserted.
103 \item [Insert Last.] Add track(s) to end of playlist.
105 \item [Insert Shuffled.] Add track(s) to the playlist in a random order.
107 \item [Queue.] Queue is the same as Insert except queued tracks are
108 deleted immediately from the playlist after they have been played. Also,
109 queued tracks are not saved to the playlist file (see
110 \reference{ref:playlistoptions}).
112 \item [Queue Next.] Queue track(s) immediately after current playing track.
114 \item [Queue Last.] Queue track(s) at end of playlist.
116 \item [Queue Shuffled.] Queue track(s) in a random order.
118 \item [Play Next.] Replaces all but the current playing track with track(s).
119 Current playing track is queued.
120 \end{description}
122 The \setting{Playlist Submenu} can be used to add either single tracks or
123 entire directories to a playlist. If the \setting{Playlist Submenu} is
124 invoked on a single track, it will put only that track into the playlist.
125 On the other hand, if the \setting{Playlist Submenu} is invoked on a
126 directory, Rockbox adds all of the tracks in that directory to the
127 playlist.
129 \note{You can control whether or not Rockbox includes the contents of
130 subdirectories when adding an entire directory to a playlists. Set the
131 \setting{Settings $\rightarrow$ General Settings $\rightarrow$ Playlist
132 $\rightarrow$ Recursively Insert Directories} setting to \setting{Yes} if
133 you would like Rockbox to include tracks in subdirectories as well as tracks
134 in the currently-selected directory.}
136 Dynamic playlists are saved so resume will restore them exactly as they
137 were before shutdown.
139 \note{To view, save or reshuffle the current dynamic playlist use the
140 \setting{Playlist} sub menu in the WPS context menu or in the
141 \setting{Main Menu}.}
143 \subsection{Modifying playlists}
144 \subsubsection{Reshuffling}
145 Reshuffling the current playlist is easily done from the \setting{Playlist}
146 sub menu in the WPS, just select \setting{Reshuffle}.
148 \subsubsection{Moving and removing tracks}
149 To move or remove a track from the current playlist enter the
150 \setting{Playlist Viewer} by selecting \setting{View Current Playlist} in the
151 \setting{Playlist} submenu in the WPS context menu or the \setting{Main Menu}.
152 Once in the \setting{Playlist Viewer} open the context menu on the track you
153 want to move or remove. If you want to move the track, select \setting{Move} in
154 the context menu and then move the blinking cursor to the place where you want
155 the track to be moved and confirm with \ActionStdOk. To remove a track, simply
156 select \setting{Remove} in the context menu.
158 \subsection{Saving playlists}
159 To save the current playlist either enter the \setting{Playlist} submenu
160 in the \setting{WPS Context Menu} (see \reference{sec:contextmenu}) and
161 select \setting{Save Current Playlist} or enter the
162 \setting{Playlist Options} menu in the \setting{Main Menu} and select
163 \setting{Save Current Playlist}.
164 Either method will bring you to the \setting{Virtual Keyboard} (see
165 \reference{sec:virtual_keyboard}), enter a filename for your playlist and
166 accept it and you are done.
168 \subsection{Loading saved playlists}
169 \subsubsection{Through the \setting{File Browser}}
170 Playlist files, like regular music tracks, can be selected through the
171 \setting{File Browser}. When loading a playlist from disk it will replace
172 the current dynamic playlist.
174 \subsubsection{Through the \setting{Playlist catalog}}
175 The \setting{Playlist catalog} offers a shortcut to all playlists in your
176 \daps{} specified playlist directory.
177 It can be used like the \setting{File Browser}.
179 \subsection{Helpful Hints}
181 \subsubsection{Including subdirectories in playlists}
182 You can control whether or not Rockbox includes the contents of
183 subdirectories when adding an entire directory to a playlists.
184 Set the \setting{Main Menu $\rightarrow$ Settings $\rightarrow$ General Settings
185 $\rightarrow$ Playlists $\rightarrow$ Recursively Insert Directories}
186 setting to \setting{On} if you would like to include tracks in subdirectories
187 as well as tracks in the currently selected directory.