pulse-cli-syntax - PulseAudio Command Line Interface Syntax
~/.config/pulse/default.pa
/etc/pulse/default.pa
/etc/pulse/system.pa
PulseAudio provides a simple command line language used by
configuration scripts, the pacmd interactive shell, and the modules
module-cli and module-cli-protocol-{unix,tcp}. Empty lines and lines
beginning with a hashmark (#) are silently ignored. Several commands are
supported.
Note that any boolean arguments can be given positively as '1',
't', 'y', 'true', 'yes' or 'on'. Likewise, negative values can be given as
'0', 'f', 'n', 'false', 'no' or 'off'. Case is ignored.
- help
- Show a quick help on the commands available.
- kill-client
index
- Remove a client forcibly from the server. There is no protection against
the client reconnecting immediately.
- kill-sink-input|kill-source-output
index
- Remove a sink input (resp. source output) forcibly from the server. This
will not remove the owning client or any other streams opened by the same
client from the server.
- play-file
filename sink-index|sink-name
- Play an audio file to a sink.
- dump
- Dump the daemon's current configuration in CLI commands.
- dump-volumes
- Debug: Shows the current state of all volumes.
- shared
- Debug: Show shared properties.
- exit
- Terminate the daemon. If you want to terminate a CLI connection ("log
out") you might want to use ctrl+d
In addition to the commands described above there are a few meta
directives supported by the command line interpreter.
- .include filename|folder
- Executes the commands from the specified script file or in all of the *.pa
files within the folder.
- .fail and .nofail
- Enable (resp. disable) that following failing commands will cancel the
execution of the current script file. This is ignored when used on the
interactive command line.
- .ifexists filename
- Execute the subsequent block of commands only if the specified file
exists. Typically filename indicates a module. Relative paths are
resolved using the module directory as the base. By using an absolute
path, the existence of other files can be checked as well.
- .else and .endif
- A block of commands is delimited by an .else or .endif meta
command. Nesting conditional commands is not supported.
The PulseAudio Developers <pulseaudio-discuss (at) lists (dot)
freedesktop (dot) org>; PulseAudio is available from
http://pulseaudio.org/