summaryrefslogtreecommitdiffstats
path: root/src/multimedia/doc
diff options
context:
space:
mode:
authorNicholas Bennett <nicholas.bennett@qt.io>2021-08-17 13:27:06 +0300
committerNicholas Bennett <nicholas.bennett@qt.io>2021-08-18 15:43:06 +0300
commit09d93c958909ea5e4b76a1d45854a6f15f5c63ef (patch)
tree684c54f3a008fdf9ab5ca932832f90bbcddcfb6b /src/multimedia/doc
parent4ad32a9ad56434622778a355f71551437d347ec7 (diff)
Doc Update: Cmake Information
Remove refrences to qmake Add refrences to cmake and list CMakeFiles additions required for Qt 6 Fix broken links for QAudioRecorder, as it has been removed from API. Remove QMediaPlaylist from Docs, add note to changes page. Task-number: QTBUG-94895 Pick-to: 6.2 Change-Id: Id052530f9a591feca0dee8e393d5d728987334d0 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/multimedia/doc')
-rw-r--r--src/multimedia/doc/src/multimedia-overview.qdoc2
-rw-r--r--src/multimedia/doc/src/qt6-changes.qdoc7
-rw-r--r--src/multimedia/doc/src/qtmultimedia-index.qdoc29
3 files changed, 19 insertions, 19 deletions
diff --git a/src/multimedia/doc/src/multimedia-overview.qdoc b/src/multimedia/doc/src/multimedia-overview.qdoc
index ddeb93344..ed002fbc3 100644
--- a/src/multimedia/doc/src/multimedia-overview.qdoc
+++ b/src/multimedia/doc/src/multimedia-overview.qdoc
@@ -110,7 +110,7 @@ For some quick recipes, see this table:
\li Recording encoded audio data
\li \l{Audio Recorder Example}{audiorecorder}
\li
- \li QAudioRecorder
+ \li QMediaCaptureSession
\row
\li Discovering raw audio devices
\li \l{Audio Devices Example}{audiodevices}
diff --git a/src/multimedia/doc/src/qt6-changes.qdoc b/src/multimedia/doc/src/qt6-changes.qdoc
index b7258c8b7..1a9a9530b 100644
--- a/src/multimedia/doc/src/qt6-changes.qdoc
+++ b/src/multimedia/doc/src/qt6-changes.qdoc
@@ -68,9 +68,10 @@ There are a number of new features in Qt Multimedia:
\row
\li Playlist in QMediaPlayer
\li QMediaPlayer does not do any playlist handling anymore in Qt 6.
- The QMediaPlayList class does however still exist and provides this
- functionality. Users will need to connect the playlist to the mediaplayer
- themselves to handle playlists.
+ \row
+ \li QMediaPlayList
+ \li This class has been removed from the API. It does however still exist
+ as part of the \l{Media Player Example}.
\row
\li QAudioProbe and QVideoProbe
\li The audio and video probing API has been removed.
diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc
index 39713ae8a..aab7db7ee 100644
--- a/src/multimedia/doc/src/qtmultimedia-index.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc
@@ -52,7 +52,7 @@
\table
\row
- \li \l{QtMultimedia}{Qt Multimedia}
+ \li \l{Multimedia Overview}{Qt Multimedia}
\li Provides API for multimedia-specific use cases.
\row
\li \l{Qt Multimedia Widgets}
@@ -81,11 +81,13 @@
\note If you are using a few classes from this module, we recommend
including those specific classes only instead of the module.
- To link against the corresponding C++ libraries, add the following to your
- \c {qmake} project file:
+ To link against the C++ libraries, add the following to your project's
+ \c CMakeLists.txt file. Substitute \c my_project with the name of your
+ project.
\code
- QT += multimedia multimediawidgets
+ find_package(Qt6 COMPONENTS Multimedia REQUIRED)
+ target_link_libraries(my_project PUBLIC Qt::Multimedia)
\endcode
\section1 QML Types
@@ -121,27 +123,24 @@
\li Description
\row
\li QAudioSink
- \li Sends audio data to an audio output device
+ \li Sends audio data to an audio output device.
\row
- \li \l QAudioRecorder
- \li Record media content from an audio source.
+ \li QMediaCaptureSession
+ \li Allows capturing of audio and video.
\row
- \li \l QCamera
- \li Access camera preview
+ \li QCamera
+ \li Access camera features.
\row
\li QImageCapture
\li Capture still images with a camera.
\row
- \li \l QMediaRecorder
+ \li QMediaRecorder
\li Record media content from a camera source.
\row
- \li \l QMediaPlayer
+ \li QMediaPlayer
\li Playback media from a source.
\row
- \li \l QMediaPlaylist
- \li List of media to be played.
- \row
- \li \l QVideoSink
+ \li QVideoSink
\li Class for video presentation.
\endtable