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

NAME

6       audtool  -  a  small  tool  to  modify  behavior of a running audacious
7       instance.
8

SYNOPSIS

10       audtool [--[[handler [parameters]]
11

DESCRIPTION

13       audtool 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       Playlist manipulation:
62
63       --playlist-advance
64              Go to the next song in the playlist.
65
66       --playlist-reverse
67              Go to the previous song in the playlist.
68
69       --playlist-addurl <uri>
70              Adds a uri to the playlist.
71
72       --playlist-delete <position>
73              Deletes the song at <position> from the playlist.
74
75       --playlist-length
76              Returns the total length of the playlist.
77
78       --playlist-song <position>
79              Returns the title of the song at <position> in the playlist.
80
81       --playlist-song-filename <position>
82              Returns the filename of the song at <position> in the playlist.
83
84       --playlist-song-length <position>
85              Returns the length of the song at <position> in the playlist.
86
87       --playlist-song-length-seconds <position>
88              Returns the length of the song at <position> in the playlist  in
89              seconds.
90
91       --playlist-song-length-frames <position>
92              Returns  the length of the song at <position> in the playlist in
93              frames.
94
95       --playlist-display
96              Returns the entire playlist.
97
98       --playlist-position
99              Returns the current position in the playlist.
100
101       --playlist-jump <position>
102              Jumps to <position> in the playlist.
103
104       --playlist-clear
105              Clears the playlist.
106
107       --playlist-repeat-status
108              Returns the status of playlist repeat.
109
110       --playlist-repeat-toggle
111              Toggles playlist repeat.
112
113       --playlist-shuffle-status
114              Returns the status of playlist shuffle.
115
116       --playlist-shuffle-toggle
117              Toggles playlist shuffle.
118
119       Playqueue manipulation:
120
121       --playqueue-add <position>
122              Adds the song at <position> in the playlist to the playqueue.
123
124       --playqueue-remove <position>
125              Removes  the  song  at  <position>  in  the  playlist  from  the
126              playqueue.
127
128       --playqueue-is-queued <position>
129              Returns OK if the song at <postion> in the playtlist is queued.
130
131       --playqueue-get-position <position>
132              Returns  the playqueue position of the song at <position> in the
133              playlist.
134
135       --playqueue-get-qposition <qposition>
136              Returns the playlist position of the song at <qposition> in  the
137              playqueue.
138
139       --playqueue-length
140              Returns the length of the playqueue.
141
142       --playqueue-display
143              Returns a list of currently-queued songs.
144
145       --playqueue-clear
146              Clears the playqueue.
147
148       Playback manipulation:
149
150       --playback-play
151              Starts/unpauses song playback.
152
153       --playback-pause
154              (Un)pauses song playback.
155
156       --playback-playpause
157              Plays/(un)pauses song playback.
158
159       --playback-stop
160              Stops song playback.
161
162       --playback-playing
163              Returns OK if audacious is playing.
164
165       --playback-paused
166              Returns OK if audacious is paused.
167
168       --playback-stopped
169              Returns OK if audacious is stopped.
170
171       --playback-status
172              Returns the playback status.
173
174       --playback-seek
175              Performs an absolute seek in milliseconds.
176
177       --playback-seek-relative
178              Performs  a  seek  relative to the current position in millisec‐
179              onds.
180
181       Volume control:
182
183       --get-volume
184              Returns the current volume level in percent.
185
186       --set-volume <level>
187              Sets the current volume level in percent.
188
189       Miscellaneous:
190
191       --preferences
192              Shows/hides the preferences window.
193
194       --jumptofile
195              Shows the jump to file window.
196
197       --shutdown
198              Shuts down audacious.
199
200       Help system:
201
202       --list-handlers
203              Shows handlers list.
204
205       --help Shows handlers list.
206
207       Handlers may be prefixed with `--'  (GNU-style  long-options)  or  not,
208       your choice.
209

BUGS

211       There are no known bugs in audtool at this time; if you find any please
212       report them to <bugs+audtool@atheme.org>.
213

AUTHORS

215       audtool was written by George Averill <nhjm@nhjm.net> and William  Pit‐
216       cock <nenolod@atheme.org>.
217
218       This  manual  page was written by Adam Cecile <gandalf@le-vert.net> and
219       Kiyoshi Aman <kiyoshi@atheme.org>. Some additional tweaks were done  by
220       William Pitcock <nenolod@atheme.org>.
221
222       Permission  is  granted to copy, distribute and/or modify this document
223       under the terms of the GNU General Public License,  Version  2  or  any
224       later version published by the Free Software Foundation.
225
226       The complete text of the GNU General Public License is available in the
227       sourcecode of Audacious, and is typically included with binary packages
228       as well.
229
230       If installed with an operating system, see your Operating System's doc‐
231       umentation for licensing details.
232

SEE ALSO

234       Homepage: http://audacious-media-player.org/
235
236
237
238Version 1.3.2                    November 2006                      AUDTOOL(1)