summaryrefslogtreecommitdiffstats
path: root/examples/multimedia/audiosource/doc/src/audiosource.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/multimedia/audiosource/doc/src/audiosource.qdoc')
-rw-r--r--examples/multimedia/audiosource/doc/src/audiosource.qdoc24
1 files changed, 24 insertions, 0 deletions
diff --git a/examples/multimedia/audiosource/doc/src/audiosource.qdoc b/examples/multimedia/audiosource/doc/src/audiosource.qdoc
new file mode 100644
index 000000000..2f120ce77
--- /dev/null
+++ b/examples/multimedia/audiosource/doc/src/audiosource.qdoc
@@ -0,0 +1,24 @@
+// Copyright (C) 2015 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \example audiosource
+ \title Audio Source Example
+ \ingroup multimedia_examples
+ \ingroup audio_examples
+ \examplecategory {Multimedia}
+ \brief Recording audio using the QAudioSource class.
+ \meta {tag} {widgets}
+
+ \e{Audio Source} demonstrates the basic use cases of QAudioSource.
+
+ \image audiosource-example.png
+
+ Qt provides the QAudioSource 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
+*/