Update Audio/MIDI Setup dialog's documentation

This commit is contained in:
Alexandre Prokoudine 2022-11-11 04:30:46 +03:00
parent 7494ae46a4
commit eee8be124e
2 changed files with 48 additions and 29 deletions

View File

@ -1,7 +1,7 @@
<h2 class="clear">Audio/MIDI Setup</h2>
<figure class="center">
<img src="/images/Audio-MIDI_Setup.png" alt="The Audio/MIDI Setup Dialog"/>
<img width="50%" src="/images/Audio-MIDI_Setup.png" alt="The Audio/MIDI Setup Dialog"/>
<figcaption>
The Audio/MIDI Setup Dialog
</figcaption>
@ -14,24 +14,23 @@
<table class="dl">
<tr><th>Audio System</th>
<td>Depending on the operating system, Ardour can possibly use different audio
systems, e.g. on Linux, both <abbr title="Advanced Linux Sound Architecture">
ALSA</abbr> and <abbr title="JACK Audio Connection Kit">JACK</abbr> are
available.
</td></tr>
<tr><th>Driver</th>
<td>
On Mac OS X this will typically be <kbd class="menu">CoreAudio</kbd>. On Linux usually
this will be either <kbd class="menu"><abbr title="Free Firewire Audio Driver fOr
linux">FFADO</abbr></kbd>
or <kbd class="menu"><abbr title="Advanced Linux Sound
Architecture">ALSA</abbr></kbd>, depending on whether or not a firewire device
is used. Advanced users on all platforms may also
Depending on the operating system, Ardour can possibly use different audio
systems, e.g. on Linux, both <abbr title="Advanced Linux Sound Architecture">
ALSA</abbr>, PulseAudio, and <abbr title="JACK Audio Connection Kit">JACK</abbr>
are available. On Mac OS X this will typically be
<kbd class="menu">CoreAudio</kbd>. Advanced users on all platforms may also
use <kbd class="menu">NetJack</kbd> which provides network audio I/O.
</td></tr>
<tr><th>Device</th>
<td>The selector should show all available interfaces provided by the
driver above and which are capable of duplex operation.
<tr><th>Input Device</th>
<td>
The selector should show all available interfaces provided by the
audio system above and which are capable of capturing audio.
</td></tr>
<tr><th>Output Device</th>
<td>
The selector should show all available interfaces provided by the
audio system above and which are capable of playing audio.
</td></tr>
<tr><th>Sample Rate</th>
<td>
@ -44,21 +43,41 @@
to allow for either lower latency, or lower CPU usage and higher
latency.
</td></tr>
<tr><th>Input/Output Channels</th>
<tr><th>Periods</th>
<td>
Specifies the number of hardware channels to use. The
default is <kbd class="menu">all available channels</kbd>.</td></tr>
<tr><th>Hardware Input/Output Latency</th>
<td>Specify the hardware delay in samples for precise latency compensation.</td></tr>
<tr><th>Calibrate</th>
Number of frames between each hardware interrupt (analog-digital
or digital-analog conversion).
</td></tr>
<tr><th>Hardware Monitoring</th>
<td>
This button runs a semi-automated guided process to obtain
precise hardware latency measurements for the above option.</td></tr>
This section allows choosing whether Ardour or auidio hardware should be
handling recording monitoring.
</td></tr>
<tr><th>Advanced Settings</th>
<td>
This section contains several lower-level settings listed below.
</td></tr>
<tr><th>MIDI System</th>
<td>
Selects the MIDI driver to use. On Mac OS X, this will be <kbd
class="menu">CoreMIDI</kbd>. On Linux, this will follow the audio backend.
If the Audio backend is ALSA, midi will be alsa also. If the backend is
JACK, it can be changed between two legacy
ALSA drivers or the (preferred) new JACK+ALSA implementation.</td></tr>
This allows choosing a MIDI driver. On macOS, this will be
<kbd class="menu">CoreMIDI</kbd>. On Linux, the choice will be between
ALSA sequencer and ALSA raw devices. Choosing "None" will disable the
connection to the external MIDI backend and prevent Ardour from being
exposed to external MIDI ports while allowing to route MIDI events inside
the program.
</td></tr>
<tr><th>Setup &amp; Calibration</th>
<td>
This button runs a semi-automated guided process to obtain precise
hardware latency measurements for available MIDI ports.
</td></tr>
<tr><th>Hardware Input/Output Latency</th>
<td>
Specify the hardware delay in samples for precise latency compensation.
</td></tr>
<tr><th>Calibrate Audio</th>
<td>
This button runs a semi-automated guided process to obtain precise
hardware latency measurements for available audio ports.
</td></tr>
</table>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 66 KiB