Frequently Asked Questions

Lennart Poettering <@PACKAGE_BUGREPORT@>, April 2006 · BTW: Someone should package this great tool for Debian!

esdcat
module-pipe-sink
libartsc
arts
--high-priority=1
realtime
SCHED_FIFO
pulseaudio
SCHED_FIFO
--high-priority=1
CAP_SYS_NICE
man 7
-capabilities
realtime
pulseaudio
realtime
autospawn = yes
client.conf
/etc/pulse/
~/.pulse/
pulseaudio --dump-modules
-v
$PULSE_SERVER
~./pulse-cookie
mplayer
PULSE_SINK
PULSE_SOURCE
PULSE_SERVER
ESPEAKER
PULSE_BINARY
PULSE_CLIENTCONFIG
PULSE_SCRIPT
PULSE_CONFIG
PULSE_DLPATH
module-cli-protocol-unix
killall -USR2 pulseaudio
-bidilink unix-client:/tmp/pulse-$USER/cli
pacmd
PULSE_SERVER
$DISPLAY
POYLP_SERVER
PULSE_COOKIE
~/.pulse/client.conf
/etc/pulse/client.conf
$DISPLAY
-load-module module-rtp-send
-load-module module-rtp-recv
-
rate=8000 format=ulaw channels=1
-load-module module-null-sink sink_name=rtp
-load-module module-rtp-send source=rtp_monitor
-set-default-sink rtp
-
rtp
-load-module module-rtp-recv
-
-load-module module-rtp-send
-
-load-module module-null-sink sink_name=rtp
-load-module module-rtp-recv sink=rtp
-set-default-source rtp_monitor
-
rtp_monitor
loop=1
destination
sap_address
225.0.0.x
module-combine
-load-module module-oss-mmap device="/dev/dsp" sink_name=output0
-load-module module-oss-mmap device="/dev/dsp1" sink_name=output1
-load-module module-combine sink_name=combined master=output0 slaves=output1
-set-sink-default combined
-
output0
output1
combined
module-combine
-load-module module-oss-mmap device="/dev/dsp" sink_name=output0 channel_map=left,right channels=2
-load-module module-oss-mmap device="/dev/dsp1" sink_name=output1 channel_map=rear-left,rear-right channels=2
-load-module module-combine sink_name=combined master=output0 slaves=output1 channel_map=left,right,rear-left,rear-right channels=4
-
padsp
.la
module-detect
.sh
esdcompat.sh
module-volume-restore
padsp
paplay
pacat
PF_UNIX
module-x11-publish
pacmd
load-sample-dir-lazy
pa_play_file()
module-tunnel
module-null-sink
module-match
paplay
pacat
libesd
SCHED_FIFO
realtime
module-combine
module-pipe-source
SCHED_FIFO
dlopen()
glib
gtk
libpulse
libpulse-simple
module-oss
module-oss-mmap
mmap()
module-alsa-sink
module-alsa-source
module-solaris
module-waveout
module-pipe-sink
module-pipe-source
module-combine
module-sine
module-x11-bell
module-x11-publish
module-esound-protocol-tcp
module-esound-protocol-unix
module-native-protocol-tcp
module-native-protocol-unix
module-simple-protocol-tcp
module-simple-protocol-unix
netcat
module-cli-protocol-tcp
module-cli-protocol-unix
module-cli
module-http-protocol-tcp
module-tunnel-sink
module-tunnel-source
module-match
module-volume-restore
module-match
module-null-sink
/dev/null
module-esound-sink
module-detect
module-lirc
module-mmkbd-evdev
module-zeroconf-publish
module-rtp-send
module-rtp-recv
module-jack-sink
module-jack-source
libao
gstreamer-plugins
modules.html
cli.html
daemon.html
FAQ.html
-nC
pulseaudio -nC
Welcome to PulseAudio! Use "help" for usage information.
->>> 
cli.html
pulseaudio -nF pulseaudio.pa
/etc/pulse/daemon.conf
/etc/pulse/default.pa
--sysconfdir=/etc
configure
/etc/pulse/
/usr/local/etc/pulse/
make doxygen
module-x11-bell
libsamplerate
libsndfile
liboil
libwrap
./configure
make
make install
svn checkout svn://0pointer.de/pulseaudio/trunk pulseaudio
module-cli
module-cli-protocol-{unix,tcp}
#
help
exit
C-d
list-modules
list-sinks/list-sources
list-clients
list-sink-inputs/list-sink-outputs
stat
info
ls
list
info
load-module
unload-module
modules
set-sink-volume
set-source-volume
0x10000
set-sink-mute
set-source-mute
set-sink-input-volume
sink_volume
set-default-sink
set-default-source
list-samples
play-sample
remove-sample
load-sample
load-sample-lazy
load-sample-dir-lazy
*.wav
list-autoload
add-autoload-sink/add-autoload-source
remove-autoload-sink/remove-autoload-source
play-file
dump
kill-client
kill-sink-input/kill-source-output
.include
.fail/.nofail
.verbose/.noverbose
chmod +x
-#!/usr/bin/polaudio -nF
-
-# Create autoload entries for the device drivers
-add-autoload-sink output module-alsa-sink device=plughw:0,0 rate=48000 sink_name=output
-add-autoload-sink output2 module-oss device=/dev/dsp1 record=0 sink_name=output2
-add-autoload-sink combined module-combine master=output slaves=output2 sink_name=combined
-
-add-autoload-source input module-alsa-source device=hw:1,0 source_name=input
-
-# Load several protocols
-load-module module-esound-protocol-unix
-load-module module-simple-protocol-tcp
-load-module module-native-protocol-unix
-load-module module-cli-protocol-unix
-
-# Make some devices default
-set-default-sink combined
-set-default-source input
-
-# Don't fail if the audio files referred to below don't exist
-.nofail
-
-# Load an audio to the sample cache for usage with module-x11-bell
-load-sample-lazy  /usr/share/sounds/KDE_Notify.wav x11-bell
-load-module module-x11-bell sample=x11-bell
-
-# Play a welcome sound
-play-file /usr/share/sounds/startup3.wav combined
-
-COMMANDS:
-  -h, --help                            Show this help
-      --version                         Show version
-      --dump-conf                       Dump default configuration
-      --dump-modules                    Dump list of available modules
-  -k  --kill                            Kill a running daemon
-      --check                           Check for a running daemon
-
-OPTIONS:
-  -D, --daemonize[=BOOL]                Daemonize after startup
-      --fail[=BOOL]                     Quit when startup fails
-      --verbose[=BOOL]                  Be slightly more verbose
-      --high-priority[=BOOL]            Try to set high process priority
-                                        (only available as root)
-      --disallow-module-loading[=BOOL]  Disallow module loading after startup
-      --exit-idle-time=SECS             Terminate the daemon when idle and this
-                                        time passed
-      --module-idle-time=SECS           Unload autoloaded modules when idle and
-                                        this time passed
-      --scache-idle-time=SECS           Unload autoloaded samples when idle and
-                                        this time passed
-      --log-target={auto,syslog,stderr} Specify the log target
-  -p, --dl-search-path=PATH             Set the search path for dynamic shared
-                                        objects (plugins)
-      --resample-method=[METHOD]        Use the specified resampling method
-                                        (one of src-sinc-medium-quality,
-                                        src-sinc-best-quality,src-sinc-fastest
-                                        src-zero-order-hold,src-linear,trivial)
-      --use-pid-file[=BOOL]             Create a PID file
-
-STARTUP SCRIPT:
-  -L, --load="MODULE ARGUMENTS"         Load the specified plugin module with
-                                        the specified argument
-  -F, --file=FILENAME                   Run the specified script
-  -C                                    Open a command line on the running TTY
-                                        after startup
-
-  -n                                    Don't load default script file
-
pulseaudio -D
/etc/pulse/default.pa
module-cli
module-cli-protocol-unix
format=
u8
s16
s16le
s16le
float32
float32be
float32le
alaw
ulaw
s16
rate=
channels=
sink_name=
source_name=
channel_map=
left
right
mono
center
front-left
front-right
front-center
rear-center
rear-left
rear-right
lfe
subwoofer
front-left-of-center
front-right-of-center
side-left
side-right
aux0
aux1
aux15
top-center
top-front-left
top-front-right
top-front-center
top-rear-left
top-rear-right
top-rear-center
pipe_output
file=
/tmp/music.output
pipe_input
file=
/tmp/music.input
alsa_output
device=
fragments=
fragment_size=
alsa_input
device=
fragments=
fragment_size=
module-alsa-sink
device=
/dev/dsp
fragments=
fragment_size=
module-alsa-sink
record=
playback=
oss_output
oss_input
module-oss
mmap()
module-oss
module-oss
record=
playback=
buffer_size=
module-oss
device=
sink_name=
combined
master=
slaves=
adjust_time=
resample_method=
libsamplerate
sinc-best-quality
sinc-medium-quality
sinc-fastest
zero-order-hold
linear
zero-order-hold
sinc-fastest
module-native-protocol-tcp
server=
source=
module-tunnel-source
sink=
module-tunnel-sink
cookie=
server=
cookie=
cli.html
exit_on_eof=
netcat
telnet
bidilink
module-cli
-unix
-tcp
port=
-tcp
loopback=
-tcp
listen=
-tcp
loopback=
socket=
-unix
/tmp/pulse/cli
netcat
module-cli-protocol-{unix,tcp}
module-cli-protocol-*
rate=
format=
channels=
playback=
record=
sink=
source=
esd
esdcat
esdrec
esdctl
module-cli-protocol-{unix,tcp}
module-cli-protocol-*
sink=
source=
auth-anonymous=
cookie=
module-cli-protocol-{unix,tcp}
module-cli-protocol-*
auth-anonymous=
auth-group=
-unix
cookie=
module-cli-protocol-tcp
display=
$DISPLAY
sample=
x11-bell
sink=
PULSE_SERVER
POYLP_SINK
PULSE_SOURCE
PULSE_COOKIE
pax11publish
display=
$DISPLAY
sink=
source=
cookie=
device=
evdev
/dev/input/event0
sink=
config=
appname=
pulseaudio
sink=
mplayer
module-null-sink
source=
format=, rate=, channels=
destination=
224.0.0.56
port=
mtu=
loop=
module-null-sink
sink=
sap_address=
224.0.0.56
sink_name=
jack_out
server_name=
client_name=
PulseAudio
channels=
connect=
module-jack-sink
sink_name
source_name
jack_in
sink=
frequency=
libesd
libesd
table=
~/.pulse/match.table
-^sample: 32000
-
sample:
sample:
table=
~/.pulse/volume.table
module-match
just-one=
1

`format=`	The sample format (one of `u8`, `s16`, `s16le`, `s16le`, `float32`, `float32be`, `float32le`, `alaw`, `ulaw`) (defaults to `s16`)
`rate=`	The sample rate (defaults to 44100)
`channels=`	Audio channels (defaults to 2)
`sink_name=`, `source_name=`	Name for the sink (resp. source)
`channel_map=`	Channel map. A list of -comma-seperated channel names. The currently defined channel names -are: `left`, `right`, `mono`, `center`, -`front-left`, `front-right`, `front-center`, -`rear-center`, `rear-left`, `rear-right`, -`lfe`, `subwoofer`, `front-left-of-center`, -`front-right-of-center`, `side-left`, -`side-right`, `aux0`, `aux1` to `aux15`, -`top-center`, `top-front-left`, -`top-front-right`, `top-front-center`, -`top-rear-left`, `top-rear-right`, -`top-rear-center`, (Default depends on the number of channels -and the driver)

`device=`	The ALSA device to use. (defaults to "plughw:0,0")
`fragments=`	The desired fragments when opening the device. (defaults to 12)
`fragment_size=`	The desired fragment size in bytes when opening the device (defaults to 1024)

`record=`	Accepts a binary numerical value for enabling (resp. disabling) the recording on this device. (defaults: to 1)
`playback=`	Accepts a binary numerical value for enabling (resp. disabling) the playback on this device. (defaults: to 1)

`record=`	Accepts a binary numerical value for enabling (resp. disabling) the recording on this device. (defaults: to 1)
`playback=`	Accepts a binary numerical value for enabling (resp. disabling) the playback on this device. (defaults: to 1)
`buffer_size=`	Record buffer size

`sink_name=`	The name for the combined sink. (defaults to `combined`)
`master=`	The name of the first sink to link into the combined think. The sample rate/type is taken from this sink.
`slaves=`	Name of additional sinks to link into the combined think, seperated by commas.
`adjust_time=`	Time in seconds when to readjust the sample rate of all sinks. (defaults to 20)
`resample_method=`	Resampling algorithm to -use. See `libsamplerate`'s documentation for more -information. Use one of `sinc-best-quality`, -`sinc-medium-quality`, `sinc-fastest`, -`zero-order-hold`, `linear`. If the default happens to -be to slow on your machine try using `zero-order-hold`. This -will decrease output quality however. (defaults to -`sinc-fastest`)

`server=`	The server to connect to
`source=`	The source on the remote server. Only available for `module-tunnel-source`.
`sink=`	The sink on the remote server. Only available for `module-tunnel-sink`.
`cookie=`	The authentication cookie file to use.

`port=`	(only for `-tcp`) The port number to listen on (defaults to 4712)
`loopback=`	(only for `-tcp`) Accepts -a numerical binary value. If 1 the socket is bound to the loopback -device, i.e. not publicly accessible. (defaults to 1)
`listen=`	(only for `-tcp`) The IP address to listen on. If specified, supersedes the value specified in `loopback=`
`socket=`	(only for `-unix`) The UNIX socket name (defaults to `/tmp/pulse/cli`)

`rate=`, `format=`, `channels=`	Sample format for streams connecting to this service.
`playback=`, `record=`	Enable/disable playback/recording
`sink=`, `source=`	Specify the sink/source this service connects to

`sink=`, `source=`	Specify the sink/source this service connects to
`auth-anonymous=`	If set to 1 no authentication is required to connect to the service
`cookie=`	Name of the cookie file for authentication purposes

`auth-anonymous=`	If set to 1 no authentication is required to connect to the service
`auth-group=`	(only for `-unix`): members of the specified unix group may access the server without further auhentication.
`cookie=`	Name of the cookie file for authentication purposes

`display=`	X11 display to connect to. If ommited defaults to the value of `$DISPLAY`
`sample=`	The sample to play. If ommited defaults to `x11-bell`.
`sink=`	Name of the sink to play the sample on. If ommited defaults to the default sink.

`device=`	Linux input device ("`evdev`", defaults to `/dev/input/event0`)
`sink=`	The sink to control

`config=`	The LIRC configuration file
`appname=`	The application name to pass to LIRC (defaults to `pulseaudio`)
`sink=`	The sink to control

`source=`	The source to read the audio data from. If ommited defaults to the default source.
`format=, rate=, channels=`	Sample format to use, defaults to the source's.
`destination=`	Destination multicast group for both RTP and SAP packets, defaults to `224.0.0.56`
`port=`	Destination port number of the RTP -traffic. If ommited defaults to a randomly chosen even port -number. Please keep in mind that the RFC suggests to use only even -port numbers for RTP traffic.
`mtu=`	Maximum payload size for RTP packets. If ommited defaults to 1280
`loop=`	Takes a boolean value, specifying whether locally generated RTP traffic should be looped back to the local host. Disabled by default.

`sink=`	The sink to connect to. If ommited defaults to the default sink.
`sap_address=`	The multicast group to join for SAP announcements, defaults to `224.0.0.56`.

`sink_name=`	The name for the PulseAudio sink. If ommited defaults to `jack_out`.
`server_name=`	The JACK server to connect to. If ommited defaults to the default server.
`client_name=`	The client name to tell the JACK server. If ommited defaults to `PulseAudio`.
`channels=`	Number of channels to register. If ommited defaults to the number of physical playback ports of the JACK server.
`connect=`	Takes a boolean value. If enabled (the default) PulseAudio will try to connect its ports to the physicial playback ports of the JACK server

`sink=`	The sink to connect to. If ommited defaults to the default sink.
`frequency=`	The frequency to generate in Hertz. Defaults to 440.

Frequently Asked Questions

First Steps

Developing PulseAudio Clients

Developing PulseAudio Modules

Simple Command Line Language

Miscellaneous Commands

help

exit

Status Commands

list-modules

list-sinks/list-sources

list-clients

list-sink-inputs/list-sink-outputs

stat

info

Module Management

load-module

unload-module

Configuration Commands

set-sink-volume/set-source-volume

set-sink-mute/set-source-mute

set-sink-input-volume

set-default-sink/set-default-source

Sample Cache

list-samples

play-sample

remove-sample

load-sample

load-sample-lazy

load-sample-dir-lazy

Module Autoloading

list-autoload

add-autoload-sink/add-autoload-source

remove-autoload-sink/remove-autoload-source

Miscellaneous Commands

play-file

dump

Killing Clients/Streams

kill-client

kill-sink-input/kill-source-output

Meta Commands

.include

.fail/.nofail

.verbose/.noverbose

Example Configuration Script

Daemon

Command Line Arguments

Example

Signals

SIGINT

SIGUSR1

SIGUSR2

SIGHUP

Loadable Modules

Device Drivers

module-pipe-sink

module-pipe-source

module-null-sink

module-alsa-sink

module-alsa-source

module-oss

module-oss-mmap

module-solaris

module-waveout

module-combine

module-tunnel-{sink,source}

module-esound-sink

Protocols

module-cli

module-simple-protocol-{unix,tcp}

module-esound-protocol-{unix,tcp}

module-native-protocol-{unix,tcp}

module-native-protocol-fd

module-http-protocol-tcp

X Window System

module-x11-bell

module-x11-publish

Volume Control

module-mmkbd-evdev

module-lirc

`help`

`exit`

`list-modules`

`list-sinks/list-sources`

`list-clients`

`list-sink-inputs/list-sink-outputs`

`stat`

`info`

`load-module`

`unload-module`

`set-sink-volume`/`set-source-volume`

`set-sink-mute`/`set-source-mute`

`set-sink-input-volume`

`set-default-sink`/`set-default-source`

`list-samples`

`play-sample`

`remove-sample`

`load-sample`

`load-sample-lazy`

`load-sample-dir-lazy`

`list-autoload`

`add-autoload-sink/add-autoload-source`

`remove-autoload-sink/remove-autoload-source`

`play-file`

`dump`

`kill-client`

`kill-sink-input/kill-source-output`

`.include`

`.fail/.nofail`

`.verbose/.noverbose`