summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSamuel Mira <samuel.mira@qt.io>2021-08-31 16:12:26 +0300
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-09-06 08:18:54 +0000
commit259079d5b8772a09a784f49788cd31d3d49087ea (patch)
tree113630c1e29e16720a04e1c1d5c5ae2d43ddda1a
parent8899f7c2bf527ff50aa222c534b7e8dc595fe60d (diff)
Add qDoc comments for mediaplayer
After adding Q_PROPERTY to qmediaplayer.h, the qdoc should have been properly updated. Change-Id: I3540824264fbfda8318be8596de9a4b16de97980 Reviewed-by: Lars Knoll <lars.knoll@qt.io> (cherry picked from commit a35cf397e4653505ec8d3f8dc09c2a6a9d27c3cd) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/multimediaquick/mediaplayer.qdoc114
1 files changed, 96 insertions, 18 deletions
diff --git a/src/multimediaquick/mediaplayer.qdoc b/src/multimediaquick/mediaplayer.qdoc
index fabfb34d9..8360d5658 100644
--- a/src/multimediaquick/mediaplayer.qdoc
+++ b/src/multimediaquick/mediaplayer.qdoc
@@ -93,17 +93,27 @@
/*!
\since 5.15
- \qmlproperty url QtMultimedia::MediaPlayer::videoOutput
+ \qmlproperty QObject* QtMultimedia::MediaPlayer::videoOutput
This property holds the target video output.
- Accepts one, or an array of, VideoOutput elements.
+ Accepts one VideoOutput elements.
- \snippet multimedia-snippets/multiple-videooutputs.qml complete
+ \snippet multimedia-snippets/multiple-videooutputs.qml
\sa QMediaPlayer::setVideoOutput()
*/
/*!
+ \qmlproperty QAudioOutput* QtMultimedia::MediaPlayer::audioOutput
+
+ This property holds the target audio output.
+ Accepts one AudioOutput elements.
+
+
+ \sa QMediaPlayer::setAudioOutput()
+*/
+
+/*!
\qmlproperty enumeration QtMultimedia::MediaPlayer::availability
Returns the media player's state, which can be one of the following:
@@ -319,9 +329,11 @@
This property holds the current playback position in milliseconds.
- To change this position, use the \l seek() method.
+ If the \l seekable property is true, this property can be set to
+ milliseconds.
- \sa seek()
+ Setting the position may be asynchronous, so this may not be updated
+ immediately.
*/
/*!
@@ -385,23 +397,11 @@
This property holds whether position of the audio can be changed.
- If true, calling the \l seek() method will cause playback to seek to the new
+ If true, calling the \l setPosition() method will cause playback to seek to the new
position.
*/
/*!
- \qmlmethod QtMultimedia::MediaPlayer::seek(offset)
-
- If the \l seekable property is true, seeks the current
- playback position to \a offset.
-
- Seeking may be asynchronous, so the \l position property
- may not be updated immediately.
-
- \sa seekable, position
-*/
-
-/*!
\qmlproperty real QtMultimedia::MediaPlayer::playbackRate
This property holds the rate at which audio is played at as a multiple of
@@ -467,6 +467,84 @@
*/
/*!
+ \since 6.2
+ \qmlproperty int QtMultimedia::MediaPlayer::activeAudioTrack
+
+ This property holds the track number of the currently active audio track.
+ Set to \c{-1} to disable audio track.
+
+ The default property value is \c{0}: the first audio track.
+*/
+
+/*!
+ \since 6.2
+ \qmlproperty int QtMultimedia::MediaPlayer::activeVideoTrack
+
+ This property holds the track number of the currently active video audio track.
+ Set to \c{-1} to disable video track.
+
+ The default property value is \c{0}: the first video track.
+*/
+
+/*!
+ \since 6.2
+ \qmlproperty int QtMultimedia::MediaPlayer::activeSubtitleTrack
+
+ This property holds the track number of the currently active subtitle track.
+ Set to \c{-1} to disable subtitle track.
+
+ The default property value is \c{-1}: no subtitles active.
+*/
+
+/*!
+ \since 6.2
+ \qmlproperty QList<QMediaMetaData> QtMultimedia::MediaPlayer::audioTracks
+
+ This property holds a list of metadata.
+ Each index refers to a audio track.
+
+ The metadata holds 2 properties;
+ \list
+ \li \l{QtMultimedia::MediaPlayer::metaData.language}{Language}
+ \li \l{QtMultimedia::MediaPlayer::metaData.mediaType}{MimeType}
+ \endlist
+
+ \sa {MetaData}
+*/
+
+/*!
+ \since 6.2
+ \qmlproperty QList<QMediaMetaData> QtMultimedia::MediaPlayer::videoTracks
+
+ This property holds a list of metadata.
+ Each index refers to a video track.
+
+ The metadata holds 2 properties;
+ \list
+ \li \l{QtMultimedia::MediaPlayer::metaData.language}{Language}
+ \li \l{QtMultimedia::MediaPlayer::metaData.mediaType}{MimeType}
+ \endlist
+
+ \sa {MetaData}
+*/
+
+/*!
+ \since 6.2
+ \qmlproperty QList<QMediaMetaData> QtMultimedia::MediaPlayer::subtitleTracks
+
+ This property holds a list of metadata.
+ Each index refers to a subtitle track.
+
+ The metadata holds 2 properties;
+ \list
+ \li \l{QtMultimedia::MediaPlayer::metaData.language}{Language}
+ \li \l{QtMultimedia::MediaPlayer::metaData.mediaType}{MimeType}
+ \endlist
+
+ \sa {MetaData}
+*/
+
+/*!
\qmlpropertygroup QtMultimedia::MediaPlayer::metaData
\qmlproperty variant QtMultimedia::MediaPlayer::metaData.title
\qmlproperty variant QtMultimedia::MediaPlayer::metaData.subTitle