Update NEWS.txt for 3.0.7
[zynaddsubfx-code.git] / doc / output.txt
blob43dc0bbab920b773c3f9f7a0be6e8733f7236e74
1 Output engines
2 --------------
4 There are different output engines for zynaddsubfx.
6 ALSA
7 ~~~~
8 Simply start zyn using `zynaddsubfx -O alsa`.
10 NOTE: If your system is using PulseAudio, this may not work. Even if it does,
11 and ALSA redirects to PulseAudio, realtime guarantees can not be made. It is
12 recommended to follow the steps in the <<PulseAudio>> section.
14 Jack
15 ~~~~
16 NOTE: If your system is using PulseAudio, this is the suggested way, but may
17 not work out of the box, or it may not do what you want. Please seee the
18 <<PulseAudio>> section.
20 There are different ways to forward zyn to jack:
22 * Automatic connecting with `zynaddsfubx -O jack -a` will usually do what you
23   want
24 * Manual selective connecting can be done by using `zynaddsfubx -O jack` and
25   then using one of
26   - the `qjackctl` gui
27   - the `jack_connect` commandline utility
28 * Automatic selective connecting can be done using
29   https://www.rncbc.org/drupal/node/76[jack's patchbays]
31 PulseAudio
32 ~~~~~~~~~~
33 PulseAudio is *not* **directly** implemented in zyn. While PulseAudio can be
34 really practical in many cases, it has no realtime guarantees. Running zyn
35 right through pulse is thus not intended. In case you want to keep
36 PulseAudio and still use zyn, the suggested way is to route PulseAudio through
37 jack. You need to
39 * Install jack2
40 * Route pulse through jack2 using cadence
41   
42 These steps should be described for your distribution. Check out one of the
43 following links.
45 * https://wiki.archlinux.org/index.php/PulseAudio/Examples#The_KXStudio_method[Arch Linux]
46 * please add more here ...
48 After that, follow the usual steps described under <<Jack>>.