Skip to content

Commit 63dbc54

Browse files
committed
controls/preferences: add explanation of buffer underflow count, add reference in controls
1 parent 5ce52d4 commit 63dbc54

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

source/chapters/appendix/mixxx_controls.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4407,7 +4407,8 @@ In the meantime, skins and controller mappings that still use them will keep wor
44074407

44084408
.. mixxx:control:: [Master],audio_latency_overload_count
44094409
4410-
Counts buffer over and under-flows, maximum one per 500 ms.
4410+
Counts buffer over- and underflows, maximum one per 500 ms.
4411+
See :ref:`preferences-sound-other-options` for details.
44114412
The count is displayed in Preferences -> Sound Hardware.
44124413

44134414
:range: 0 .. n

source/chapters/preferences/sound_hardware.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ macOS
155155
^^^^^
156156
CoreAudio is the only Sound API on macOS.
157157

158+
.. _preferences-sound-other-options:
158159
Other Sound Hardware options
159160
----------------------------
160161
* **Multi-Soundcard Synchronization**: Mixxx is able to use two or more
@@ -177,12 +178,12 @@ Other Sound Hardware options
177178
in stereo because of speaker placement or playing in a space with lots of
178179
reverberation.
179180

180-
* **Buffer Underflow Count**: Underflows (data is not available when needed)
181-
indicate that some of the subsystems in Mixxx can't keep up with real-time
182-
deadlines imposed by the current audio buffer size. This is useful to tune the
183-
latency settings. If the counter increases, then increase your audio buffer
184-
size, decrease the sample rate setting or change the sound API setting if
185-
available.
181+
* **Buffer Underflow Count**: This counts overflows in output buffers or underflows
182+
in input buffers, indicating either the output device(s) can't consume audio data
183+
generated by the engine fast enough, or the input device(s) can't provide audio data
184+
as fast as required by the current audio buffer size. If the counter increases,
185+
you may try to increase your audio buffer size, decrease the sample rate setting,
186+
change the sound API available or try another keylock/pitch-bend engine.
186187

187188
Output and Input Devices
188189
------------------------

0 commit comments

Comments
 (0)