TracNav

TracNav

Loadable Modules

The following loadable modules are provided with the PulseAudio distribution:

Device Drivers

All device driver modules support the following parameters:

format

The sample format (one of u8, s16, s16be, 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). Allowed characters in the name are a-z, A-Z, numbers, period (.) and underscore (_). The length must be 1-128 characters.

channel_map

Channel map. A list of comma-separated 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)

module-pipe-sink

Provides a simple test sink that writes the audio data to a FIFO special file in the file system. The sink name defaults to fifo_output.

The following option is supported:

file

The name of the FIFO special file to use. (defaults to: /tmp/music.output)

module-pipe-source

Provides a simple test source that reads the audio data from a FIFO special file in the file system. The source name defaults to fifo_input.

The following option is supported:

file

The name of the FIFO special file to use. (defaults to: /tmp/music.input)

module-null-sink

Provides a simple null sink. All data written to this sink is silently dropped. This sink is clocked using the system time.

This module doesn't support any special parameters

module-alsa-sink

Provides a playback sink for devices supported by the Advanced Linux Sound Architecture (ALSA). The sink name defaults to alsa_output.

In addition to the general device driver options described above this module supports:

device

The ALSA device to use. (defaults to "hw: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)

Since 0.9.11

tsched

Use system-timer based model (aka glitch-free). Defaults to 1 (enabled). If your hardware does not return accurate timing information (e.g. Creative sound cards) you can try to set tsched=0 to enable the interupt based timing which was used in 0.9.10 and before.

module-alsa-source

Provides a recording source for devices supported by the Advanced Linux Sound Architecture (ALSA). The source name defaults to alsa_input.

This module supports device=, fragments=, fragment_size= and tsched= arguments the same way as module-alsa-sink.

module-oss

Provides both a sink and a source for playback, resp. recording on Open Sound System (OSS) compatible devices.

This module supports device= (which defaults to /dev/dsp), fragments= and fragment_size= arguments the same way as module-alsa-sink.

In addition this module supports the following options:

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)

mmap

Accepts a boolean value for enabling (resp. disabling) memory mapped (mmap()) access to the input/output buffers of the audio device. This provides better latency behaviour but is less compatible. (defaults: to 1).

The sink name (resp. source name) defaults to oss_output (resp. oss_input).

module-solaris

Provides a sink and source for the Solaris audio device.

In addition to the general device driver options described above this module supports:

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

module-waveout

Provides a sink and source for the Win32 audio device.

This module supports all arguments that module-oss supports except device=.

module-combine

This combines two or more sinks into one. A new virtual sink is allocated. All data written to it is forwarded to all connected sinks. In equidistant intervals the sample rates of the output sinks is recalculated: i.e. even when the sinks' crystals deviate (which is normally the case) output appears synchronously to the human ear. The resampling required for this may be very CPU intensive.

sink_name

The name for the combined sink. (defaults to combined)

master

Obsolete since 0.9.11, list all sinks under slaves. The name of the first sink to link into the combined think. The sample rate/type is taken from this sink.

slaves

Name of sinks to link into the combined think, separated by commas.

adjust_time

Time in seconds when to readjust the sample rate of all sinks. (defaults to 20, 0 will not readjust)

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)

module-remap-sink

Since 0.9.7. This allows one to route streams' channels to arbitrary channels in a sink, for example to route stereo streams to rear channels. One common use case is to use one surround sound card as multiple virtual stereo cards.

In order to configure the remapped sink, you'll have to decide two things: what channels the new sink will accept, and where each of them will be relayed to.

sink_name

The name for the new virtual sink.

master

The name of the sink of which channels you're remapping.

channels

Channel count of the new sink.

channel_map

List of the channels that this sink will accept.

master_channel_map

The channels in the master sink, where the channels listed in channel_map will be relayed to. channel_map and master_channel_map must have equal number of channels listed, because the channels will be mapped based on their position in the list, i.e. the first channel in channel_map will be relayed to the first channel in master_channel_map and so on.

remix

Allow remixing of the mono or stereo streams to multiple channels (default is yes; set to "no" if you don't want the stereo stream to be up-mixed to all channels except subwoofer and channels named aux0-aux15).

An example to split a surround sound card to two stereo devices (remember to disable automatic device configuration first, by commenting out module-hal-detect and module-detect): 

# Use aux channels so that the channels won't be used for anything
# else than the rear_stereo sink.
load-module module-alsa-sink sink_name=front_stereo device=hw:0 channels=4 channel_map=front-left,front-right,aux0,aux1

load-module module-remap-sink sink_name=rear_stereo master=front_stereo channels=2 master_channel_map=aux0,aux1 channel_map=front-left,front-right

module-tunnel-{sink,source}

Tunnel a remote sink/source to a local "ghost" sink/source. Requires a running PulseAudio daemon on the remote server with module-native-protocol-tcp loaded. It's probably a better idea to connect to the remote sink/source directly since some buffer control is lost through this tunneling.

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.

module-esound-sink

Create a playback sink using an ESOUND server as backend. Whenever you can, try to omit this module since it has many disadvantages including bad latency and even worse latency measurement.

server

The server to connect to

cookie

The authentication cookie file to use.

Protocols

module-cli

Provides the user with a simple command line interface on the controlling TTY of the daemon. This module may not be loaded more than once.

exit_on_eof

Accepts a binary numerical argument specifying whether the daemon should exit after an EOF was received from STDIN (default: 0)

module-cli-protocol-{unix,tcp}

An implementation of a simple command line based protocol for controlling the PulseAudio daemon. If loaded, the user may connect with tools like netcat, telnet or bidilink to the listening sockets and execute commands the same way as with module-cli.

Beware: Users are not authenticated when connecting to this service.

This module exists in two versions: with the suffix -unix the service will listen on an UNIX domain socket in the local file system. With the suffix -tcp it will listen on a network transparent TCP/IP socket. (Both IPv6 and IPv4 - if available)

This module supports the following options:

port (only for -tcp)

The port number to listen on (defaults to 4712)

loopback (only for -tcp)

Removed in 0.9.3: 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)

module-simple-protocol-{unix,tcp}

An implementation of a simple protocol which allows playback by using simple tools like netcat. Just connect to the listening socket of this module and write the audio data to it, or read it from it for playback, resp. recording.

Beware''' Users are not authenticated when connecting to this service.

See module-cli-protocol-{unix,tcp} for more information about the two possible suffixes of this module.

In addition to the options supported by module-cli-protocol-*, this module supports:

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

module-esound-protocol-{unix,tcp}

An implementation of a protocol compatible with the Enlightened Sound Daemon (ESOUND, esd). When you load this module you may access the PulseAudio daemon with tools like esdcat, esdrec or even esdctl. Many applications, such as XMMS, include support for this protocol.

See module-cli-protocol-{unix,tcp} for more information about the two possible suffixes of this module.

In addition to the options supported by module-cli-protocol-*, this module supports:

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

auth-cookie

New in 0.9.12: Name of the cookie file for authentication purposes. Defaults to ".esd_auth". The homedir of the user running pulse is automatically prepended to non-absolute paths.

auth-cookie-enabled

New in 0.9.12: enable/disable auth-cookie authentication, takes a boolean value (0 or 1). Defaults to 1.

cookie

The old name for auth-cookie. Don't use this, it's only here for compatibility with versions before 0.9.12.

auth-ip-acl (only for -tcp}

New in 0.9.3: A semicolon separated list of IP address range to which anonymous access is allowed. Example: auth-ip-acl=10.11.12.13;192.168.50.0/24;127.0.0.0/8

module-native-protocol-{unix,tcp}

The native protocol of PulseAudio.

See module-cli-protocol-{unix,tcp} for more information about the two possible suffixes of this module.

In addition to the options supported by module-cli-protocol-*, this module supports:

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 authentication. Changed in 0.9.3: if the daemon is running in system-wide mode (--system passed when starting up) defaults to pulse-access, otherwise is disabled.

auth-group-enabled (only for -unix)

New in 0.9.3: enable/disable auth-group authentication, takes a boolean value (0 or 1). If auth-group= is specified or started in system-wide mode defaults to 1, otherwise 0.

auth-cookie

New in 0.9.12: Name of the cookie file for authentication purposes. Defaults to ".pulse-cookie". The homedir of the user running pulse is automatically prepended to non-absolute paths.

auth-cookie-enabled

New in 0.9.12: enable/disable auth-cookie authentication, takes a boolean value (0 or 1). Defaults to 1.

cookie

The old name for auth-cookie. Don't use this, it's only here for compatibility with versions before 0.9.12.

auth-ip-acl (only for -tcp}

New in 0.9.3: A semicolon separated list of IP address range to which anonymous access is allowed. Example: auth-ip-acl=10.11.12.13;192.168.50.0/24;127.0.0.0/8

module-native-protocol-fd

This is used internally when auto spawning a new daemon. Don't use it directly.

module-http-protocol-tcp

A proof-of-concept HTTP module, which can be used to introspect the current status of the PulseAudio daemon using HTTP. Just load this module and point your browser to http://localhost:4714/. This module takes the same arguments as module-cli-protocol-tcp.

Saving/restoring settings

module-default-device-restore

Since 0.9.7. Automatically restore the default sink and source (configuration is saved in a file)

module-device-restore

Since 0.9.11. Automatically restore the volume/mute state of devices (configuration is saved in a GDBM database)

restore_volume

Restore volume (default to true)

restore_muted

Restore mute state (default to true)

module-stream-restore

Since 0.9.11. Automatically restore the volume/mute/device state of streams (configuration is saved in a GDBM database)

restore_volume

Restore volume (default to true)

restore_muted

Restore mute state (default to true)

restore_device

Restore the selected sink (&src?) (default to true)

X Window System

module-x11-bell

Intercepts X11 bell events and plays a sample from the sample cache on each occurence.

display

X11 display to connect to. If ommited defaults to the value of $DISPLAY

sample

The sample to play. If omitted defaults to x11-bell. Note that this is not a file name, but a name that is given to the sample when the sample is loaded. This module doesn't load any sample itself. Instead, use load-sample with pacmd or in default.pa.

sink

Name of the sink to play the sample on. If omitted defaults to the default sink.

module-x11-publish

Publishes the access credentials to the PulseAudio server in the X11 root window. The following properties are used: PULSE_SERVER, POYLP_SINK, PULSE_SOURCE, PULSE_COOKIE. This is very useful when using SSH or any other remote login tool for logging into other machines and getting audio playback to your local speakers. The PulseAudio client libraries make use of this data automatically. Instead of using this module you may use the tool pax11publish which may be used to access, modify and import credential data from/to the X11 display.

display

X11 display to connect to. If omitted defaults to the value of $DISPLAY

sink

Name of the default sink. If omitted this property isn't stored in the X11 display.

source

Name of the default source. If omitted this property isn't stored in the X11 display.

cookie

Name of the cookie file of the cookie to store in the X11 display. If omitted the cookie of an already loaded protocol module is used.

module-x11-xsmp

Since 0.9.7. Register to the X11 session manager

session_manager

Session manager to connect to. If omitted defaults to the value of $SESSION_MANAGER

display

X11 display to connect to. If omitted defaults to the value of $DISPLAY

Volume Control

module-mmkbd-evdev

Adjust the volume of a sink when the special multimedia buttons of modern keyboards are pressed.

device

Linux input device ("evdev", defaults to /dev/input/event0)

sink

The sink to control

module-lirc

Adjust the volume of a sink when the volume buttons of an infrared remote control are pressed (through LIRC).

config

The LIRC configuration file

appname

The application name to pass to LIRC (defaults to PulseAudio)

sink

The sink to control

Here is a sample ~/.lircrc entry configured to forward signals to PulseAudio. Note that you may have to change the button names (Vol_Up, Vol_Down...) to match those in your /etc/lirc/lircd.conf. 

begin
    prog = PulseAudio
    remote = *
    button = Vol_Up
    config = volume-up
    repeat = 5
end

begin
    prog = PulseAudio
    remote = *
    button = Vol_Down
    config = volume-down
    repeat = 5
end

begin
    prog = PulseAudio
    remote = *
    button = Mute
    config = mute-toggle
end

Available configs include: volume-up, volume-down, mute, mute-toggle and reset.

Bluetooth

module-bluetooth-discover

Since 0.9.13. Detect available bluetooth audio devices and load bluetooth sinks, using BlueZ.

module-bluetooth-sink

Since 0.9.13. Bluetooth audio sink (and source, soon)

sink_name

The name for the sink.

address

The bluetooth device address (BTADDR, such as 00:18:42:F2:C9:89

profile

The audio profile, a2dp or hsp

module-bluetooth-proximity

Since 0.9.10? Bluetooth proximity volume control

sink

The sink to adjust the volume

hci

FIXME

RTP/SDP/SAP Transport

PulseAudio can stream audio data to an IP multicast group via the standard protocols RTP, SAP and SDP (RFC3550, RFC3551, RFC2327, RFC2327). This can be used for multiple different purposes: for sharing a single microphone on multiple computers on the local LAN, for streaming music from a single controlling PC to multiple PCs with speakers or to implement a simple "always-on" teleconferencing solution.

The current implementation is designed to be used exclusively in local area networks, though Internet multicasting is theoretically supported. Only uncompressed audio is supported, hence you won't be able to multicast more than a few streams at the same time over a standard LAN.

PulseAudio implements both a sender and a receiver for RTP traffic. The sender announces itself via SAP/SDP on the same multicast group as it sends the RTP data to. The receiver picks up the SAP/SDP announcements and creates a playback stream for each session. Alternatively you can use any RTP capable client to receive and play back the RTP data (such as mplayer, see HowToListenToTheRtpStream).

module-rtp-send

This is the sender side of the RTP/SDP/SAP implementation. It reads audio data from an existing source and forwards it to the network encapsulated in RTP. In addition it sends SAP packets with an SDP session description.

In combination with the monitor source of module-null-sink you can use this module to create an RTP sink.

source

The source to read the audio data from. If omitted 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 omitted 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 omitted 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.

module-rtp-recv

This is the receiver side of the RTP/SDP/SAP implementation. It picks up SAP session announcements and creates an RTP playback stream for each.

In combination with module-null-sink you can use this module to create an RTP source.

sink

The sink to connect to. If omitted defaults to the default sink.

sap_address

The multicast group to join for SAP announcements, defaults to 224.0.0.56.

JACK Connectivity

PulseAudio can be hooked up to a JACK Audio Connection Kit server which is a specialized sound server used for professional audio production on Unix/Linux. Both a PulseAudio sink and a source are available. For each channel a port is created in the JACK server.

module-jack-sink

This module implements a PulseAudio sink that connects to JACK and registers as many output ports as requested.

sink_name

The name for the PulseAudio sink. If omitted defaults to jack_out.

server_name

The JACK server to connect to. If omitted defaults to the default server.

client_name

The client name to tell the JACK server. If omitted defaults to PulseAudio.

channels

Number of channels to register. If omitted 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 physical playback ports of the JACK server

module-jack-source

This module implements a PulseAudio source that connects to JACK and registers as many input ports as requested. Takes the same arguments as module-jack-sink, except for sink_name which is replaced by source_name (with a default of jack_in) for obvious reasons.

Miscellaneous

module-sine

Creates a sink input and generates a sine waveform stream.

sink

The sink to connect to. If omitted defaults to the default sink.

frequency

The frequency to generate in Hertz. Defaults to 440.

module-esound-compat-spawnfd

This is a compatibility module for libesd based autospawning of PulseAudio. Don't use it directly.

module-esound-compat-spawnpid

This is a compatibility module for libesd based autospawning of PulseAudio. Don't use it directly.

module-match

Adjust the volume of a playback stream automatically based on its name.

table

The regular expression matching table file to use (defaults to ~/.pulse/match.table)

The table file should contain a regexp and volume on each line, separated by spaces. An example: 

^sample: 32000

The volumes of all streams with titles starting with sample: are automatically set to 32000. (FYI: All sample cache streams start with sample:)

module-volume-restore

Adjust the volume of a playback stream automatically based on its name.

table

The table file to use (defaults to ~/.pulse/volume.table)

In contrast to module-match this module needs no explicit configuration. Instead the volumes are saved and restored in a fully automatic fashion depending on the client name to identify streams. The volume for a stream is automatically saved every time it is changed and than restored when a new stream is created.

This does not only restores the volume level but also the used sink which is useful if the target server provides more than one.

module-detect

Automatically detect the available sound hardware and load modules for it. Supports OSS, ALSA, Solaris and Win32 output drivers, and the information is taken directy from them, not through HAL.
Do not use this together with module-hal-detect!

The parameter:

just-one

If set to 1 the module will only try to load a single sink/source and than stop.

module-hal-detect

Detects audio devices on the system using HAL.

Do not use this together with module-detect!

Since 0.9.11

tsched

Use system-timer based model (aka glitch-free). Defaults to 1 (enabled). This value is simply passed through to the alsa sink/source modules. If your hardware does not return accurate timing information (e.g. Creative sound cards) you can try to set tsched=0 to enable the interupt based timing which was used in 0.9.10 and before.

module-zeroconf-publish

Publish all local sinks/sources using mDNS Zeroconf.

module-zeroconf-discover

Discover sinks/sources on other PulseAudio servers using mDNS Zeroconf.

module-rescue-streams

Automatically route a stream whose sink has become unavailable (e.g. USB hw plugged out) to another working sink.

module-ladspa-sink

Since 0.9.7. Adds signal processing (for example equalizing) to a sink with a LADSPA plugin.

The module shows up as a separate sink.

sink_name

Name for this sink.

master

The sink where the processed audio is forwarded to.

format, channels, rate, channel_map

Normal sink parameters. It's best to leave these unspecified, so that the master sink parameters will be used.

plugin

The name of the .so file that contains the desired filter without the ".so" part. Specify only the file name, not the full directory path. The directories where the plugin files are searched from can be specified with the environment variable LADSPA_PATH. Multiple directories can be specified using colon (:) as the separator. If the environment variable isn't set, "$libdir/ladspa:/usr/local/lib/ladspa:/usr/lib/ladspa" is used instead ($libdir is specified at build time, so the default search path should include the directory where your distribution installs LADSPA plugins).

label

One plugin file may contain multiple plugins, which are identified by a label. Specify it here.

control

If the plugin has control input ports, you have to specify their values here. That is done by simply listing the numeric values using comma as the separator. Default values can be used by leaving the number out. If you're running PulseAudio version less than 0.9.10 and you want the last control port to use the default value, you have to add an extra comma to the end (bug #204). Examples: Plugin with five control ports, leaving the third to the default value:
control=0.34,-2.3,,0.00346,5
Plugin with three control ports, leaving all to the default values:
control=,,

An example: adding an equalizer to a normal alsa sink (on Debian the mbeq plugin is in the swh-plugins package). Note: This particular plugin only works on PulseAudio 0.9.8 and newer. 

load-module module-ladspa-sink sink_name=ladspa_out master=alsa_out plugin=mbeq_1197 label=mbeq control=11.621622,10,4.594594,2.702703,0,0,-1.621622,-0.270270,-5.405406,-3.513514,-8.648648,-5.675676,-4.054054,1.351351,9.189189

The control values can't be modified at run-time, so it can be a problem to figure out good control values for the plugin. The writer of this documentation used JACK Rack to find the values. This is a good solution if you already are familiar with Jack, but if you're not, this is one more thing to learn. If someone knows a handier way to fiddle with the parameters, please edit this page.

Currently this module only works with plugins that have one audio input port named "Input" and one output with name "Output". Patches welcome!

Control output ports are ignored.

module-console-kit

Since 0.9.11. Create a client for each ConsoleKit? session of this user

module-position-event-sounds

Since 0.9.11. Position event sounds between L and R depending on the position on screen of the widget triggering them.

module-always-sink

Since 0.9.11. Always keeps at least one sink loaded even if it's a null one

sink_name

The name for the new virtual sink.

module-suspend-on-idle

Since 0.9.11. Disconnects sinks and sources from their backend after a predetermined amount of idle time. Idle time is accumulated when the sink/source in question is not connected to any streams.

Advantages: Saves power. ALSA uses considerably more CPU cycles when pulseaudio has to send empty data to the soundcard during idle. If you don't plan to have an active stream all the time, set the timer to a low value for best power savings.

Disadvantages: When pulseaudio gives up the backend, and the backend is not capable of mixing, errant applications can grab the sound device and hold exclusive control over it, making pulseaudio stop working. If pulseaudio does not give up the backend, errant applications won't be able to play sound, but they will not disrupt pulseaudio's operation either. This scenario is possible 99% of the time, since most users run an ALSA sink/source without a card that has software mixing. An "errant application" would, for example, try to open hw:0 or front:0 rather than the 'default' ALSA device.

timeout

Time, in seconds, which must elapse before a sink or source is deemed idle.