audtool2

AUDTOOL2(1)                                                        AUDTOOL2(1)



NAME
       audtool2  -  a  small  tool  to modify behavior of a running audacious2
       instance.

SYNOPSIS
       audtool2 [--[[handler [parameters]] [...]

DESCRIPTION
       audtool2 is designed to send commands to a running audacious.

       It can handle various things like jumping to the next track in playlist
       or  returning  the current playing track title, as well as other status
       information.

OPTIONS
       Now playing information:

       --current-song
              Returns current song title.

       --current-song-filename
              Returns current song filename.

       --current-song-length
              Returns current song length.

       --current-song-length-seconds
              Returns current song length in seconds.

       --current-song-length-frames
              Returns current song length in frames.

       --current-song-output-length
              Returns current song output length.

       --current-song-output-length-seconds
              Returns current song output length in seconds.

       --current-song-output-length-frames
              Returns current song output length in frames.

       --current-song-bitrate
              Returns current song bitrate in bits per second.

       --current-song-bitrate-kbps
              Returns current song bitrate in kilobits per second.

       --current-song-frequency
              Returns current song frequency in hertz.

       --current-song-frequency-khz
              Returns current song frequency in kilohertz.

       --current-song-channels
              Returns current song channels.

       --current-song-tuple-data 
              Returns the value of a tuple field for the current song.

       --current-song-info
              Returns current song bitrate, frequency and channels.

       Playlist manipulation:

       --playlist-advance
              Go to the next song in the playlist.

       --playlist-reverse
              Go to the previous song in the playlist.

       --playlist-addurl 
              Adds a uri to the playlist.

       --playlist-insurl  
              Inserts a url at specified position in the playlist.

       --playlist-delete 
              Deletes the song at  from the playlist.

       --playlist-length
              Returns the total length of the playlist.

       --playlist-song 
              Returns the title of the song at  in the playlist.

       --playlist-song-filename 
              Returns the filename of the song at  in the playlist.

       --playlist-song-length 
              Returns the length of the song at  in the playlist.

       --playlist-song-length-seconds 
              Returns the length of the song at  in the playlist  in
              seconds.

       --playlist-song-length-frames 
              Returns  the length of the song at  in the playlist in
              frames.

       --playlist-display
              Returns the entire playlist.

       --playlist-position
              Returns the current position in the playlist.

       --playlist-jump 
              Jumps to  in the playlist.

       --playlist-clear
              Clears the playlist.

       --playlist-repeat-status
              Returns the status of playlist repeat.

       --playlist-repeat-toggle
              Toggles playlist repeat.

       --playlist-shuffle-status
              Returns the status of playlist shuffle.

       --playlist-shuffle-toggle
              Toggles playlist shuffle.

       --playlist-tuple-data  
              Returns the value of a tuple field for a song in the playlist.

       Playqueue manipulation:

       --playqueue-add 
              Adds the song at  in the playlist to the playqueue.

       --playqueue-remove 
              Removes  the  song  at    in  the  playlist  from  the
              playqueue.

       --playqueue-is-queued 
              Returns OK if the song at  in the playtlist is queued.

       --playqueue-get-position 
              Returns  the playqueue position of the song at  in the
              playlist.

       --playqueue-get-queue-position 
              Returns the playqueue position of a song in the given 
              in the playlist.

       --playqueue-get-list-position 
              Returns the playlist position of a song in the given position in
              the playqueue.

       --playqueue-length
              Returns the length of the playqueue.

       --playqueue-display
              Returns a list of currently-queued songs.

       --playqueue-clear
              Clears the playqueue.

       Playback manipulation:

       --playback-play
              Starts/unpauses song playback.

       --playback-pause
              (Un)pauses song playback.

       --playback-playpause
              Plays/(un)pauses song playback.

       --playback-stop
              Stops song playback.

       --playback-playing
              Returns OK if audacious is playing.

       --playback-paused
              Returns OK if audacious is paused.

       --playback-stopped
              Returns OK if audacious is stopped.

       --playback-status
              Returns the playback status.

       --playback-seek
              Performs an absolute seek in milliseconds.

       --playback-seek-relative
              Performs a seek relative to the current  position  in  millisec‐
              onds.

       Volume control:

       --get-volume
              Returns the current volume level in percent.

       --set-volume 
              Sets the current volume level in percent.

       Equalizer manipulation:

       --equalizer-activate 
              Activates/deactivates the equalizer.

       --equalizer-get
              Gets the equalizer settings.

       --equalizer-set             
           
              Sets the equalizer settings.

       --equalizer-get-preamp
              Gets the equalizer pre-amplification.

       --equalizer-set-preamp 
              Gets the equalizer pre-amplification.

       --equalizer-get-band 
              Gets the equalizer value in specified band.

       --equalizer-set-band  
              Sets the equalizer value in specified band.

       Miscellaneous:

       --mainwin-show 
              Shows/hides the main window.

       --playlist-show 
              Shows/hides the playlist window.

       --equalizer-show 
              Shows/hides the equalizer window.

       --filebrowser-show 
              Shows/hides the filebrowser.

       --jumptofile-show 
              Shows/hides the jump to file window.

       --preferences-show 
              Shows/hides the preferences window.

       --about-show 
              Shows/hides the about window.

       --activate
              Activates and raises audacious.

       --always-on-top 
              Enables/disables always on top setting.

       --version
              Displays version information for the Audacious2 core.

       --shutdown
              Shuts down audacious.

       Help system:

       --list-handlers
              Shows handlers list.

       --help Shows handlers list.

       Handlers may be prefixed with `--'  (GNU-style  long-options)  or  not,
       your choice.

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

AUTHORS
       audtool2 was written by George Averill  and William Pit‐
       cock .

       This  manual  page was written by Adam Cecile  and
       Kiyoshi Aman . Some additional tweaks were done  by
       William  Pitcock    and  Tony  Vroon        too.org>.

       Permission is granted to copy, distribute and/or modify  this  document
       under  the  terms  of  the GNU General Public License, Version 2 or any
       later version published by the Free Software Foundation.

       The complete text of the GNU General Public License is available in the
       sourcecode of Audacious, and is typically included with binary packages
       as well.

       If installed with an operating system, see your Operating System's doc‐
       umentation for licensing details.


SEE ALSO
       audacious2(1)


WEBSITE
       http://audacious-media-player.org



Version 2.3                       April 2009                       AUDTOOL2(1)