Rockbox open source high quality audio player as a Music Player Daemon
mpris
rockbox
mpd
libadwaita
audio
rust
zig
deno
Manuals for Multiboot_Select, Open_plugins, Announce_Status
Change-Id: Ic9026bc574651a2297da79a22b9c76a8dbd8d6d3
authored by
William Wilgus
and committed by
William Wilgus
7967c050
059df378
+153
+99
manual/plugins/announce_status.tex
+99
manual/plugins/announce_status.tex
···
1
+
\subsection{Announce Status}
2
+
3
+
The \setting{Announce Status} plugin allows you to use the voice system to announce things in the audio stream
4
+
5
+
Currently the list includes:
6
+
\begin{itemize}
7
+
\item Time (If applicable)
8
+
\item Date (If applicable)
9
+
\item Track name (spelled)
10
+
\item Artist name (spelled)
11
+
\item Track Elapsed / Remaining
12
+
\item Playlist position
13
+
\item Battery level
14
+
\item Sleep Timer remaining
15
+
\item Running time
16
+
\end{itemize}
17
+
18
+
\subsubsection{Configuration}
19
+
The input for announce format is actually a parsed string of options
20
+
while you can edit the items directly to get your preferred order preset options are included.
21
+
If you choose to manually edit the option string the input box helpfully has all valid options for the parser
22
+
23
+
24
+
\setting{TIME}
25
+
\begin{itemize}
26
+
\item DT current time
27
+
\item D1 'time'
28
+
\item DD current date
29
+
\item D2 'date'
30
+
\end{itemize}
31
+
32
+
\setting{TRACK}
33
+
\begin{itemize}
34
+
\item TT title (spelled)
35
+
\item TA artist (spelled)
36
+
\item TE elapsed
37
+
\item TL length
38
+
\item TR remaining
39
+
\item T1 'elapsed'
40
+
\item T2 'remaining'
41
+
\item T3 'of'
42
+
\end{itemize}
43
+
44
+
\setting{PLAYLIST}
45
+
\begin{itemize}
46
+
\item PC current track
47
+
\item PN total tracks
48
+
\item PR remaining tracks
49
+
\item P1 'track'
50
+
\item P2 'of'
51
+
\end{itemize}
52
+
53
+
\setting{BATTERY}
54
+
\begin{itemize}
55
+
\item BP level (percentage 0-100)
56
+
\item BM remaining time (HMS)
57
+
\item B1 'battery level'
58
+
\end{itemize}
59
+
60
+
\setting{SLEEPTIMER/RUNTIME}
61
+
\begin{itemize}
62
+
\item RT runtime (HMS)
63
+
\item R1 'running time'
64
+
\item RS sleep timer remaining (HMS)
65
+
\item R2 'sleep time'
66
+
\item R3 'remaining'
67
+
\end{itemize}
68
+
69
+
\subsubsection{Usage}
70
+
\begin{description}
71
+
\item[Timeout] [0-360] seconds announcements will not repeat until timeout is met.
72
+
\item[Announce on] [Off, Track Change].
73
+
\item[Grouping] [0-7] 0- play all, 1-7 only announce the first n items.
74
+
Helpful for infrequently used items.
75
+
\item[Announcement format] Select from preset options or manually enter your own.
76
+
\item[Quit] Exit without Saving.
77
+
\item[Save and Exit] Save settings and exit
78
+
\end{description}
79
+
80
+
Now that we have configuration out of the way (don't forget the preset options if this looks daunting)
81
+
82
+
Not quite out of the woods yet though...
83
+
84
+
You can choose to get announcements each track change or only when you run the plugin again
85
+
it would get quite annoying to have to go run the plugin every time you wanted a status update though
86
+
87
+
Enter the \setting{WPS Hotkey}
88
+
now we will assign the wps hotkey to announce_status
89
+
Settings>General Settings>What's Playing Screen>WPS Hotkey
90
+
choose 'OpenPlugin' browse to 'demos'
91
+
finally choose 'announce_status'
92
+
93
+
Now you should be able to press your wps hotkey and get status updates on command.
94
+
95
+
\note{
96
+
This is actually a plugin running on top of the WPS screen and as such running other plugins stops the announce plugin
97
+
so if you only choose the track change option you should probably set the announce plugin to open on startup and keep
98
+
in mind that you may have to start the plugin again later.}
99
+
}
+7
manual/plugins/main.tex
+7
manual/plugins/main.tex
···
120
120
121
121
\section{Demos}
122
122
123
+
\input{plugins/announce_status.tex}
124
+
123
125
\input{plugins/bounce.tex}
124
126
125
127
\input{plugins/credits.tex}
···
239
241
240
242
\input{plugins/zxbox.tex}
241
243
244
+
242
245
\section{Applications}
243
246
244
247
\opt{rtc}{\input{plugins/alarmclock.tex}}
···
269
272
270
273
\input{plugins/main_menu_config.tex}
271
274
275
+
\opt{multi_boot}{\input{plugins/multiboot_select.tex}}
276
+
272
277
\input{plugins/md5sum.tex}
273
278
274
279
\input{plugins/metronome.tex}
280
+
281
+
\input{plugins/open_plugins.tex}
275
282
276
283
\input{plugins/otp.tex}
277
284
+21
manual/plugins/multiboot_select.tex
+21
manual/plugins/multiboot_select.tex
···
1
+
\subsection{Multiboot Select}
2
+
The \setting{Multiboot Select} plugin allows you to select from multiple
3
+
versions of rockbox on devices that support it.
4
+
5
+
\subsubsection{How it works}
6
+
Normally your \setting{Rockbox} install lives in the root of your main drive
7
+
On devices with multiboot your rockbox install can live in a separate folder
8
+
\opt{multidrive_usb}{on the external drive}.
9
+
10
+
Once several installs exist, \setting{Multiboot Select} will allow you to
11
+
select them for next boot or even reboot with your selected install immediately.
12
+
13
+
\subsubsection{Menu}
14
+
\begin{description}
15
+
\item[Select root] Displays a list of installs found on the device.
16
+
\item[Clear redirect] Removes all redirects returning to default install
17
+
\item[Using root] Displays the currently selected install path
18
+
\item[Save and Exit] Saves the currently selected install to be run next boot.
19
+
\item[Save and Reboot] Saves the currently selected install and reboots immediately.
20
+
\item[Save and Exit] Exit without saving changes.
21
+
\end{description}
+26
manual/plugins/open_plugins.tex
+26
manual/plugins/open_plugins.tex
···
1
+
\subsection{OpenPlugins}
2
+
\setting{Rockbox} uses an on disk database to store plugins and parameters.
3
+
\setting{OpenPlugins} allows viewing/editing/exporting items from this database.
4
+
5
+
\subsubsection{How it works}
6
+
\setting{OpenPlugins} displays a list of plugins you have set for actions such
7
+
as your \setting{Wps Hotkey}, \setting{Wps Context Plugin}, or \setting{Startup Plugin}.
8
+
You can export these entries or your own custom entries to a shortcut.
9
+
Any time this shortcut is run your selected parameters (or file) will be supplied.
10
+
11
+
If no items currently exist there will only be a single item 'Add',
12
+
on selection you will be presented with the file browser choose a plugin.
13
+
14
+
After selecting a plugin you will have a new entry long press on an entry will
15
+
display the context menu where you can edit the name,
16
+
add parameters or even remove the entry.
17
+
Selecting the entry will run it immediately.
18
+
19
+
\begin{description}
20
+
\item[Run] Exit and run selected entry.
21
+
\item[Edit] Edit the name, path or parameters of the selected entry.
22
+
\item[Remove] Delete the selected entry.
23
+
\item[Export] Export selected entry you can change the filename if desired.
24
+
\item[Add] On selection you will be presented with the file browser choose a plugin.
25
+
\item[Back] Return to previous menu.
26
+
\end{description}