summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2012-11-30 15:32:55 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-11-30 15:38:33 +0100
commit1315dcf09c9a4908b1b74d56a1a6b8de87b5d9bd (patch)
tree8e7593d7789061a10b318e12ef9ca3008d1cc589
parentcf8824c5d4ca7ce5ba0b6ed4f51d716aac2448b5 (diff)
downloadqtmultimedia-1315dcf09c9a4908b1b74d56a1a6b8de87b5d9bd.tar.gz
Doc: Added missing images and made some language edits
Change-Id: I9544121601c2c4099927e0e23550c3ab32bbfda9 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
-rw-r--r--examples/audioinput/doc/images/audioinput-example.pngbin0 -> 10383 bytes
-rw-r--r--examples/audioinput/doc/src/audioinput.qdoc7
-rwxr-xr-xexamples/audiooutput/doc/images/audiooutput-example.pngbin0 -> 11966 bytes
-rw-r--r--examples/audiooutput/doc/src/audiooutput.qdoc5
-rw-r--r--examples/spectrum/doc/images/spectrum-demo.pngbin0 -> 10500 bytes
-rw-r--r--examples/spectrum/doc/src/spectrum.qdoc28
-rw-r--r--examples/videographicsitem/doc/images/video-videographicsitem.pngbin0 -> 54436 bytes
-rw-r--r--examples/videographicsitem/doc/src/videographicsitem.qdoc8
-rw-r--r--examples/videowidget/doc/images/video-videowidget.pngbin0 -> 54199 bytes
-rw-r--r--examples/videowidget/doc/src/videowidget.qdoc12
-rw-r--r--src/multimedia/doc/qtmultimedia.qdocconf3
11 files changed, 54 insertions, 9 deletions
diff --git a/examples/audioinput/doc/images/audioinput-example.png b/examples/audioinput/doc/images/audioinput-example.png
new file mode 100644
index 000000000..fb703e68c
--- /dev/null
+++ b/examples/audioinput/doc/images/audioinput-example.png
Binary files differ
diff --git a/examples/audioinput/doc/src/audioinput.qdoc b/examples/audioinput/doc/src/audioinput.qdoc
index 0ce56d161..4fc7e6e64 100644
--- a/examples/audioinput/doc/src/audioinput.qdoc
+++ b/examples/audioinput/doc/src/audioinput.qdoc
@@ -30,7 +30,14 @@
\title Audio Input Example
\ingroup audio_examples
\brief The Audio Input Example shows the use of the QAudioInput class.
+ The example demonstrates the basic use cases of the QAudioInput class.
+ \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.
*/
diff --git a/examples/audiooutput/doc/images/audiooutput-example.png b/examples/audiooutput/doc/images/audiooutput-example.png
new file mode 100755
index 000000000..5588fbb57
--- /dev/null
+++ b/examples/audiooutput/doc/images/audiooutput-example.png
Binary files differ
diff --git a/examples/audiooutput/doc/src/audiooutput.qdoc b/examples/audiooutput/doc/src/audiooutput.qdoc
index f91a051ce..c29fcd81d 100644
--- a/examples/audiooutput/doc/src/audiooutput.qdoc
+++ b/examples/audiooutput/doc/src/audiooutput.qdoc
@@ -31,8 +31,13 @@
\ingroup audio_examples
\brief The Audio Output Example show the use of the QAudioOutput API.
+ The example demonstrates the basic use cases of the QAudioOutput class.
+ \image audiooutput-example.png
+ This example provides a tone generator to supply continuous audio playback.
+ The first button allows pause and resume of the playback, and the second
+ button allows toggling between push and pull modes of operation.
*/
diff --git a/examples/spectrum/doc/images/spectrum-demo.png b/examples/spectrum/doc/images/spectrum-demo.png
new file mode 100644
index 000000000..9ccb489a9
--- /dev/null
+++ b/examples/spectrum/doc/images/spectrum-demo.png
Binary files differ
diff --git a/examples/spectrum/doc/src/spectrum.qdoc b/examples/spectrum/doc/src/spectrum.qdoc
index e1eb9234d..64c6f8364 100644
--- a/examples/spectrum/doc/src/spectrum.qdoc
+++ b/examples/spectrum/doc/src/spectrum.qdoc
@@ -31,6 +31,34 @@
\ingroup audio_examples
\brief The Spectrum Example uses a combination multimedia APIs to process microphone input.
+ The Spectrum Analyzer example shows how the \l{QtMultimedia Module} can be
+ used to record and then play back an audio stream.
+
+ \image spectrum-demo.png
+
+ Because QtMultimedia allows the application to access the raw audio
+ stream, the data can either be inspected or modified by the application.
+ The Spectrum Analyzer example displays three pieces of information while
+ audio is being either captured or played back:
+
+ \list
+ \li Information about the raw audio stream, shown in the uppermost widget:
+ \list
+ \li The amount of data currently in the buffer, shown in blue
+ \li The segment of data which was most recently analysed to compute
+ the frequency spectrum, shown in green
+ \li The raw audio waveform, shown in white and scrolling from right to
+ left
+ \endlist
+ \li A representation of the frequency spectrum, shown at the lower left
+ \li The current RMS level of the audio stream, and the recent 'high
+ watermark' level, shown at the lower right
+ \endlist
+
+ Spectrum analysis is performed by calculating the Fast Fourier Transform
+ (FFT) of a segment of audio data. An open-source library,
+ \l{http://ldesoras.free.fr/prod.html}{FFTReal}, against which the
+ application is dynamically linked, is used to compute the transform.
*/
diff --git a/examples/videographicsitem/doc/images/video-videographicsitem.png b/examples/videographicsitem/doc/images/video-videographicsitem.png
new file mode 100644
index 000000000..e333c54a2
--- /dev/null
+++ b/examples/videographicsitem/doc/images/video-videographicsitem.png
Binary files differ
diff --git a/examples/videographicsitem/doc/src/videographicsitem.qdoc b/examples/videographicsitem/doc/src/videographicsitem.qdoc
index 86ddd15b2..c1eb0ccc7 100644
--- a/examples/videographicsitem/doc/src/videographicsitem.qdoc
+++ b/examples/videographicsitem/doc/src/videographicsitem.qdoc
@@ -29,8 +29,12 @@
\example videographicsitem
\title Video Graphics Item Example
\ingroup video_examples
+\brief This example demonstrates how to stream video on a graphics scene.
-\brief This example demonstrates how to make a simple video player using the QMediaPlayer
-and QVideoGraphicsItem classes in the Graphics View framework.
+ The Video Graphics Item example shows how to implement a QGraphicsItem that displays video on a
+ graphics scene using QtMultimedia's QAbstractVideoSurface.
+ \image video-videographicsitem.png
+
+ \sa {Video Widget Example}
*/
diff --git a/examples/videowidget/doc/images/video-videowidget.png b/examples/videowidget/doc/images/video-videowidget.png
new file mode 100644
index 000000000..a3c7bcb44
--- /dev/null
+++ b/examples/videowidget/doc/images/video-videowidget.png
Binary files differ
diff --git a/examples/videowidget/doc/src/videowidget.qdoc b/examples/videowidget/doc/src/videowidget.qdoc
index f682d50ec..860cb7ac5 100644
--- a/examples/videowidget/doc/src/videowidget.qdoc
+++ b/examples/videowidget/doc/src/videowidget.qdoc
@@ -26,11 +26,13 @@
****************************************************************************/
/*!
-\example videowidget
-\title Video Widget Example
-\ingroup video_examples
+ \example videowidget
+ \title Video Widget Example
+ \ingroup video_examples
+ \brief This example is a simple video player
-\brief This example demonstrates how to make a simple video player using the QMediaPlayer
-and QVideoWidget classes
+ The Video Widget example denonstrates how to implement a video widget using
+ QtMultimedia's QAbstractVideoSurface.
+ \image video-videowidget.png
*/
diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf
index bc5c0912d..a6c9576b7 100644
--- a/src/multimedia/doc/qtmultimedia.qdocconf
+++ b/src/multimedia/doc/qtmultimedia.qdocconf
@@ -29,8 +29,7 @@ qhp.qtmultimedia.subprojects.qmltypes.indexTitle = Qt Multimedia QML Types
qhp.qtmultimedia.subprojects.qmltypes.selectors = class fake:headerfile
qhp.qtmultimedia.subprojects.qmltypes.sortPages = true
-exampledirs += .. \
- ../../../examples
+exampledirs += ../../../examples \
headerdirs += ../..