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 /examples/multimedia/audioinput/doc/src/audioinput.qdoc | |
| parent | db4eb8383517bb94651b5b3e5768ae7eaaee7093 (diff) | |
| download | qtmultimedia-aa1f073a32147d147e4e9a0fee9dde8ccc30531e.tar.gz | |
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 'examples/multimedia/audioinput/doc/src/audioinput.qdoc')
| -rw-r--r-- | examples/multimedia/audioinput/doc/src/audioinput.qdoc | 45 |
1 files changed, 0 insertions, 45 deletions
diff --git a/examples/multimedia/audioinput/doc/src/audioinput.qdoc b/examples/multimedia/audioinput/doc/src/audioinput.qdoc deleted file mode 100644 index 5339f2821..000000000 --- a/examples/multimedia/audioinput/doc/src/audioinput.qdoc +++ /dev/null @@ -1,45 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \example multimedia/audioinput - \title Audio Input Example - \ingroup multimedia_examples - \brief Recording audio using the QAudioInput class. - - \e{Audio Input} demonstrates the basic use cases of QAudioInput. - - \image audioinput-example.png - - Qt provides the QAudioInput class to enable audio functionality within - a standard application user interface. - - This example calculates the maximum linear value of the input audio from the - microphone and displays the output. - - \include examples-run.qdocinc -*/ |