diff options
author | Lars Knoll <lars.knoll@qt.io> | 2021-09-17 12:55:03 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-09-20 17:29:15 +0000 |
commit | 87143a294566ca12331d15d8afb0423462be7047 (patch) | |
tree | 34ae611c23bc2c5229fb33a2b96b463233fee45f /examples | |
parent | f01259068ee35f76fd641dadcd358c28b752a88c (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.
Change-Id: I79177b7f398c418ab3ba723e9ff2cd5ef3de1cf6
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
(cherry picked from commit d750ae98cd3b13d96eb9865a1eb0ec328278de14)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'examples')
-rw-r--r-- | examples/multimedia/video/mediaplayer/doc/images/qmlmediaplayer.jpg | bin | 0 -> 152556 bytes | |||
-rw-r--r-- | examples/multimedia/video/mediaplayer/doc/src/mediaplayer.qdoc | 48 | ||||
-rw-r--r-- | examples/multimedia/video/recorder/doc/images/qmlrecorder.jpg | bin | 0 -> 132255 bytes | |||
-rw-r--r-- | examples/multimedia/video/recorder/doc/src/recorder.qdoc | 46 | ||||
-rw-r--r-- | examples/multimediawidgets/camera/doc/src/camera.qdoc | 3 | ||||
-rw-r--r-- | examples/multimediawidgets/player/doc/src/player.qdoc | 3 |
6 files changed, 98 insertions, 2 deletions
diff --git a/examples/multimedia/video/mediaplayer/doc/images/qmlmediaplayer.jpg b/examples/multimedia/video/mediaplayer/doc/images/qmlmediaplayer.jpg Binary files differnew file mode 100644 index 000000000..ee79c07b3 --- /dev/null +++ b/examples/multimedia/video/mediaplayer/doc/images/qmlmediaplayer.jpg 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. +*/ diff --git a/examples/multimedia/video/recorder/doc/images/qmlrecorder.jpg b/examples/multimedia/video/recorder/doc/images/qmlrecorder.jpg Binary files differnew file mode 100644 index 000000000..b690d1023 --- /dev/null +++ b/examples/multimedia/video/recorder/doc/images/qmlrecorder.jpg diff --git a/examples/multimedia/video/recorder/doc/src/recorder.qdoc b/examples/multimedia/video/recorder/doc/src/recorder.qdoc new file mode 100644 index 000000000..9ced09e74 --- /dev/null +++ b/examples/multimedia/video/recorder/doc/src/recorder.qdoc @@ -0,0 +1,46 @@ +/**************************************************************************** +** +** 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/recorder + \title QML Recorder Example + \ingroup multimedia_examples + \ingroup video_examples_qml + \ingroup camera_examples_qml + \brief Recording audio and video using Qt Quick. + \meta {tag} {quick} + + \image qmlrecorder.jpg + + \e{QML Recorder} demonstrates a simple application that can record + audio and or video files using the camera and microphone. + + \include examples-run.qdocinc + + The example uses the QML Camera and AudioInput objects connected to a MediaCaptureSession. + A MediaRecorder object is then used to record the captured audio and video. +*/ diff --git a/examples/multimediawidgets/camera/doc/src/camera.qdoc b/examples/multimediawidgets/camera/doc/src/camera.qdoc index b8b9730d2..1378e1e87 100644 --- a/examples/multimediawidgets/camera/doc/src/camera.qdoc +++ b/examples/multimediawidgets/camera/doc/src/camera.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2015 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: http://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -29,6 +29,7 @@ \example multimediawidgets/camera \title Camera Example \ingroup multimedia_examples +\ingroup video_examples \ingroup camera_examples \meta {tag} {widgets} \brief Shows how to capture a still image or record video. diff --git a/examples/multimediawidgets/player/doc/src/player.qdoc b/examples/multimediawidgets/player/doc/src/player.qdoc index 9cdc84b07..dad969375 100644 --- a/examples/multimediawidgets/player/doc/src/player.qdoc +++ b/examples/multimediawidgets/player/doc/src/player.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2015 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: http://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -29,6 +29,7 @@ \example multimediawidgets/player \title Media Player Example \ingroup multimedia_examples + \ingroup video_examples \brief Playing audio and video. \meta {tag} {widgets} |