1AUDTOOL2(1)                 General Commands Manual                AUDTOOL2(1)
2
3
4

NAME

6       audtool2  -  a  small  tool  to modify behavior of a running audacious2
7       instance.
8

SYNOPSIS

10       audtool2 [--[[handler [parameters]] [...]
11

DESCRIPTION

13       audtool2 is designed to send commands to a running audacious.
14
15       It can handle various things like jumping to the next track in playlist
16       or  returning  the current playing track title, as well as other status
17       information.
18

OPTIONS

20       Now playing information:
21
22       --current-song
23              Returns current song title.
24
25       --current-song-filename
26              Returns current song filename.
27
28       --current-song-length
29              Returns current song length.
30
31       --current-song-length-seconds
32              Returns current song length in seconds.
33
34       --current-song-length-frames
35              Returns current song length in frames.
36
37       --current-song-output-length
38              Returns current song output length.
39
40       --current-song-output-length-seconds
41              Returns current song output length in seconds.
42
43       --current-song-output-length-frames
44              Returns current song output length in frames.
45
46       --current-song-bitrate
47              Returns current song bitrate in bits per second.
48
49       --current-song-bitrate-kbps
50              Returns current song bitrate in kilobits per second.
51
52       --current-song-frequency
53              Returns current song frequency in hertz.
54
55       --current-song-frequency-khz
56              Returns current song frequency in kilohertz.
57
58       --current-song-channels
59              Returns current song channels.
60
61       --current-song-tuple-data <fieldname>
62              Returns the value of a tuple field for the current song.
63
64       --current-song-info
65              Returns current song bitrate, frequency and channels.
66
67       Playlist manipulation:
68
69       --playlist-advance
70              Go to the next song in the playlist.
71
72       --playlist-reverse
73              Go to the previous song in the playlist.
74
75       --playlist-addurl <uri>
76              Adds a uri to the playlist.
77
78       --playlist-insurl <uri> <position>
79              Inserts a url at specified position in the playlist.
80
81       --playlist-delete <position>
82              Deletes the song at <position> from the playlist.
83
84       --playlist-length
85              Returns the total length of the playlist.
86
87       --playlist-song <position>
88              Returns the title of the song at <position> in the playlist.
89
90       --playlist-song-filename <position>
91              Returns the filename of the song at <position> in the playlist.
92
93       --playlist-song-length <position>
94              Returns the length of the song at <position> in the playlist.
95
96       --playlist-song-length-seconds <position>
97              Returns the length of the song at <position> in the playlist  in
98              seconds.
99
100       --playlist-song-length-frames <position>
101              Returns  the length of the song at <position> in the playlist in
102              frames.
103
104       --playlist-display
105              Returns the entire playlist.
106
107       --playlist-position
108              Returns the current position in the playlist.
109
110       --playlist-jump <position>
111              Jumps to <position> in the playlist.
112
113       --playlist-clear
114              Clears the playlist.
115
116       --playlist-repeat-status
117              Returns the status of playlist repeat.
118
119       --playlist-repeat-toggle
120              Toggles playlist repeat.
121
122       --playlist-shuffle-status
123              Returns the status of playlist shuffle.
124
125       --playlist-shuffle-toggle
126              Toggles playlist shuffle.
127
128       --playlist-tuple-data <fieldname> <position>
129              Returns the value of a tuple field for a song in the playlist.
130
131       Playqueue manipulation:
132
133       --playqueue-add <position>
134              Adds the song at <position> in the playlist to the playqueue.
135
136       --playqueue-remove <position>
137              Removes  the  song  at  <position>  in  the  playlist  from  the
138              playqueue.
139
140       --playqueue-is-queued <position>
141              Returns OK if the song at <postion> in the playtlist is queued.
142
143       --playqueue-get-position <position>
144              Returns  the playqueue position of the song at <position> in the
145              playlist.
146
147       --playqueue-get-queue-position <position>
148              Returns the playqueue position of a song in the given <position>
149              in the playlist.
150
151       --playqueue-get-list-position <position>
152              Returns the playlist position of a song in the given position in
153              the playqueue.
154
155       --playqueue-length
156              Returns the length of the playqueue.
157
158       --playqueue-display
159              Returns a list of currently-queued songs.
160
161       --playqueue-clear
162              Clears the playqueue.
163
164       Playback manipulation:
165
166       --playback-play
167              Starts/unpauses song playback.
168
169       --playback-pause
170              (Un)pauses song playback.
171
172       --playback-playpause
173              Plays/(un)pauses song playback.
174
175       --playback-stop
176              Stops song playback.
177
178       --playback-playing
179              Returns OK if audacious is playing.
180
181       --playback-paused
182              Returns OK if audacious is paused.
183
184       --playback-stopped
185              Returns OK if audacious is stopped.
186
187       --playback-status
188              Returns the playback status.
189
190       --playback-seek
191              Performs an absolute seek in milliseconds.
192
193       --playback-seek-relative
194              Performs a seek relative to the current  position  in  millisec‐
195              onds.
196
197       Volume control:
198
199       --get-volume
200              Returns the current volume level in percent.
201
202       --set-volume <level>
203              Sets the current volume level in percent.
204
205       Equalizer manipulation:
206
207       --equalizer-activate <on/off>
208              Activates/deactivates the equalizer.
209
210       --equalizer-get
211              Gets the equalizer settings.
212
213       --equalizer-set   <preamp>  <band0>  <band1>  <band2>  <band3>  <band4>
214       <band5> <band6> <band7> <band8> <band9>
215              Sets the equalizer settings.
216
217       --equalizer-get-preamp
218              Gets the equalizer pre-amplification.
219
220       --equalizer-set-preamp <preamp>
221              Gets the equalizer pre-amplification.
222
223       --equalizer-get-band <band>
224              Gets the equalizer value in specified band.
225
226       --equalizer-set-band <band> <value>
227              Sets the equalizer value in specified band.
228
229       Miscellaneous:
230
231       --mainwin-show <on/off>
232              Shows/hides the main window.
233
234       --playlist-show <on/off>
235              Shows/hides the playlist window.
236
237       --equalizer-show <on/off>
238              Shows/hides the equalizer window.
239
240       --filebrowser-show <on/off>
241              Shows/hides the filebrowser.
242
243       --jumptofile-show <on/off>
244              Shows/hides the jump to file window.
245
246       --preferences-show <on/off>
247              Shows/hides the preferences window.
248
249       --about-show <on/off>
250              Shows/hides the about window.
251
252       --activate
253              Activates and raises audacious.
254
255       --always-on-top <on/off>
256              Enables/disables always on top setting.
257
258       --version
259              Displays version information for the Audacious2 core.
260
261       --shutdown
262              Shuts down audacious.
263
264       Help system:
265
266       --list-handlers
267              Shows handlers list.
268
269       --help Shows handlers list.
270
271       Handlers may be prefixed with `--'  (GNU-style  long-options)  or  not,
272       your choice.
273

BUGS

275       There  are  no  known  bugs  in  audtool2 at this time; if you find any
276       please report them on www.atheme.org in the Audacious issue tracker.
277

AUTHORS

279       audtool2 was written by George Averill <nhjm@nhjm.net> and William Pit‐
280       cock <nenolod@atheme.org>.
281
282       This  manual  page was written by Adam Cecile <gandalf@le-vert.net> and
283       Kiyoshi Aman <kiyoshi@atheme.org>. Some additional tweaks were done  by
284       William  Pitcock  <nenolod@atheme.org>  and  Tony  Vroon <chainsaw@gen‐
285       too.org>.
286
287       Permission is granted to copy, distribute and/or modify  this  document
288       under  the  terms  of  the GNU General Public License, Version 2 or any
289       later version published by the Free Software Foundation.
290
291       The complete text of the GNU General Public License is available in the
292       sourcecode of Audacious, and is typically included with binary packages
293       as well.
294
295       If installed with an operating system, see your Operating System's doc‐
296       umentation for licensing details.
297
298

SEE ALSO

300       audacious2(1)
301
302

WEBSITE

304       http://audacious-media-player.org
305
306
307
308Version 2.4.5                     April 2009                       AUDTOOL2(1)