summaryrefslogtreecommitdiffstats
path: root/examples/multimedia/video/mediaplayer
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@qt.io>2021-09-17 12:55:03 +0200
committerLars Knoll <lars.knoll@qt.io>2021-09-20 18:40:10 +0200
commitd750ae98cd3b13d96eb9865a1eb0ec328278de14 (patch)
tree66b1c9aee507b09469c77ef7f1673a8b00655bb5 /examples/multimedia/video/mediaplayer
parent7e2ae885f6292b3b2623797e51de89bed11ce57a (diff)
Add some basic docs for the media player and recorder examples
Hook up those examples in the correct places, remove a stale link to the qmlvideofx example and fix the highlighted examples list to include four examples, showing playback and capture for both C++ and QML. Pick-to: 6.2 6.2.0 Change-Id: I79177b7f398c418ab3ba723e9ff2cd5ef3de1cf6 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
Diffstat (limited to 'examples/multimedia/video/mediaplayer')
-rw-r--r--examples/multimedia/video/mediaplayer/doc/images/qmlmediaplayer.jpgbin0 -> 152556 bytes
-rw-r--r--examples/multimedia/video/mediaplayer/doc/src/mediaplayer.qdoc48
2 files changed, 48 insertions, 0 deletions
diff --git a/examples/multimedia/video/mediaplayer/doc/images/qmlmediaplayer.jpg b/examples/multimedia/video/mediaplayer/doc/images/qmlmediaplayer.jpg
new file mode 100644
index 000000000..ee79c07b3
--- /dev/null
+++ b/examples/multimedia/video/mediaplayer/doc/images/qmlmediaplayer.jpg
Binary files differ
diff --git a/examples/multimedia/video/mediaplayer/doc/src/mediaplayer.qdoc b/examples/multimedia/video/mediaplayer/doc/src/mediaplayer.qdoc
new file mode 100644
index 000000000..6afae93f3
--- /dev/null
+++ b/examples/multimedia/video/mediaplayer/doc/src/mediaplayer.qdoc
@@ -0,0 +1,48 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \example multimedia/video/mediaplayer
+ \title QML Media Player Example
+ \ingroup multimedia_examples
+ \ingroup video_examples_qml
+ \brief Playing audio and video using Qt Quick.
+ \meta {tag} {quick}
+
+ \image qmlmediaplayer.jpg
+
+ \e{QML Media Player} demonstrates a simple multimedia player that can play
+ audio and or video files using various codecs.
+
+ \include examples-run.qdocinc
+
+ The example uses the QML MediaPlayer object connected to a VideoOutput to
+ play back the video.
+
+ The example shows usage of some advanced features such as selection of audio
+ or subtitle tracks.
+*/