summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@qt.io>2021-09-20 14:46:52 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-09-21 17:43:05 +0000
commit707dc7e274081f8c6be44bd74c8320e4384e4296 (patch)
tree803b3131fb3733233b8a560d4ebf5dcf3532e2c6
parent304f4f7f3f645ef076995e81ee0af2163b8ba6f2 (diff)
Mention more of the central QML and C++ types in the overview docs
List the classes/types that people would commonly use when doing playback or recording. Change-Id: I5ad55679ffda77829437bfc6b35c84fbd9659ad4 Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> Reviewed-by: Piotr Srebrny <piotr.srebrny@qt.io> (cherry picked from commit 24d4d12bde050fab738da5ce2dd5024613c6a9fd) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/multimedia/doc/src/qtmultimedia-index.qdoc53
1 files changed, 40 insertions, 13 deletions
diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc
index 13f055933..5461d82b5 100644
--- a/src/multimedia/doc/src/qtmultimedia-index.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc
@@ -101,14 +101,32 @@
\li Type
\li Description
\row
+ \li \l{MediaPlayer}
+ \li Add audio/video playback functionality to a scene.
+ \row
+ \li \l {QtMultimedia::CaptureSession}{CaptureSession}
+ \li Create a session for capturing audio/video.
+ \row
\li \l {QtMultimedia::Camera}{Camera}
- \li Access camera viewfinder frames
+ \li Access a camera connected to the system.
+ \row
+ \li \l {QtMultimedia::AudioInput}{AudioInput}
+ \li Access an audio input (microphone) connected to the system.
+ \row
+ \li \l {QtMultimedia::AudioOutput}{AudioOutput}
+ \li Access an audio output (speaker, headphone) connected to the system.
+ \row
+ \li \l {QtMultimedia::VideoOutput}{VideoOutput}
+ \li Display video content.
\row
- \li MediaPlayer
- \li Add audio and/or video playback functionality to a scene.
+ \li \l {QtMultimedia::MediaRecorder}{MediaRecorder}
+ \li Record audio/video from the CaptureSession.
+ \row
+ \li \l {QtMultimedia::ImageCapture}{ImageCapture}
+ \li Capture still images from the Camera.
\row
\li \l {QtMultimedia::Video}{Video}
- \li Add Video playback functionality to a scene. It uses MediaPlayer and
+ \li Add Video playback functionality to a scene. Uses MediaPlayer and
VideoOutput types to provide video playback functionality.
\endtable
@@ -121,26 +139,35 @@
\li Class
\li Description
\row
- \li QAudioSink
- \li Sends audio data to an audio output device.
+ \li QMediaPlayer
+ \li Playback media from a source.
+ \row
+ \li QVideoWidget
+ \li Display video from a media player or a capture session.
\row
\li QMediaCaptureSession
- \li Allows capturing of audio and video.
+ \li Capture audio and video.
\row
\li QCamera
- \li Access camera features.
+ \li Access a camera connected to the system
+ \row
+ \li QAudioInput
+ \li Access an audio input (microphone) connected to the system.
+ \row
+ \li QAudioOutput
+ \li Access an audio output (speaker, headphone) connected to the system.
\row
\li QImageCapture
\li Capture still images with a camera.
\row
\li QMediaRecorder
- \li Record media content from a camera source.
- \row
- \li QMediaPlayer
- \li Playback media from a source.
+ \li Record media content from a capture session.
\row
\li QVideoSink
- \li Class for video presentation.
+ \li Access and render individual video frames.
+ \row
+ \li QAudioSink
+ \li Sends raw audio data to an audio output device.
\endtable
For playback QMediaPlayer, QAudioOutput and QVideoOutput contain all the required functionality.