1
0
mirror of https://github.com/TomHarte/CLK.git synced 2025-03-25 06:30:38 +00:00

Improves comment.

This commit is contained in:
Thomas Harte 2021-05-06 12:57:32 -04:00 committed by GitHub
parent 7e3528c692
commit 9af6c0b37a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -8,16 +8,18 @@
#include <QIODevice>
/*!
* \brief Provides an intermediate receipticle for audio data.
* \brief An intermediate recepticle for audio data.
*
* Provides a QIODevice that will attempt to buffer the minimum amount
* of data before handing it off to a polling QAudioOutput.
*
* Adding an extra buffer increases worst-case latency but resolves a
* startup race condition in which it is difficult to tell how much data a
* QAudioOutput that is populated by pushing data currently has buffered;
* it also works around what empirically seemed to be a minimum 16384-byte
* latency on push audio generation.
* Adding an extra buffer increases worst-case latency but resolves two
* issues uncovered with use of a QAudioOutput by push:
*
* 1. knowing how much data is currently buffered, to avoid being at a
* permanent disadvantage after startup; and
* 2. that such QAudioOutputs empirically seem to introduce a minimum
* 16384-byte latency.
*/
struct AudioBuffer: public QIODevice {
AudioBuffer() {