Blame doc/README-jack

Packit Service cd2a00
JACK <--> ALSA PCM plugin
Packit Service cd2a00
=========================
Packit Service cd2a00
Packit Service cd2a00
This plugin converts the ALSA API over JACK (Jack Audio Connection
Packit Service cd2a00
Kit, http://jackit.sf.net) API.  ALSA native applications can work
Packit Service cd2a00
transparently together with jackd for both playback and capture.
Packit Service cd2a00
Packit Service cd2a00
	ALSA apps (playback) -> ALSA-lib -> JACK plugin -> JACK deamon
Packit Service cd2a00
	ALSA apps (capture) <- ALSA-lib <- JACK plugin <- JACK daemon
Packit Service cd2a00
Packit Service cd2a00
This plugin provides the PCM type "jack".  The typical configuration
Packit Service cd2a00
looks like below:
Packit Service cd2a00
Packit Service cd2a00
	pcm.jack {
Packit Service cd2a00
		type jack
Packit Service cd2a00
		playback_ports {
Packit Service cd2a00
			0 alsa_pcm:playback_1
Packit Service cd2a00
			1 alsa_pcm:playback_2
Packit Service cd2a00
		}
Packit Service cd2a00
		capture_ports {
Packit Service cd2a00
			0 alsa_pcm:capture_1
Packit Service cd2a00
			1 alsa_pcm:pcapture_2
Packit Service cd2a00
		}
Packit Service cd2a00
	}
Packit Service cd2a00
Packit Service cd2a00
Put the above to ~/.asoundrc (or /etc/asound.conf), and use "jack" PCM
Packit Service cd2a00
with your ALSA apps.  For example,
Packit Service cd2a00
Packit Service cd2a00
	% aplay -Djack foo.wav
Packit Service cd2a00
Packit Service cd2a00
The jack plugin can have two config options: playback_ports and
Packit Service cd2a00
capture_ports.  Both are compound type config, including the following
Packit Service cd2a00
format:
Packit Service cd2a00
	{
Packit Service cd2a00
		channel	port-name
Packit Service cd2a00
		channel port-name
Packit Service cd2a00
		...
Packit Service cd2a00
	}
Packit Service cd2a00
The first argument is the channel number (zero-based) and the second
Packit Service cd2a00
is the corresponding JACK port name.
Packit Service cd2a00
Packit Service cd2a00
The plugin is installed in /usr/lib/alsa-lib directory as default,
Packit Service cd2a00
which is the default search path of additional plugins for alsa-lib.
Packit Service cd2a00
On a 64bit system like x86-64, the proper prefix option (typically,
Packit Service cd2a00
--prefix=/usr/lib64) must be given to configure script.
Packit Service cd2a00