diff options
| author | Lars Knoll <lars.knoll@qt.io> | 2021-06-03 10:21:37 +0200 |
|---|---|---|
| committer | Lars Knoll <lars.knoll@qt.io> | 2021-06-04 14:15:43 +0200 |
| commit | aa1f073a32147d147e4e9a0fee9dde8ccc30531e (patch) | |
| tree | 0ac28cc3422f2258464f3043cf48443c60e13986 /src/multimedia/doc/src/audiooverview.qdoc | |
| parent | db4eb8383517bb94651b5b3e5768ae7eaaee7093 (diff) | |
Rename QAudioInput to QAudioSource
The renaming is a part of some changes coming from an
API review that tries to solve the problem of not having
API symmetry between QCameraInfo/QCamera and QAudioDeviceInfo
where QAudioDevice is missing (so you can't select a nullptr
as the input/output device to disable it).
One issue is that QAudioInput/QAudioOutput are there for reading
and writing low level PCM data from an audio device. They as such
are not quite suitable as classes to use together with QMediaPlayer
or QMediaCaptureSession, as they allow direct writing of data
bypassing the player or capture pipeline.
To solve this, we renamve those classes to QAudioSource/Sink
(making it a bit more symmetric with QVideoSink). That opens up
our API space for a QAudioDevice class avoiding names that feel
like they are doing the same thing.
The patch also renames things on the backend side to keep
API and implementation consistent.
Change-Id: I9f6b4892d3eee4e252cb3782e681b0c3824f27e2
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Diffstat (limited to 'src/multimedia/doc/src/audiooverview.qdoc')
| -rw-r--r-- | src/multimedia/doc/src/audiooverview.qdoc | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/multimedia/doc/src/audiooverview.qdoc b/src/multimedia/doc/src/audiooverview.qdoc index e74b285c7..41be6614d 100644 --- a/src/multimedia/doc/src/audiooverview.qdoc +++ b/src/multimedia/doc/src/audiooverview.qdoc @@ -77,7 +77,7 @@ microphones, and to write raw data to speakers or other devices. Generally these classes do not do any audio decoding, or other processing, but they can support different types of raw audio data. -The QAudioOutput class offers raw audio data output, while QAudioInput +The QAudioOutput class offers raw audio data output, while QAudioSource offers raw audio data input. The available hardware determines what audio outputs and inputs are available. @@ -86,7 +86,7 @@ The low level audio classes can operate in two modes - \c push and \c pull. In \c pull mode, the audio device is started by giving it a QIODevice. For an output device, the QAudioOutput class will pull data from the QIODevice (using \l QIODevice::read()) when more audio data is required. Conversely, -for \c pull mode with QAudioInput, when audio data is available then the +for \c pull mode with QAudioSource, when audio data is available then the data will be written directly to the QIODevice. In \c push mode, the audio device provides a QIODevice instance that |