The following loadable modules are provided with the polypaudio distribution:
All device driver modules support the following parameters:
| 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) |
Provides a simple test sink that writes the audio data to a FIFO special file in the file system. The sink name defaults to pipe_output.
The following option is supported:
| file= | The name of the FIFO special file to use. (defaults to: /tmp/music.output) |
Provides a simple test source that reads the audio data from a FIFO special file in the file system. The source name defaults to pipe_input.
The following option is supported:
| file= | The name of the FIFO special file to use. (defaults to: /tmp/music.input) |
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
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 "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) |
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= and fragment_size= arguments the same way as module-alsa-sink.
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) |
The sink name (resp. source name) defaults to oss_output (resp. oss_input).
Similar to module-oss but uses memory mapped (mmap()) access to the input/output buffers of the audio device. This provides better latency behaviour but is not as compatible as module-oss.
This module accepts exactly the same arguments as module-oss.
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 aequidistant intervals the sample rates of the output sinks is recalculated: i.e. even when the sink's 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= | 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) |
Tunnel a remote sink/source to a local "ghost" sink/source. Requires a running polypaudio 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. |
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. |
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.
For an explanation of the simple command line language used by this module see cli.html.
This module doesn't accept any arguments.
An implemenation of a simple command line based protocol for controlling the polypaudio 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.
This module supports the following options:
| 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) |
| socket= | (only for -unix) The UNIX socket name (defaults to /tmp/polypaudio/cli) |
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 |
An implemenation of a protocol compatible with the Enlightened Sound Daemon (ESOUND, esd). When you load this module you may access the polypaudio 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 |
| public= | If set to 0 not authentication is required to connect to the service |
| cookie= | Name of the cookie file for authentication purposes |
This implementation misses some features the original ESOUND has: e.g. there is no sample cache yet. However: XMMS works fine.
The native protocol of polypaudio.
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:
| public= | If set to 0 not authentication is required to connect to the service |
| cookie= | Name of the cookie file for authentication purposes |
This is used internally when auto spawning a new daemon. Don't use it directly.
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 ommited defaults to x11-bell. |
| sink= | Name of the sink to play the sample on. If ommited defaults to the default sink. |
Publishes the access credentials to the Polypaudio server in the X11 root window. The following properties are used: POLYP_SERVER, POYLP_SINK, POLYP_SOURCE, POLYP_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 Polypaudio 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 ommited defaults to the value of $DISPLAY |
| sink= | Name of the default sink. If ommited this property isn't stored in the X11 display. |
| source= | Name of the default source. If ommited 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 ommited the cookie of an already loaded protocol module is used. |
Creates a sink input and generates a sine waveform stream.
| sink= | The sink to connect to. If ommited defaults to the default sink. |
| frequency= | The frequency to generate in Hertz. Defaults to 440. |
This is a compatibility module for libesd based autospawning of polypaudio. Don't use it directly.
This is a compatibility module for libesd based autospawning of polypaudio. Don't use it directly.
Adjust the volume of a playback stream automatically based on its name.
| table= | The regular expression matching table file to use |
The table file should contain a regexp and volume on each line, seperated by spaces. An example:
^sample: 25
The volumes of all streams with titles starting with sample: are automatically set to 25. (FYI: All sample cache streams start with sample:)