tsiry-sandratraina.com
A modern Music Player Daemon based on Rockbox open source high quality audio player
libadwaita
audio
rust
zig
deno
mpris
rockbox
mpd
Manual updates
- Reverse order of prev/next buttons in html manual
- Rename "Playlist Catalogue" to "Playlists"
- Update order of menu items in "Playlists" context menu section
- Add "View Album Art" to "WPS Context Menu" section
- Adjust wording in "Playlists", "Basic Controls/Concepts" and
"Database" section
- Fix: Playlists are saved to root directory (not cwd) if no path
provided
- Fix: "Recursively Insert Directories" applies to all playlists,
not just the current one
- Fix: Update description of "Create Playlist" option
- Generally refer to "current playlist" instead of
"dynamic playlist" and remove reference to "on-the-fly playlist"
Change-Id: I200d19c5fb10f1f0ddb7d993827c90be4a7402b9
authored by
Christian Soffke
and committed by
Solomon Peachy
ecc72c0d
8d50ac77
+1
-1
manual/configure_rockbox/playback_options.tex
+1
-1
manual/configure_rockbox/playback_options.tex
···
92
92
93
93
\section{Party Mode}
94
94
Enables unstoppable music playback. When new songs are
95
-
selected, they are queued at the end of the current dynamic playlist
95
+
selected, they are queued at the end of the current playlist
96
96
instead of being played immediately. Pausing and stopping playback is
97
97
disabled as well as skipping songs and launching plugins.
98
98
+5
-4
manual/configure_rockbox/playlist_options.tex
+5
-4
manual/configure_rockbox/playlist_options.tex
···
19
19
\end{description}
20
20
21
21
\item[Recursively Insert Directories.]
22
-
If set to \setting{On}, then when a directory is inserted or queued into a
23
-
dynamic playlist, all subdirectories will also be inserted. If set to \setting{Ask},
22
+
If set to \setting{On}, then when a directory is added to a playlist,
23
+
all subdirectories will also be added. If set to \setting{Ask},
24
24
Rockbox will prompt the user about whether to include sub-directories.
25
25
26
26
\item[Current Playlist.]
27
-
This submenu contains settings related to the current dynamic playlist.
27
+
This submenu contains settings related to the current playlist.
28
28
\begin{description}
29
29
30
30
\item[Warn When Erasing Dynamic Playlist.]
31
31
If set to \setting{Yes}, Rockbox will provide a warning if the user attempts to
32
-
take an action that will cause Rockbox to erase the current dynamic playlist.
32
+
take an action that will cause Rockbox to erase a current playlist that has been
33
+
modified.
33
34
34
35
\item[Keep Current Track When Replacing Playlist.]
35
36
If set to \setting{Yes}, then \setting{Play} and \setting{Play Shuffled} in
+1
-1
manual/configure_rockbox/wps.tex
+1
-1
manual/configure_rockbox/wps.tex
···
4
4
\begin{description}
5
5
\item[Default Browser.]
6
6
Decide if you want the \setting{File Browser}, \setting{Database}, or
7
-
\setting{Playlist Catalogue} to launch after pressing \ActionWpsBrowse{}
7
+
\setting{Playlists} to launch after pressing \ActionWpsBrowse{}
8
8
on the WPS, when no other browser has recently been used.
9
9
\opt{hotkey}{
10
10
\item[WPS Hotkey.] Sets the hotkey function for
+1
-1
manual/rockbox-html.cfg
+1
-1
manual/rockbox-html.cfg
···
19
19
\Configure{Link}{a}{href=}{name=}{}
20
20
\Configure{@HEAD}{\HCode{<script type="text/javascript" src="gsearch.js"></script>}}
21
21
\Configure{BODY}{\HCode{<body onload="gsearch();">}}{\HCode{</body>}}
22
-
\Configure{crosslinks*}{next}{up}{prev}{}
22
+
\Configure{crosslinks*}{prev}{up}{next}{}
23
23
\Configure{crosslinks+}%
24
24
{\HCode{<div style='float:left;'><a href='https://www.rockbox.org'><img src='https://www.rockbox.org/rockbox100.png'/></a></div><div id='gsearch' style='float:right;'>Enable JavaScript to show search field.</div><div style='clear:both;' class='crosslinks'>}}%
25
25
{\HCode{</div>}}%
+3
-1
manual/rockbox_interface/browsing_and_playing.tex
+3
-1
manual/rockbox_interface/browsing_and_playing.tex
···
180
180
\subsubsection{Set As...}
181
181
\begin{description}
182
182
\item [Playlist Directory.]
183
-
Set as default directory for the Playlist Catalogue.
183
+
Set as default playlist directory. Playlists from this directory will appear
184
+
when you select \setting{Playlists} from the main menu
185
+
(see \reference{ref:playlistoptions}).
184
186
\opt{tagcache}{
185
187
\item [Database Directory.]
186
188
Rockbox usually stores database files in the \fname{/.rockbox} folder.
+28
-38
manual/rockbox_interface/main.tex
+28
-38
manual/rockbox_interface/main.tex
···
794
794
795
795
\subsection{The first contact}
796
796
797
-
After you have first started the \dap{}, you'll be presented by the
798
-
\setting{Main Menu}. From this menu you can reach every function of Rockbox,
799
-
for more information (see \reference{ref:main_menu}). To browse the files
797
+
After you have first started the \dap{}, you'll be presented with the
798
+
\setting{Main Menu}. From this menu you can reach every function of Rockbox.
799
+
For more information, see \reference{ref:main_menu}. To browse the files
800
800
on your \dap{}, select \setting{Files} (see \reference{ref:file_browser}), and to
801
-
browse in a view that is based on the meta-data\footnote{ID3 Tags, Vorbis
801
+
browse based on the meta-data\footnote{ID3 Tags, Vorbis
802
802
comments, etc.} of your audio files, select \setting{Database} (see
803
803
\reference{ref:database}).
804
804
805
805
\subsection{Basic controls}
806
-
When browsing files and moving through menus you usually get a list view
807
-
presented. The navigation in these lists are usually the same and should be
808
-
pretty intuitive.
809
-
In the tree view use \ActionStdNext{} and \ActionStdPrev{} to move around
810
-
the selection. Use \ActionStdOk{} to select an item. \opt{wheel_acceleration}{
811
-
Note that the scroll speed is accelerating the faster you rotate the wheel.}
812
-
When browsing the file system selecting an audio file plays it. The view
813
-
switches to the ``While playing screen'', usually abbreviated as ``WPS'' (see
814
-
\reference{ref:WPS}. The dynamic playlist gets replaced with the contents of
815
-
the current directory. This way you can easily treat directories as playlists.
816
-
The created dynamic playlist can be extended or modified while playing. This is
817
-
also known as ``on-the-fly playlist''.
818
-
To go back to the \setting{File Browser} stop the playback with the
819
-
\ActionWpsStop{} button or return to the file browser while keeping playback
820
-
running using \ActionWpsBrowse{}.
821
-
In list views you can go back one step with \ActionTreeParentDirectory.
806
+
Use \ActionStdNext{} and \ActionStdPrev{} to adjust the selection when browsing
807
+
through menus. \opt{wheel_acceleration}{
808
+
Note that scroll speed accelerates, the faster you rotate the wheel.}
809
+
Press \ActionStdOk{} to select an item. Selecting an audio file in the File Browser
810
+
will play it. The ``While playing screen'' (``WPS'', see \reference{ref:WPS}) will
811
+
be displayed, and the current playlist will be replaced with tracks from the current
812
+
directory. To go back to the bowser, either stop playback using the
813
+
\ActionWpsStop{} button, or press \ActionWpsBrowse{}, which keeps playback
814
+
running.
815
+
When browsing files, return to parent directories with \ActionTreeParentDirectory.
822
816
823
817
\subsection{Basic concepts}
824
818
\subsubsection{Playlists}
825
-
Rockbox is playlist oriented. This means that every time you play an audio file,
826
-
a so-called ``dynamic playlist'' is generated, unless you play a saved
827
-
playlist. You can modify the dynamic playlist while playing and also save
828
-
it to a file. If you do not want to use playlists you can simply play your
829
-
files directory based.
819
+
Rockbox is playlist-oriented. This means that every time you play an audio file,
820
+
a current playlist is generated.
821
+
You can modify the current playlist in many ways while playing, and also save
822
+
it to a file. But you are not forced to do so.
830
823
Playlists are covered in detail in \reference{ref:working_with_playlists}.
831
824
832
825
\subsubsection{Menu}
833
-
From the menu you can customise Rockbox. Rockbox itself is very customisable.
834
-
Also there are some special menus for quick access to frequently used
835
-
functions.
826
+
Menus are the primary way of interacting with Rockbox and offer quick access
827
+
to frequently-used functions.
836
828
837
829
\subsubsection{Context Menu}
838
-
Some views, especially the file browser and the WPS have a context menu.
839
-
From the file browser this can be accessed with \ActionStdContext{}.
840
-
The contents of the context menu vary, depending on the situation it gets
841
-
called. The context menu itself presents you with some operations you can
842
-
perform with the currently highlighted file. In the file browser this is
843
-
the file (or directory) that is highlighted by the cursor. From the WPS this is
844
-
the currently playing file. Also there are some actions that do not apply
845
-
to the current file but refer to the screen from which the context menu
846
-
gets called. One example is the playback menu, which can be called using
847
-
the context menu from within the WPS.
830
+
In many places, a context menu can be accessed by pressing \ActionStdContext{}.
831
+
A context menu allows you to perform actions relevant to your current selection, and may
832
+
include more advanced commands.
833
+
In the file browser, the relevant selection may be a file (or directory).
834
+
On the WPS, it is the currently playing track. Some actions do not apply
835
+
to the selection, but relate to the screen itself, from which the context menu
836
+
was accessed. Playback settings accessible from the “While playing screen” are one such
837
+
example.
848
838
849
839
\section{Customising Rockbox}
850
840
Rockbox' User Interface can be customised using ``Themes''. Themes usually
+6
-12
manual/rockbox_interface/tagcache.tex
+6
-12
manual/rockbox_interface/tagcache.tex
···
133
133
$\rightarrow$ System $\rightarrow$ Limits}) in order to view long lists of
134
134
tracks in the ID3 database browser.\\
135
135
136
-
There is no option to turn off database completely. If you do not want
137
-
to use it just do not do the initial build of the database and do not load it
138
-
to RAM.}%
136
+
To "turn off" the database, do not initialize it, and do not load it to RAM.}%
139
137
140
-
If your total amount of music tracks exceeds the value of the
138
+
If the number of tracks you are attempting to play exceeds the value of the
141
139
\setting{Max Playlist Size} setting (\setting{Settings $\rightarrow$ General
142
-
Settings $\rightarrow$ System $\rightarrow$ Limits}), using the database
143
-
will be your only way to shuffle between all songs from your music library.
144
-
Any view on the database browser that exceeds the maximum value of this option
145
-
will be automatically adjusted and randomized to fit into the available space
146
-
when you will create a dynamic playlist from the view.
147
-
Using the database browser is recommended if you shuffle regularly between a lot of
148
-
songs rather than increasing your limit, so you will get the best possible performance
149
-
on this action.
140
+
Settings $\rightarrow$ System $\rightarrow$ Limits}), a randomly chosen
141
+
subset of tracks is added to the current playlist instead. This allows you
142
+
to play random tracks from your whole library without having to increase any
143
+
limits that may degrade performance.
150
144
151
145
\note{For your convenience, a shortcut button "Shuffle Songs" is available directly
152
146
from the \setting{Database} menu to create and start a mix with all of your
+5
-2
manual/rockbox_interface/wps.tex
+5
-2
manual/rockbox_interface/wps.tex
···
61
61
%
62
62
\ActionWpsBrowse
63
63
\opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsBrowse}
64
-
& Return to the \setting{File Browser} / \setting{Database} / \setting{Playlist Catalogue}.\\
64
+
& Return to the \setting{File Browser} / \setting{Database} / \setting{Playlists}.\\
65
65
%
66
66
\ActionWpsContext
67
67
\opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsContext}
···
177
177
178
178
\subsection{\label{sec:contextmenu}The WPS Context Menu}
179
179
Like the context menu for the \setting{File Browser}, the \setting{WPS Context Menu}
180
-
allows you quick access to some often used functions.
180
+
allows you quick access to some often-used functions.
181
181
182
182
\subsubsection{Current Playlist}
183
183
The \setting{Current Playlist} submenu allows you to view, save, search, reshuffle,
···
328
328
\end{btnmap}
329
329
330
330
}
331
+
332
+
\subsubsection{View Album Art}
333
+
Display artwork for the currently playing track.
+19
-43
manual/working_with_playlists/main.tex
+19
-43
manual/working_with_playlists/main.tex
···
1
1
% $Id$ %
2
2
\section{\label{ref:working_with_playlists}Working with Playlists}
3
3
4
-
\subsection{Playlist terminology}
5
-
6
-
\begin{description}
7
-
\item[Directory.] Rockbox always considers the song that is playing to be part of
8
-
a playlist, and will create a playlist automatically when you are playing the
9
-
contents of a directory. Meaning, just about anything that is described in this
10
-
chapter with respect to playlists also applies to directories.
11
-
12
-
\item[Dynamic playlist.] A dynamic playlist is a playlist created
13
-
``on the fly.'' Any time you use the \setting{Playing Next...} menu
14
-
(see \reference{ref:playingnext_submenu}), or play something
15
-
from the database, you are creating or adding to a dynamic playlist.
16
-
17
-
\item[Play / Add.] \setting{Play} or \setting{Add} a track to
18
-
put it into the current (dynamic) playlist.
19
-
20
-
\item[Queue.] \setting{Queued} tracks are also put into the dynamic playlist,
21
-
but removed again as soon as they've been played.
22
-
Note: Options for queuing tracks are hidden by default (see \reference{ref:queuing} for more details).
23
-
\end{description}
24
-
25
4
\subsection{Creating playlists}
26
5
27
6
\subsubsection{By selecting a song for playback}
···
29
8
\ActionTreeEnter, Rockbox will automatically create a playlist containing all of the
30
9
listed songs and will start playback.
31
10
32
-
\note{Playing a new song will erase the existing dynamic playlist
33
-
and create a new one. If you want to \emph{add} a song to it instead,
34
-
see \reference{ref:playingnext_submenu} on how to choose what's playing next.}
11
+
\note{Playing a new song will clear the current playlist. If you want to \emph{add}
12
+
a song to it instead, see \reference{ref:playingnext_submenu} on how to choose
13
+
what's playing next.}
35
14
36
15
\subsubsection{By choosing ``Play`` or ``Play Shuffled`` from ``Playing Next...``}
37
-
Replaces an existing dynamic playlist with the selected tracks.
16
+
Replaces current playlist with the selected tracks.
38
17
39
18
\subsubsection{\label{ref:addtoplaylist_submenu}By choosing ``Add to Playlist...``}
40
19
Choose \setting{Add to Playlist...} from the \setting{Context Menu} to
41
20
add selected track(s) or directory to a new or existing playlist that is not currently
42
21
playing.
43
22
44
-
\note{All playlists in the \setting{Playlist catalogue} are stored by default
45
-
in the \fname{/Playlists} directory in the root of your \daps{} disk and
46
-
playlists stored in other locations are not included in the catalogue. It is
47
-
however possible to move existing playlists there or change the default playlist
48
-
directory (see \reference{ref:Contextmenu}).}
23
+
\note{Playlists are stored in \fname{/Playlists} by default.
24
+
The default playlist directory can be changed (see \reference{ref:Contextmenu}).}
49
25
50
26
\subsubsection{By using the Main Menu}
51
27
To create a playlist containing some or all of the music on your \dap{}, you can use the
52
-
\setting{Create Playlist} command in the \setting{Playlist Catalogue Context Menu}
28
+
\setting{Create Playlist} command in the \setting{Playlists Context Menu}
53
29
(see \reference{ref:playlistcatalogue_contextmenu}).
54
30
55
31
\subsection{Choosing what's playing next}
56
32
57
-
\subsubsection{\label{ref:playingnext_submenu}Adding music to a dynamic playlist}
33
+
\subsubsection{\label{ref:playingnext_submenu}Adding music to the current playlist}
58
34
\screenshot{rockbox_interface/images/ss-playlist-menu}{Playing Next...}{}
59
35
\setting{Playing Next...} is a submenu in the \setting{Context Menu} (see
60
36
\reference{ref:Contextmenu}) that can be invoked on a selection of tracks in various
···
73
49
\item [Play Last Shuffled.] Add tracks in a random order to the end of the playlist.
74
50
\end{description}
75
51
76
-
To replace the current dynamic playlist with your selection, choose:
52
+
To replace the current playlist with your selection, choose:
77
53
78
54
\begin{description}
79
-
\item [Play.] Replace all entries in the dynamic playlist with the selected
55
+
\item [Play.] Replace all entries in the current playlist with the selected
80
56
tracks. If \setting{Keep Current Track When Replacing Playlist} is set to
81
57
\setting{Yes}, the new tracks will play after the current track finishes
82
58
playing; if no track is playing or the setting is \setting{No}, the new
···
87
63
\end{description}
88
64
89
65
\label{ref:queuing}The following options are hidden by default, due to their
90
-
more complicated behavior. Queued tracks are temporarily added to the dynamic
66
+
more complicated behavior. Queued tracks are temporarily added to the current
91
67
playlist, but are automatically removed as soon as the tracks have been played.
92
68
Queued tracks will not be saved to a playlist file.
93
69
A current playlist containing queued tracks can not be bookmarked, even after saving it,
···
120
96
you would like Rockbox to include tracks in subdirectories as well as tracks
121
97
in the currently-selected directory.}
122
98
123
-
Dynamic playlists are saved, so resume will restore them exactly as they
124
-
were before shutdown.
99
+
The Current playlist is saved, so resume will restore it exactly as it
100
+
was before shutdown.
125
101
126
102
\note{To view, save, reshuffle, or display the play time of the current
127
-
dynamic playlist use the
103
+
playlist use the
128
104
\setting{Current Playlist} sub menu in the WPS context menu.}
129
105
130
106
\subsection{Modifying playlists}
···
145
121
\subsection{Saving playlists}
146
122
To save the current playlist, either enter the \setting{Current Playlist} submenu
147
123
in the \setting{WPS Context Menu} (see \reference{sec:contextmenu}) and
148
-
select \setting{Save Current Playlist}, or enter the context menu for the
149
-
\setting{Playlist catalogue} in the \setting{Main Menu} and select
124
+
select \setting{Save Current Playlist}, or enter the context menu for
125
+
\setting{Playlists} in the \setting{Main Menu} and select
150
126
\setting{Save Current Playlist}.
151
127
Either method will bring you to the \setting{Virtual Keyboard} (see
152
128
\reference{sec:virtual_keyboard}), enter a filename for your playlist and
···
158
134
\subsubsection{Through the \setting{File Browser}}
159
135
Playlist files, like regular music tracks, can be selected through the
160
136
\setting{File Browser}. When loading a playlist from disk it will replace
161
-
the current dynamic playlist. If you want to look at a playlist's
137
+
the current playlist. If you want to look at a playlist's
162
138
content without starting playback immediately, access the \setting{Context Menu} (see
163
139
\reference{ref:Contextmenu}) with \ActionStdContext{} and choose \setting{View}.
164
140
165
-
\subsubsection{Through the \setting{Playlist catalogue}}
166
-
The \setting{Playlist catalogue} offers a shortcut to all playlists in your
141
+
\subsubsection{Through \setting{Playlists}}
142
+
\setting{Playlists} offers a shortcut to all playlists in your
167
143
\daps{} specified playlist directory.
168
144
It can be used like the \setting{File Browser} but will display
169
145
the content of a playlist when one is selected.