summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicholas Bennett <nicholas.bennett@qt.io>2022-01-11 15:34:58 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-01-12 07:02:31 +0000
commit5225837908bdaef0c63795e789fa6baf79fae9f7 (patch)
tree9b0295038927063bfaa1c3e9eba796ddb1be9f68
parent685e16a513be4182d28099266ff1d524158c4160 (diff)
Docs: Remove reference to QAudioDevice::nearestFormat
When setting a media format property the class will now automatically find the nearest supported property value if value being set is not supported by the QAudioDevice. The is no nearestFormat() to call. Updated the snippet reference to one that is more useful and removed the obsolete reference. Fixes: 99645 Change-Id: If04d78f47e9fda482eb392b95931ca1b0eee9337 Reviewed-by: Lars Knoll <lars.knoll@qt.io> (cherry picked from commit 22df11fc74d680014d2a3a876bbd765101922c52) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/multimedia/audio/qaudiodevice.cpp7
1 files changed, 3 insertions, 4 deletions
diff --git a/src/multimedia/audio/qaudiodevice.cpp b/src/multimedia/audio/qaudiodevice.cpp
index bc3e50058..f2265dcf6 100644
--- a/src/multimedia/audio/qaudiodevice.cpp
+++ b/src/multimedia/audio/qaudiodevice.cpp
@@ -73,10 +73,9 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QAudioDevicePrivate);
minimumSampleRate(), maximumSampleRate() and supportedSampleFormats(). The
combinations supported are dependent on the audio device capabilities. If
you need a specific format, you can check if the device supports it with
- isFormatSupported(), or fetch a supported format that is as close as
- possible to the format with nearestFormat(). For instance:
+ isFormatSupported(). For instance:
- \snippet multimedia-snippets/audio.cpp Setting audio format
+ \snippet multimedia-snippets/audio.cpp Audio output setup
The set of available devices can be retrieved from the QMediaDevices class.
@@ -88,7 +87,7 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QAudioDevicePrivate);
sound, i.e., play an audio stream in a supported format. For each device we
find, we simply print the deviceName().
- \sa QAudioSink, QAudioSource
+ \sa QAudioSink, QAudioSource QAudioFormat
*/
/*!