roarctl(1)
NAME
roarctl - RoarAudio sound server controll tool
SYNOPSIS
roarcat [OPTIONS]... COMMAND [OPTS] [COMMAND [OPTS] [COMMAND [OPTS] [...]]]
DESCRIPTION
This tool controlls the RoarAudio's sound server. This is done by sending commands to the server. See COMMANDS for a list.
GENERAL OPTIONS
--help Print some help text.
-v Be verbose. May be used multiple times.
NETWORK OPTIONS
- --server SERVER
- The server to connect to
BASIC COMMANDS
help Same as --help.
- sleep TIME
- Sleeps for TIME seconds.
- standby, off, resume, on
- Brings the server into standby mode or back into achtive (operating mode).
- standbymode
- Tells if the server is in standby mode or not.
- exit Quits the server.
- terminate
- Terminates the server as soon as all clients disconnected and all streams reaches EOF.
STREAM COMMANDS
- volume STREAMID CHANNELS VOL0 VOL1 VOL2...
- Sets the mixing level for a stream with id STREAMID.
- CHANNELS is the nummber of channels to set volume. This should be the number of channels of the stream or a symbolic name. Currently the symbolic names mono and stereo are allowed. If you use mono all channels will get the level you give as VOL0. If you use stereo it will try to set the mixing levels as you are used from stereo setups even if the setup is not in stereo.
- The parameters VOL0 ... VOLn and the number of them depends on what you gave as CHANNELS. You have to give exactly CHANNELS parameters.
- If you give a numerical (not symbolic) value for CHANNELS and the stream does have a diffrent number of channels the behavor is undefined. In the current implementation only the first CHANNELS channels will be updated. This behavor may change in the future.
- kick TYPE ID
- Kicks an object of TYPE with id ID. Possible types are: client stream sample source
- You can get the ID via list* (see bellow).
- flag ID FLAGS, unflag ID FLAGS
- Sets or removes flags from a stream. ID is the stream id. FLAGS is a comma separated list of flags.
- It is not possible to set all kinds of flags at runtime.
META DATA COMMANDS
- metasave ID FILE
- Saves the meta data of stream ID to file FILE. The Format is one KEY=Value pair per line. The same format is used by Xiph's tools.
- metaload ID FILE
- Load meta data from file FILE into stream ID. The format is the same as for metasave.
LISTING COMMANDS
- serveroinfo
- Gets Information about server output.
- listclients
- Gets Information about clients.
- liststreams
- Gets Information about streams.
- allinfo
- Same as "serveroinfo listclients liststreams".
ENVIRONMENT VARIABLES
Bellow only the basic environment varibales are listend. For a complete list see libroar(7).
HOME The users home directory.
- ROAR_SERVER
- The address of the listening server. This may be in form of host:port for TCP/IP connections and /path/to/sock for UNIX Domain Sockets. This is the same as the --server option.
BUGS
1) Make the meta data commands api-fixed and list them here.
2) more often check if the user gave us enough arguments.
SEE ALSO
roarvorbis(1), roarfish(1), roarbaseclients(1), roartestclients(1),
libroar(7), RoarAudio(7).
HISTORY
- For history information see RoarAudio(7).