Doc: Added some snippets to the multimedia audio docs.

4 files changed, 18 insertions, 5 deletions

diff --git a/src/multimedia/audio/qaudiodeviceinfo.cpp b/src/multimedia/audio/qaudiodeviceinfo.cpp
index e349733372..e38a91e98b 100644
--- a/src/multimedia/audio/qaudiodeviceinfo.cpp
+++ b/src/multimedia/audio/qaudiodeviceinfo.cpp
@@ -71,7 +71,11 @@ QT_BEGIN_NAMESPACE
     audio plugins installed and 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().
+    nearestFormat(). For instance:
+
+    \snippet doc/src/snippets/audio/main.cpp 1
+    \dots 8
+    \snippet doc/src/snippets/audio/main.cpp 2
 
     A QAudioDeviceInfo is constructed with a QAudioDeviceId, which is
     an identifier for a physical device. It is used by Qt to construct
diff --git a/src/multimedia/audio/qaudioformat.cpp b/src/multimedia/audio/qaudioformat.cpp
index ddfcc2c28f..c23e454771 100644
--- a/src/multimedia/audio/qaudioformat.cpp
+++ b/src/multimedia/audio/qaudioformat.cpp
@@ -134,7 +134,8 @@ public:
     through functions in QAudioDeviceInfo. This class also lets you
     query available parameter values for a device, so that you can set
     the parameters yourself. See the QAudioDeviceInfo class
-    description for details.
+    description for details. You need to know the format of the audio
+    streams you wish to play. Qt does not set up formats for you.
 */
 
 /*!
diff --git a/src/multimedia/audio/qaudioinput.cpp b/src/multimedia/audio/qaudioinput.cpp
index edf6dd6749..3c0d98eb0c 100644
--- a/src/multimedia/audio/qaudioinput.cpp
+++ b/src/multimedia/audio/qaudioinput.cpp
@@ -128,7 +128,12 @@ QT_BEGIN_NAMESPACE
     which states the QAudioInput has been in.
 
     If an error should occur, you can fetch its reason with error().
-    The possible error reasons are described by the QAudio::Error enum.
+    The possible error reasons are described by the QAudio::Error
+    enum. The QAudioInput will enter the \l{QAudio::}{StopState} when
+    an error is encountered.  Connect to the stateChanged() signal to
+    handle the error:
+
+    \snippet doc/src/snippets/audio/main.cpp 0
 
     \sa QAudioOutput, QAudioDeviceInfo
 */
diff --git a/src/multimedia/audio/qaudiooutput.cpp b/src/multimedia/audio/qaudiooutput.cpp
index 556b616ee0..8a8edb4109 100644
--- a/src/multimedia/audio/qaudiooutput.cpp
+++ b/src/multimedia/audio/qaudiooutput.cpp
@@ -129,9 +129,12 @@ QT_BEGIN_NAMESPACE
 
     If an error occurs, you can fetch the \l{QAudio::Error}{error
     type} with the error() function. Please see the QAudio::Error enum
-    for a description of the possible errors that are reported.
+    for a description of the possible errors that are reported.  When
+    an error is encountered, the state changes to QAudio::StopState.
+    You can check for errors by connecting to the stateChanged()
+    signal:
 
-    If an error is encountered state changes to QAudio::StopState.
+    \snippet doc/src/snippets/audio/main.cpp 3
 
     \sa QAudioInput, QAudioDeviceInfo
 */