summaryrefslogtreecommitdiffstats
path: root/examples/multimedia
diff options
context:
space:
mode:
authorQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2019-04-20 03:00:39 +0200
committerQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2019-04-20 03:00:39 +0200
commitc013f294e64125e8d3b8da7b98238c3bbeca3830 (patch)
tree2e44c0388ee586023ea6bef3836aafff5eb93358 /examples/multimedia
parentb1a0bc9d454793d705a4aba84b301d3f8dfb50ea (diff)
parentd97d618a4884c2535ba787e774f0faa6bce82081 (diff)
Merge remote-tracking branch 'origin/5.13' into dev
Diffstat (limited to 'examples/multimedia')
-rw-r--r--examples/multimedia/video/doc/src/qmlvideo.qdoc54
-rw-r--r--examples/multimedia/video/doc/src/qmlvideofx.qdoc38
2 files changed, 39 insertions, 53 deletions
diff --git a/examples/multimedia/video/doc/src/qmlvideo.qdoc b/examples/multimedia/video/doc/src/qmlvideo.qdoc
index 736cffa88..b8ab25d03 100644
--- a/examples/multimedia/video/doc/src/qmlvideo.qdoc
+++ b/examples/multimedia/video/doc/src/qmlvideo.qdoc
@@ -50,16 +50,14 @@ which moves across the \l{VideoOutput} item.
\section1 Application Structure
-The \l{multimedia/video/qmlvideo/qml/qmlvideo/main.qml} file creates a UI which includes
-the following items:
+The \c main.qml file creates a UI which includes the following items:
\list
- \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{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 Two \c Button instances, each of which displays a filename, and can be
+ used to launch a \c FileBrowser.
+ \li An exit \c Button.
+ \li A \c 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
average over the past second.
@@ -69,17 +67,15 @@ 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{multimedia/video/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{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic} item ...
+in the center of the screen) is implemented in the \c VideoBasic.qml file. As
+you can see from the code, this makes use of a type of inheritance; a
+\c VideoBasic item ...
\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml
\skipto import
\printuntil /^\}/
-... is-a
-\l{multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} ...
+... is of type \c SceneBasic ...
\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml
\skipto import
@@ -91,8 +87,7 @@ can see from the code, this makes use of a type of inheritance: a
\skipto }
\printuntil /^\}/
-... which is-a
-\l{multimedia/video/qmlvideo/qml/qmlvideo/Scene.qml}{Scene}:
+... which itself is a \c Scene:
\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/Scene.qml
\skipto import
@@ -104,33 +99,28 @@ can see from the code, this makes use of a type of inheritance: a
\skipto Button
\printuntil /^\}/
-\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{multimedia/video/qmlvideo/qml/qmlvideo/Content.qml}{Content}.
+\c SceneBasic describes the structure and behavior of the scene, but is
+agnostic of the type of content which will be displayed - this is abstracted
+by \c 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{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic}) and camera content
-(\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{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.
+both video content (\c {VideoBasic}) and camera content \c ({CameraBasic}).
+This approach is used to implement many of the other scenes - for example,
+\e {"repeatedly slide the content from left to right and back again"} is
+implemented by \c SceneMove, on which \c VideoMove and \c CameraMove are based.
Depending on the value of the contentType property in the top-level scene
-instance, the embedded
-\l{multimedia/video/qmlvideo/qml/qmlvideo/Content.qml}{Content} item creates either a
-\l{MediaPlayer} or a \l{Camera} item.
+instance, the embedded \c Content item creates either a
+\l[QML]{MediaPlayer} or a \l[QML]{Camera} item.
\section1 Calculating and Displaying QML Painting Rate
\input multimedia/doc/src/examples/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():
+object to a JavaScript function, which will eventually call
+\c frequencyItem.notify():
\quotefromfile multimedia/video/qmlvideo/main.cpp
\skipto QGuiApplication
diff --git a/examples/multimedia/video/doc/src/qmlvideofx.qdoc b/examples/multimedia/video/doc/src/qmlvideofx.qdoc
index af01e4286..ca0a4af9d 100644
--- a/examples/multimedia/video/doc/src/qmlvideofx.qdoc
+++ b/examples/multimedia/video/doc/src/qmlvideofx.qdoc
@@ -64,13 +64,13 @@ This image shows a 'wobble' effect applied to the viewfinder.
The application includes many more effects than the ones shown here - look
for Effect*.qml files in the list of files below to see the full range.
-\section1 Application structure
+\section1 Application Structure
Shader effects can be applied to video or viewfinder content using
\l{ShaderEffect}, as shown in the following example, which applies
a wiggly effect to the content:
-\code
+\qml
import QtQuick 2.0
import QtMultimedia 5.0
@@ -109,7 +109,7 @@ Rectangle {
"
}
}
-\endcode
+\endqml
In this application, the usage of the \l{ShaderEffect} and \l{VideoOutput}
types is a bit more complicated, for the following reasons:
@@ -127,9 +127,9 @@ types is a bit more complicated, for the following reasons:
to uniform values passed into the GLSL code
\endlist
-The abstraction of source item type is achieved by the
-\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}:
+The abstraction of source item type is achieved by the \c Content, which uses a
+\l[QML]{Loader} to create either a \l[QML]{MediaPlayer}, \l[QML]{Camera}, or an
+\l[QML]{Image}:
\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml
\skipto import
@@ -157,9 +157,8 @@ The abstraction of source item type is achieved by the
\skipto /^\}/
\printuntil }
-Each effect is implemented as a QML item which is based on the
-\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml}{Effect}, which in turn
-is based on the \l{ShaderEffect}:
+Each effect is implemented as a QML item which is based on the \c Effect, which in
+turn is based on the \l[QML]{ShaderEffect}:
\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml
\skipto import
@@ -177,21 +176,18 @@ that the divider should be displayed.
\skipto import
\printuntil /^\}/
-The main.qml file shows a
-\l{multimedia/video/qmlvideofx/qml/qmlvideofx/FileOpen.qml}{FileOpen}, which allows
-the user to select the input source and an EffectSelectionPanel
+The main.qml file shows a \c FileOpen item, which allows
+the user to select the input source and an \c EffectSelectionList
item, which lists each of the available shader effects. As described above, a
-\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content} item is used to load the
-appropriate input and effect type. A
-\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{multimedia/video/qmlvideofx/qml/qmlvideofx/ParameterPanel.qml}{ParameterPanel} item
-renders the sliders corresponding to each effect parameter.
-
-Here is the effect selection menu:
+\c Content item is used to load the appropriate input and effect type. A
+\c Divider item draws the vertical dividing line, which can be dragged left or
+right by the user. Finally, a \c ParameterPanel item renders the sliders
+corresponding to each effect parameter.
+
\image qmlvideofx-effects-menu.jpg
+\caption The effect selection menu
-\section1 Calculating and displaying QML painting rate
+\section1 Calculating and Displaying QML Painting Rate
\input multimedia/doc/src/examples/video-qml-paint-rate.qdocinc