From 0241b0e39c4ac259c2336d074f1fa488d0e0ebcc Mon Sep 17 00:00:00 2001
From: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Date: Wed, 12 Dec 2012 16:35:15 +0100
Subject: [PATCH] Doc: Updated the \example and \snippet paths
Also:
- Grouped the example docs under one group. i.e. multimedia-examples
- Moved the \group page here from the qtdoc repo
- Moved the snippets directory under doc from doc/src
Change-Id: I28fb81cf910e58101cd601fb4c440b59b0b0366d
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
---
.../audiodevices/doc/src/audiodevices.qdoc | 4 +-
.../audioengine/doc/src/audioengine.qdoc | 4 +-
.../audioinput/doc/src/audioinput.qdoc | 4 +-
.../audiooutput/doc/src/audiooutput.qdoc | 4 +-
.../audiorecorder/doc/src/audiorecorder.qdoc | 8 +---
.../doc/src/declarative-radio.qdoc | 7 ++-
.../multimedia/spectrum/doc/src/spectrum.qdoc | 6 +--
.../multimedia/video/doc/src/qmlvideo.qdoc | 48 +++++++++----------
.../multimedia/video/doc/src/qmlvideofx.qdoc | 29 ++++++-----
.../camera/doc/src/camera.qdoc | 6 +--
.../doc/src/declarative-camera.qdoc | 5 +-
.../player/doc/src/player.qdoc | 6 +--
.../doc/src/videographicsitem.qdoc | 4 +-
.../videowidget/doc/src/videowidget.qdoc | 4 +-
src/multimedia/doc/qtmultimedia.qdocconf | 1 +
.../snippets/multimedia-snippets/audio.cpp | 0
.../multimedia-snippets/audiorecorder.cpp | 0
.../snippets/multimedia-snippets/camera.cpp | 0
.../snippets/multimedia-snippets/media.cpp | 0
.../multimedia-snippets.pro | 0
.../snippets/multimedia-snippets/qsound.cpp | 0
.../multimedia-snippets/soundeffect.qml | 0
.../snippets/multimedia-snippets/video.cpp | 0
.../doc/{src => }/snippets/snippets.pro | 0
src/multimedia/doc/src/audiooverview.qdoc | 10 ++--
src/multimedia/doc/src/cameraoverview.qdoc | 8 ++--
.../doc/src/qtmultimedia-examples.qdoc | 37 ++++++++++++++
.../doc/src/qtmultimedia-index.qdoc | 19 +-------
src/multimedia/doc/src/videooverview.qdoc | 12 ++---
src/multimedia/qmediacontrol.cpp | 6 +--
src/multimedia/qmediaservice.cpp | 2 +-
src/multimedia/radio/qradiodata.cpp | 2 +-
src/multimedia/radio/qradiotuner.cpp | 2 +-
src/multimedia/recording/qaudiorecorder.cpp | 4 +-
.../recording/qmediaencodersettings.cpp | 6 +--
src/multimedia/recording/qmediarecorder.cpp | 2 +-
36 files changed, 133 insertions(+), 117 deletions(-)
rename src/multimedia/doc/{src => }/snippets/multimedia-snippets/audio.cpp (100%)
rename src/multimedia/doc/{src => }/snippets/multimedia-snippets/audiorecorder.cpp (100%)
rename src/multimedia/doc/{src => }/snippets/multimedia-snippets/camera.cpp (100%)
rename src/multimedia/doc/{src => }/snippets/multimedia-snippets/media.cpp (100%)
rename src/multimedia/doc/{src => }/snippets/multimedia-snippets/multimedia-snippets.pro (100%)
rename src/multimedia/doc/{src => }/snippets/multimedia-snippets/qsound.cpp (100%)
rename src/multimedia/doc/{src => }/snippets/multimedia-snippets/soundeffect.qml (100%)
rename src/multimedia/doc/{src => }/snippets/multimedia-snippets/video.cpp (100%)
rename src/multimedia/doc/{src => }/snippets/snippets.pro (100%)
create mode 100644 src/multimedia/doc/src/qtmultimedia-examples.qdoc
diff --git a/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc b/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc
index d2522f3ae..af51e373f 100644
--- a/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc
+++ b/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc
@@ -26,9 +26,9 @@
****************************************************************************/
/*!
- \example audiodevices
+ \example multimedia/audiodevices
\title Audio Devices Example
- \ingroup audio_examples
+ \ingroup multimedia_examples
\brief The Audio Devices example shows the application of the audio devices APIs
diff --git a/examples/multimedia/audioengine/doc/src/audioengine.qdoc b/examples/multimedia/audioengine/doc/src/audioengine.qdoc
index bea4d4b57..ba2f17c52 100644
--- a/examples/multimedia/audioengine/doc/src/audioengine.qdoc
+++ b/examples/multimedia/audioengine/doc/src/audioengine.qdoc
@@ -26,9 +26,9 @@
****************************************************************************/
/*!
- \example audioengine
+ \example multimedia/audioengine
\title AudioEngine Example
- \ingroup audioengine_examples
+ \ingroup multimedia_examples
\brief The Audio Engine example demonstrates 3D sound control using
the QtAudioEngine API.
diff --git a/examples/multimedia/audioinput/doc/src/audioinput.qdoc b/examples/multimedia/audioinput/doc/src/audioinput.qdoc
index 4fc7e6e64..ccd4ed269 100644
--- a/examples/multimedia/audioinput/doc/src/audioinput.qdoc
+++ b/examples/multimedia/audioinput/doc/src/audioinput.qdoc
@@ -26,9 +26,9 @@
****************************************************************************/
/*!
- \example audioinput
+ \example multimedia/audioinput
\title Audio Input Example
- \ingroup audio_examples
+ \ingroup multimedia_examples
\brief The Audio Input Example shows the use of the QAudioInput class.
The example demonstrates the basic use cases of the QAudioInput class.
diff --git a/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc b/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
index c29fcd81d..91c735fa6 100644
--- a/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
+++ b/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
@@ -26,9 +26,9 @@
****************************************************************************/
/*!
- \example audiooutput
+ \example multimedia/audiooutput
\title Audio Output Example
- \ingroup audio_examples
+ \ingroup multimedia_examples
\brief The Audio Output Example show the use of the QAudioOutput API.
The example demonstrates the basic use cases of the QAudioOutput class.
diff --git a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
index 3dea92cac..df3ce1389 100644
--- a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
+++ b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
@@ -26,9 +26,9 @@
****************************************************************************/
/*!
- \example audiorecorder
+ \example multimedia/audiorecorder
\title Audio Recorder Example
- \ingroup audio_examples
+ \ingroup multimedia_examples
\brief The Audio Recorder Example shows how to create a simple audio recorder.
It demonstrates the discovery of the supported devices and codecs and the use
@@ -95,10 +95,6 @@
\code
ui->statusbar->showMessage(tr("Recorded %1 sec").arg(duration / 1000));
\endcode
-
-
-
-
*/
diff --git a/examples/multimedia/declarative-radio/doc/src/declarative-radio.qdoc b/examples/multimedia/declarative-radio/doc/src/declarative-radio.qdoc
index 8b52e6c71..bf3f39ca0 100644
--- a/examples/multimedia/declarative-radio/doc/src/declarative-radio.qdoc
+++ b/examples/multimedia/declarative-radio/doc/src/declarative-radio.qdoc
@@ -26,10 +26,13 @@
****************************************************************************/
/*!
- \example declarative-radio
+ \example multimedia/declarative-radio
\title Declarative Radio Example
+ \brief Demonstrates the radio functionality
+ \ingroup multimedia_examples
-
+ This examples uses the Qt Multimedia Radio QML type to list the available
+ channels on the FM frequency.
*/
diff --git a/examples/multimedia/spectrum/doc/src/spectrum.qdoc b/examples/multimedia/spectrum/doc/src/spectrum.qdoc
index 64c6f8364..5e91af439 100644
--- a/examples/multimedia/spectrum/doc/src/spectrum.qdoc
+++ b/examples/multimedia/spectrum/doc/src/spectrum.qdoc
@@ -26,12 +26,12 @@
****************************************************************************/
/*!
- \example spectrum
+ \example multimedia/spectrum
\title Spectrum Example
- \ingroup audio_examples
+ \ingroup multimedia_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
+ The Spectrum Analyzer example shows how the \l{Qt Multimedia} module can be
used to record and then play back an audio stream.
\image spectrum-demo.png
diff --git a/examples/multimedia/video/doc/src/qmlvideo.qdoc b/examples/multimedia/video/doc/src/qmlvideo.qdoc
index c27ca1bce..359d07156 100644
--- a/examples/multimedia/video/doc/src/qmlvideo.qdoc
+++ b/examples/multimedia/video/doc/src/qmlvideo.qdoc
@@ -26,9 +26,9 @@
****************************************************************************/
/*!
-\example video/qmlvideo
+\example multimedia/video/qmlvideo
\title QML Video Example
-\ingroup video_examples_qml
+\ingroup multimedia_examples
\brief The QML Video Example demonstrates the various manipulations (move;
resize; rotate; change aspect ratio) which can be applied to QML \l{VideoOutput}
@@ -52,15 +52,15 @@ which moves across the \l{VideoOutput} item.
\section1 Application structure
-The \l{video/qmlvideo/qml/qmlvideo/main.qml} file creates a UI which includes
+The \l{multimedia/video/qmlvideo/qml/qmlvideo/main.qml} file creates a UI which includes
the following items:
\list
- \li Two \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button} instances, each
+ \li Two \l{multimedia/video/qmlvideo/qml/qmlvideo/Button.qml}{Button} instances, each
of which displays a filename, and can be used to launch a
- \l{video/qmlvideo/qml/qmlvideo/FileBrowser.qml}{FileBrowser}
- \li An exit \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button}
- \li A \l{video/qmlvideo/qml/qmlvideo/SceneSelectionPanel.qml}{SceneSelectionPanel},
+ \l{multimedia/video/qmlvideo/qml/qmlvideo/FileBrowser.qml}{FileBrowser}
+ \li An exit \l{multimedia/video/qmlvideo/qml/qmlvideo/Button.qml}{Button}
+ \li A \l{multimedia/video/qmlvideo/qml/qmlvideo/SceneSelectionPanel.qml}{SceneSelectionPanel},
which is a flickable list displaying the available scenes
\li At the lower left, an item which displays the QML repainting rate - the
upper number is the instantaneous frame rate and the lower number is the
@@ -72,18 +72,18 @@ the following items:
Each scene in the flickable list is implemented in its own QML file - for
example the video-basic scene (which just displays a static \l{VideoOutput}
in the center of the screen) is implemented in the
-\l{video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic.qml} file. As you
+\l{multimedia/ideo/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic.qml} file. As you
can see from the code, this makes use of a type of inheritance: a
-\l{video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic} item ...
+\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic} item ...
-\quotefromfile video/qmlvideo/qml/qmlvideo/VideoBasic.qml
+\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml
\skipto import
\printuntil /^\}/
... is-a
-\l{video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} ...
+\l{multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} ...
-\quotefromfile video/qmlvideo/qml/qmlvideo/SceneBasic.qml
+\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml
\skipto import
\printuntil contentType
\dots
@@ -94,9 +94,9 @@ can see from the code, this makes use of a type of inheritance: a
\printuntil /^\}/
... which is-a
-\l{video/qmlvideo/qml/qmlvideo/Scene.qml}{Scene}:
+\l{multimedia/video/qmlvideo/qml/qmlvideo/Scene.qml}{Scene}:
-\quotefromfile video/qmlvideo/qml/qmlvideo/Scene.qml
+\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/Scene.qml
\skipto import
\printuntil root
\dots
@@ -106,35 +106,35 @@ can see from the code, this makes use of a type of inheritance: a
\skipto Button
\printuntil /^\}/
-\l{video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} describes the
+\l{multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} describes the
structure and behaviour of the scene, but is agnostic of the type of content
which will be displayed - this is abstracted by
-\l{video/qmlvideo/qml/qmlvideo/Content.qml}{Content}.
+\l{multimedia/video/qmlvideo/qml/qmlvideo/Content.qml}{Content}.
This pattern allows us to define a particular use case (in this case, simply
display a static piece of content), and then instantiate that use case for
both video content
-(\l{video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic}) and cameracontent
-(\l{video/qmlvideo/qml/qmlvideo/CameraBasic.qml}{CameraBasic}). This approach
+(\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic}) and cameracontent
+(\l{multimedia/video/qmlvideo/qml/qmlvideo/CameraBasic.qml}{CameraBasic}). This approach
is used to implement many of the other scenes - for example, "repeatedly slide
the content from left to right and back again" is implemented by
-\l{video/qmlvideo/qml/qmlvideo/SceneMove.qml}{SceneMove}, on which
-\l{video/qmlvideo/qml/qmlvideo/VideoMove.qml}{VideoMove} and
-\l{video/qmlvideo/qml/qmlvideo/CameraMove.qml}{CameraMove} are based.
+\l{multimedia/video/qmlvideo/qml/qmlvideo/SceneMove.qml}{SceneMove}, on which
+\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoMove.qml}{VideoMove} and
+\l{multimedia/video/qmlvideo/qml/qmlvideo/CameraMove.qml}{CameraMove} are based.
Depending on the value of the contentType property in the top-level scene
instance, the embedded
-\l{video/qmlvideo/qml/qmlvideo/Content.qml}{Content} item creates either a
+\l{multimedia/video/qmlvideo/qml/qmlvideo/Content.qml}{Content} item creates either a
\l{MediaPlayer} or a \l{Camera} item.
\section1 Calculating and displaying QML painting rate
-\input examples/video-qml-paint-rate.qdocinc
+\input video-qml-paint-rate.qdocinc
All that remains is to connect the afterRendering() signal of the QQuickView
object to a JavaScript function, which will eventually call frequencyItem.notify():
-\quotefromfile video/qmlvideo/main.cpp
+\quotefromfile multimedia/video/qmlvideo/main.cpp
\skipto QmlApplicationViewer
\printuntil ;
\dots
diff --git a/examples/multimedia/video/doc/src/qmlvideofx.qdoc b/examples/multimedia/video/doc/src/qmlvideofx.qdoc
index f9b324087..b6535a952 100644
--- a/examples/multimedia/video/doc/src/qmlvideofx.qdoc
+++ b/examples/multimedia/video/doc/src/qmlvideofx.qdoc
@@ -26,10 +26,9 @@
****************************************************************************/
/*!
-\example video/qmlvideofx
+\example multimedia/video/qmlvideofx
\title QML Video Shader Effects Example
-\ingroup video_examples_qml
-\ingroup camera_examples_qml
+\ingroup multimedia_examples
\brief The QML Video Shader Effects Example shows how \l {ShaderEffect}
can be used to apply postprocessing effects, expressed in \c GLSL, to video
@@ -135,10 +134,10 @@ types is a bit more complicated, for the following reasons:
\endlist
The abstraction of source item type is achieved by the
-\l{video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content}, which uses a
+\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content}, which uses a
\l{Loader} to create either a \l{MediaPlayer}, \l{Camera} or \l{Image}:
-\quotefromfile video/qmlvideofx/qml/qmlvideofx/Content.qml
+\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml
\skipto import
\printuntil {
\dots
@@ -165,10 +164,10 @@ The abstraction of source item type is achieved by the
\printuntil }
Each effect is implemented as a QML item which is based on the
-\l{video/qmlvideofx/qml/qmlvideofx/Effect.qml}{Effect}, which in turn
+\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml}{Effect}, which in turn
is based on the \l{ShaderEffect}:
-\quotefromfile video/qmlvideofx/qml/qmlvideofx/Effect.qml
+\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml
\skipto import
\printuntil /^\}/
@@ -180,20 +179,20 @@ implementation of the pixelation effect. As you can see, the pixelation effect
supports one parameter (which controls the pixelation granularity), and states
that the divider should be displayed.
-\quotefromfile video/qmlvideofx/qml/qmlvideofx/EffectPixelate.qml
+\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/EffectPixelate.qml
\skipto import
\printuntil /^\}/
The main.qml file shows a
-\l{video/qmlvideofx/qml/qmlvideofx/FileOpen.qml}{FileOpen}, which allows
+\l{multimedia/video/qmlvideofx/qml/qmlvideofx/FileOpen.qml}{FileOpen}, which allows
the user to select the input source and an
-\l{video/qmlvideofx/qml/qmlvideofx/EffectSelectionPanel.qml}{EffectSelectionPanel}
+\l{multimedia/video/qmlvideofx/qml/qmlvideofx/EffectSelectionPanel.qml}{EffectSelectionPanel}
item, which lists each of the available shader effects. As described above, a
-\l{video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content} item is used to load the
+\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content} item is used to load the
appropriate input and effect type. A
-\l{video/qmlvideofx/qml/qmlvideofx/Divider.qml}{Divider} item draws the
+\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Divider.qml}{Divider} item draws the
vertical dividing line, which can be dragged left / right by the user. Finally,
-a \l{video/qmlvideofx/qml/qmlvideofx/ParameterPanel.qml}{ParameterPanel} item
+a \l{multimedia/video/qmlvideofx/qml/qmlvideofx/ParameterPanel.qml}{ParameterPanel} item
renders the sliders corresponding to each effect parameter.
Here is the source selection menu:
@@ -204,12 +203,12 @@ And here is the effect selection menu:
\section1 Calculating and displaying QML painting rate
-\input examples/video-qml-paint-rate.qdocinc
+\input video-qml-paint-rate.qdocinc
All that remains is to connect the afterRendering() signal of the QQuickView
object to a JavaScript function, which will eventually call frequencyItem.notify():
-\quotefromfile video/qmlvideofx/main.cpp
+\quotefromfile multimedia/video/qmlvideofx/main.cpp
\skipto QmlApplicationViewer
\printuntil ;
\dots
diff --git a/examples/multimediawidgets/camera/doc/src/camera.qdoc b/examples/multimediawidgets/camera/doc/src/camera.qdoc
index c40c25135..15bf9fddf 100644
--- a/examples/multimediawidgets/camera/doc/src/camera.qdoc
+++ b/examples/multimediawidgets/camera/doc/src/camera.qdoc
@@ -29,14 +29,12 @@
/*!
-\example camera
+\example multimediawidgets/camera
\title Camera Example
-\ingroup camera_examples
+\ingroup multimedia_examples
\brief The Camera Example shows how to use the API to capture a still image
or video.
-
-
The Camera Example demonstrates how you can use QtMultimedia to implement
some basic Camera functionality to take still images and record video clips
with audio.
diff --git a/examples/multimediawidgets/declarative-camera/doc/src/declarative-camera.qdoc b/examples/multimediawidgets/declarative-camera/doc/src/declarative-camera.qdoc
index 37f35ea26..c98688b00 100644
--- a/examples/multimediawidgets/declarative-camera/doc/src/declarative-camera.qdoc
+++ b/examples/multimediawidgets/declarative-camera/doc/src/declarative-camera.qdoc
@@ -26,10 +26,9 @@
****************************************************************************/
/*!
-\example declarative-camera
+\example multimediawidgets/declarative-camera
\title QML Camera Example
-\ingroup camera_examples_qml
-
+\ingroup multimedia_examples
\brief The Camera Example shows how to use the API to capture a still image
or video.
diff --git a/examples/multimediawidgets/player/doc/src/player.qdoc b/examples/multimediawidgets/player/doc/src/player.qdoc
index 5e98b912c..5522425c7 100644
--- a/examples/multimediawidgets/player/doc/src/player.qdoc
+++ b/examples/multimediawidgets/player/doc/src/player.qdoc
@@ -26,10 +26,10 @@
****************************************************************************/
/*!
- \example player
+ \example multimediawidgets/player
\title Media Player Example
- \ingroup video_examples
-
+ \ingroup multimedia_examples
+ \brief Demonstrates the audio and video playback functionality
This example creates a simple multimedia player. We can play audio and
or video files using various codecs.
diff --git a/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc b/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc
index c1eb0ccc7..6deca4ce6 100644
--- a/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc
+++ b/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc
@@ -26,9 +26,9 @@
****************************************************************************/
/*!
-\example videographicsitem
+\example multimediawidgets/videographicsitem
\title Video Graphics Item Example
-\ingroup video_examples
+\ingroup multimedia_examples
\brief This example demonstrates how to stream video on a graphics scene.
The Video Graphics Item example shows how to implement a QGraphicsItem that displays video on a
diff --git a/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc b/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc
index 860cb7ac5..9a95f0ca5 100644
--- a/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc
+++ b/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc
@@ -26,9 +26,9 @@
****************************************************************************/
/*!
- \example videowidget
+ \example multimediawidgets/videowidget
\title Video Widget Example
- \ingroup video_examples
+ \ingroup multimedia_examples
\brief This example is a simple video player
The Video Widget example denonstrates how to implement a video widget using
diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf
index a6c9576b7..08a628902 100644
--- a/src/multimedia/doc/qtmultimedia.qdocconf
+++ b/src/multimedia/doc/qtmultimedia.qdocconf
@@ -30,6 +30,7 @@ qhp.qtmultimedia.subprojects.qmltypes.selectors = class fake:headerfile
qhp.qtmultimedia.subprojects.qmltypes.sortPages = true
exampledirs += ../../../examples \
+ snippets
headerdirs += ../..
diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/audio.cpp b/src/multimedia/doc/snippets/multimedia-snippets/audio.cpp
similarity index 100%
rename from src/multimedia/doc/src/snippets/multimedia-snippets/audio.cpp
rename to src/multimedia/doc/snippets/multimedia-snippets/audio.cpp
diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/audiorecorder.cpp b/src/multimedia/doc/snippets/multimedia-snippets/audiorecorder.cpp
similarity index 100%
rename from src/multimedia/doc/src/snippets/multimedia-snippets/audiorecorder.cpp
rename to src/multimedia/doc/snippets/multimedia-snippets/audiorecorder.cpp
diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/camera.cpp b/src/multimedia/doc/snippets/multimedia-snippets/camera.cpp
similarity index 100%
rename from src/multimedia/doc/src/snippets/multimedia-snippets/camera.cpp
rename to src/multimedia/doc/snippets/multimedia-snippets/camera.cpp
diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/media.cpp b/src/multimedia/doc/snippets/multimedia-snippets/media.cpp
similarity index 100%
rename from src/multimedia/doc/src/snippets/multimedia-snippets/media.cpp
rename to src/multimedia/doc/snippets/multimedia-snippets/media.cpp
diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/multimedia-snippets.pro b/src/multimedia/doc/snippets/multimedia-snippets/multimedia-snippets.pro
similarity index 100%
rename from src/multimedia/doc/src/snippets/multimedia-snippets/multimedia-snippets.pro
rename to src/multimedia/doc/snippets/multimedia-snippets/multimedia-snippets.pro
diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/qsound.cpp b/src/multimedia/doc/snippets/multimedia-snippets/qsound.cpp
similarity index 100%
rename from src/multimedia/doc/src/snippets/multimedia-snippets/qsound.cpp
rename to src/multimedia/doc/snippets/multimedia-snippets/qsound.cpp
diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/soundeffect.qml b/src/multimedia/doc/snippets/multimedia-snippets/soundeffect.qml
similarity index 100%
rename from src/multimedia/doc/src/snippets/multimedia-snippets/soundeffect.qml
rename to src/multimedia/doc/snippets/multimedia-snippets/soundeffect.qml
diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/video.cpp b/src/multimedia/doc/snippets/multimedia-snippets/video.cpp
similarity index 100%
rename from src/multimedia/doc/src/snippets/multimedia-snippets/video.cpp
rename to src/multimedia/doc/snippets/multimedia-snippets/video.cpp
diff --git a/src/multimedia/doc/src/snippets/snippets.pro b/src/multimedia/doc/snippets/snippets.pro
similarity index 100%
rename from src/multimedia/doc/src/snippets/snippets.pro
rename to src/multimedia/doc/snippets/snippets.pro
diff --git a/src/multimedia/doc/src/audiooverview.qdoc b/src/multimedia/doc/src/audiooverview.qdoc
index 723afb71b..20c5342e8 100644
--- a/src/multimedia/doc/src/audiooverview.qdoc
+++ b/src/multimedia/doc/src/audiooverview.qdoc
@@ -50,16 +50,16 @@ may have installed.
Here is how you play a local file using C++:
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Local playback
+ \snippet multimedia-snippets/media.cpp Local playback
You can also put files (even remote URLs) into a playlist:
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Audio playlist
+ \snippet multimedia-snippets/media.cpp Audio playlist
\section2 Recording Audio to a File
For recording audio to a file, the \l {QAudioRecorder} class allows you
to compress audio data from an input device and record it.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Audio recorder
+ \snippet multimedia-snippets/media.cpp Audio recorder
\section2 Low Latency Sound Effects
@@ -87,7 +87,7 @@ they may arrive at a slightly different time than the media pipeline
processes them.
Here's an example of installing a probe during recording:
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Audio probe
+ \snippet multimedia-snippets/media.cpp Audio probe
\section2 Low Level Audio Playback and Recording
Qt Multimedia offers classes for raw access to audio input and output
@@ -123,7 +123,7 @@ or from a QIODevice instances.
Here's an example of decoding a local file:
- \snippet doc/src/snippets/multimedia-snippets/audio.cpp Local audio decoding
+ \snippet multimedia-snippets/audio.cpp Local audio decoding
Note: This API is preliminary at this time - the API may change or be
removed before the final 5.0 release.
diff --git a/src/multimedia/doc/src/cameraoverview.qdoc b/src/multimedia/doc/src/cameraoverview.qdoc
index f6bf4f533..40c82a69a 100644
--- a/src/multimedia/doc/src/cameraoverview.qdoc
+++ b/src/multimedia/doc/src/cameraoverview.qdoc
@@ -118,14 +118,14 @@ In C++, your choice depends on whether you are using widgets, or QGraphicsView.
The \l QVideoWidget class is used in the widgets case, and \l QGraphicsVideoItem
is useful for QGraphicsView.
- \snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera overview viewfinder
+ \snippet multimedia-snippets/camera.cpp Camera overview viewfinder
For advanced usage (like processing viewfinder frames as they come, to detect
objects or patterns), you can also derive from \l QAbstractVideoSurface and
set that as the viewfinder for the QCamera object. In this case you will
need to render the viewfinder image yourself.
- \snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera overview surface
+ \snippet multimedia-snippets/camera.cpp Camera overview surface
\section2 Still Images
@@ -136,7 +136,7 @@ that things are in focus and the settings are not different from the
viewfinder while the image capture occurs, capture the image, and
finally unlock the camera ready for the next photo.
- \snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera overview capture
+ \snippet multimedia-snippets/camera.cpp Camera overview capture
\section2 Movies
@@ -146,7 +146,7 @@ video requires the use of a \l QMediaRecorder object.
To record video we need to create a camera object as before but this time as
well as creating a viewfinder, we will also initialize a media recorder object.
- \snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera overview movie
+ \snippet multimedia-snippets/camera.cpp Camera overview movie
Signals from the \e mediaRecorder can be connected to slots to react to
changes in the state of the recorder or error events. Recording itself
diff --git a/src/multimedia/doc/src/qtmultimedia-examples.qdoc b/src/multimedia/doc/src/qtmultimedia-examples.qdoc
new file mode 100644
index 000000000..4427e16f3
--- /dev/null
+++ b/src/multimedia/doc/src/qtmultimedia-examples.qdoc
@@ -0,0 +1,37 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \group multimedia_examples
+ \ingroup all-examples
+ \title Qt Multimedia Examples
+ \brief Demonstrates the multimedia functionality provided by Qt.
+
+ The \l{Qt Multimedia} module provides low-level audio support on Linux,
+ Windows and Mac OS X. It also provides audio plugin API to allow developers
+ implement their own audio support for custom devices and platforms.
+*/
diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc
index dcf438d51..e7838cfd8 100644
--- a/src/multimedia/doc/src/qtmultimedia-index.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc
@@ -128,23 +128,6 @@
\section2 Examples
\list
- \li QML
- \list
- \li \l{video/qmlvideo}{qmlvideo}
- \li \l{video/qmlvideofx}{qmlvideofx}
- \li \l{declarative-camera}
- \li \l{declarative-radio}
- \endlist
- \li C++
- \list
- \li \l{audiooutput}
- \li \l{audioinput}
- \li \l{audiorecorder}
- \li \l{audiodevices}
- \li \l{spectrum}
- \li \l{AudioEngine Example}{Audio Engine}
- \li \l{player}
- \li \l{Camera Example}
- \endlist
+ \li \l{Qt Multimedia Examples}
\endlist
*/
diff --git a/src/multimedia/doc/src/videooverview.qdoc b/src/multimedia/doc/src/videooverview.qdoc
index f0d8de05b..45ea87f09 100644
--- a/src/multimedia/doc/src/videooverview.qdoc
+++ b/src/multimedia/doc/src/videooverview.qdoc
@@ -47,10 +47,10 @@ You can use the \l QMediaPlayer class to decode a video file, and display
it using \l QVideoWidget, \l QGraphicsVideoItem, or a custom class.
Here's an example of using QVideoWidget:
- \snippet doc/src/snippets/multimedia-snippets/video.cpp Video widget
+ \snippet multimedia-snippets/video.cpp Video widget
And an example with QGraphicsVideoItem:
- \snippet doc/src/snippets/multimedia-snippets/video.cpp Video graphics item
+ \snippet multimedia-snippets/video.cpp Video graphics item
\section2 Playing Video in QML
@@ -77,12 +77,12 @@ processing, while deriving a class from \l QAbstractVideoSurface
allows you to receive these frames from \l QMediaPlayer and
\l QCamera.
-\snippet doc/src/snippets/multimedia-snippets/video.cpp Derived Surface
+\snippet multimedia-snippets/video.cpp Derived Surface
and with an instance of this surface, \c myVideoSurface, you can set
the surface as the \l {QMediaPlayer::setVideoOutput()}{video output} for QMediaPlayer.
-\snippet doc/src/snippets/multimedia-snippets/video.cpp Setting surface in player
+\snippet multimedia-snippets/video.cpp Setting surface in player
Several of the built-in Qt classes offer this functionality
as well, so if you decode video in your application, you can present
@@ -97,7 +97,7 @@ The following snippet shows a class that has a writable \c videoSurface property
and receives frames through a public slot \c onNewVideoContentReceived(). These
frames are then presented on the surface set in \c setVideoSurface().
-\snippet doc/src/snippets/multimedia-snippets/video.cpp Video producer
+\snippet multimedia-snippets/video.cpp Video producer
\section2 Recording Video
You can use the \l QMediaRecorder class in conjunction with other
@@ -116,7 +116,7 @@ the video frames using this class, and they may arrive at a slightly
different time than they are being rendered.
Here's an example of installing a video probe while recording the camera:
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Video probe
+ \snippet multimedia-snippets/media.cpp Video probe
\section1 Examples
diff --git a/src/multimedia/qmediacontrol.cpp b/src/multimedia/qmediacontrol.cpp
index 5933ce430..13a66813c 100644
--- a/src/multimedia/qmediacontrol.cpp
+++ b/src/multimedia/qmediacontrol.cpp
@@ -68,14 +68,14 @@ QT_BEGIN_NAMESPACE
the \l {QMediaService::requestControl()} member of QMediaService. If the
service doesn't implement a control it will instead return a null pointer.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Request control
+ \snippet multimedia-snippets/media.cpp Request control
Alternatively if the IId of the control has been declared using
Q_MEDIA_DECLARE_CONTROL the template version of
QMediaService::requestControl() can be used to request the service without
explicitly passing the IId or using qobject_cast().
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Request control templated
+ \snippet multimedia-snippets/media.cpp Request control templated
Most application code will not interface directly with a media service's
controls, instead the QMediaObject which owns the service acts as an
@@ -95,7 +95,7 @@ QT_BEGIN_NAMESPACE
be requested from QMediaService::requestControl() without explicitly
passing the IId.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Request control templated
+ \snippet multimedia-snippets/media.cpp Request control templated
\sa QMediaService::requestControl()
*/
diff --git a/src/multimedia/qmediaservice.cpp b/src/multimedia/qmediaservice.cpp
index c21e1df5a..6e68e9d0a 100644
--- a/src/multimedia/qmediaservice.cpp
+++ b/src/multimedia/qmediaservice.cpp
@@ -71,7 +71,7 @@ QT_BEGIN_NAMESPACE
A pointer to media service's QMediaControl implementation can be obtained
by passing the control's interface name to the requestControl() function.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Request control
+ \snippet multimedia-snippets/media.cpp Request control
Media objects can use services loaded dynamically from plug-ins or
implemented statically within an applications. Plug-in based services
diff --git a/src/multimedia/radio/qradiodata.cpp b/src/multimedia/radio/qradiodata.cpp
index f6d380826..569224896 100644
--- a/src/multimedia/radio/qradiodata.cpp
+++ b/src/multimedia/radio/qradiodata.cpp
@@ -78,7 +78,7 @@ namespace
You can get a QRadioData instance fromt the \l{QRadioTuner::radioData()}{radioData}
property from a QRadioTuner instance.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Radio data setup
+ \snippet multimedia-snippets/media.cpp Radio data setup
Alternatively, you can pass an instance of QRadioTuner to the constructor to QRadioData.
diff --git a/src/multimedia/radio/qradiotuner.cpp b/src/multimedia/radio/qradiotuner.cpp
index d9d9cb6bf..a0cbb5857 100644
--- a/src/multimedia/radio/qradiotuner.cpp
+++ b/src/multimedia/radio/qradiotuner.cpp
@@ -79,7 +79,7 @@ namespace
You can control the systems analog radio device using this interface, for example:
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Radio tuner
+ \snippet multimedia-snippets/media.cpp Radio tuner
The radio object will emit signals for any changes in state such as:
bandChanged(), frequencyChanged(), stereoStatusChanged(), searchingChanged(),
diff --git a/src/multimedia/recording/qaudiorecorder.cpp b/src/multimedia/recording/qaudiorecorder.cpp
index 25225e5ed..71fd219c9 100644
--- a/src/multimedia/recording/qaudiorecorder.cpp
+++ b/src/multimedia/recording/qaudiorecorder.cpp
@@ -66,11 +66,11 @@ QT_BEGIN_NAMESPACE
The QAudioRecorder class is a high level media recording class and contains
the same functionality as \l QMediaRecorder.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Audio recorder
+ \snippet multimedia-snippets/media.cpp Audio recorder
In addition QAudioRecorder provides functionality for selecting the audio input.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Audio recorder inputs
+ \snippet multimedia-snippets/media.cpp Audio recorder inputs
The \l {audiorecorder}{Audio Recorder} example shows how to use this class
in more detail.
diff --git a/src/multimedia/recording/qmediaencodersettings.cpp b/src/multimedia/recording/qmediaencodersettings.cpp
index 8f8287f4c..1c0f53231 100644
--- a/src/multimedia/recording/qmediaencodersettings.cpp
+++ b/src/multimedia/recording/qmediaencodersettings.cpp
@@ -111,7 +111,7 @@ private:
and then passing it to a QMediaRecorder instance using the
QMediaRecorder::setEncodingSettings() function.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Audio encoder settings
+ \snippet multimedia-snippets/media.cpp Audio encoder settings
\sa QMediaRecorder, QAudioEncoderSettingsControl
*/
@@ -425,7 +425,7 @@ private:
and then passing it to a QMediaRecorder instance using the
QMediaRecorder::setEncodingSettings() function.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Video encoder settings
+ \snippet multimedia-snippets/media.cpp Video encoder settings
\sa QMediaRecorder, QVideoEncoderSettingsControl
*/
@@ -751,7 +751,7 @@ private:
properties and then passing it to a QCameraImageCapture instance using the
QCameraImageCapture::setImageSettings() function.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Image encoder settings
+ \snippet multimedia-snippets/media.cpp Image encoder settings
\sa QImageEncoderControl
*/
diff --git a/src/multimedia/recording/qmediarecorder.cpp b/src/multimedia/recording/qmediarecorder.cpp
index dd303a12b..79d70e442 100644
--- a/src/multimedia/recording/qmediarecorder.cpp
+++ b/src/multimedia/recording/qmediarecorder.cpp
@@ -75,7 +75,7 @@ QT_BEGIN_NAMESPACE
intended to be used alone but for accessing the media recording functions
of other media objects, like QRadioTuner, or QCamera.
- \snippet doc/src/snippets/multimedia-snippets/media.cpp Media recorder
+ \snippet multimedia-snippets/media.cpp Media recorder
\sa QAudioRecorder
*/
--
GitLab