summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2022-09-29 10:08:21 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-10-07 10:13:11 +0000
commit2970eeafcaced56296816f41f8334308da8e8447 (patch)
tree515efb0f1cff1fee94d416d419302d4b2152cbc0
parent3a0557bd56069b0026e35582d09c2776617ef6bd (diff)
Doc: Fix warnings about undocumented member in playback API
Change-Id: Iff47152f8a2ea58ff27e00f27fdb9e7eb467eec1 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> (cherry picked from commit 287fb7937497f0956885526eec8b035aad675c7a) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/multimedia/playback/qmediaplayer.cpp18
1 files changed, 18 insertions, 0 deletions
diff --git a/src/multimedia/playback/qmediaplayer.cpp b/src/multimedia/playback/qmediaplayer.cpp
index 947d27e64..14d46a444 100644
--- a/src/multimedia/playback/qmediaplayer.cpp
+++ b/src/multimedia/playback/qmediaplayer.cpp
@@ -283,6 +283,11 @@ const QIODevice *QMediaPlayer::sourceDevice() const
return d->stream;
}
+/*!
+ \property QMediaPlayer::playbackState
+
+ Returns the \l{QMediaPlayer::}{PlaybackState}.
+*/
QMediaPlayer::PlaybackState QMediaPlayer::playbackState() const
{
Q_D(const QMediaPlayer);
@@ -692,6 +697,8 @@ QAudioOutput *QMediaPlayer::audioOutput() const
*/
/*!
+ \property QMediaPlayer::audioTracks
+
Lists the set of available audio tracks inside the media.
The QMediaMetaData returned describes the properties of individual
@@ -742,6 +749,8 @@ QList<QMediaMetaData> QMediaPlayer::videoTracks() const
*/
/*!
+ \property QMediaPlayer::subtitleTracks
+
Lists the set of available subtitle tracks inside the media.
The QMediaMetaData returned describes the properties of individual
@@ -897,6 +906,10 @@ void QMediaPlayer::setVideoOutput(QObject *output)
d->setVideoSink(sink);
}
+/*!
+ Sets \a sink to be the QVideoSink instance to
+ retrieve video data.
+*/
void QMediaPlayer::setVideoSink(QVideoSink *sink)
{
Q_D(QMediaPlayer);
@@ -904,6 +917,9 @@ void QMediaPlayer::setVideoSink(QVideoSink *sink)
d->setVideoSink(sink);
}
+/*!
+ Returns the QVedioSink instance.
+*/
QVideoSink *QMediaPlayer::videoSink() const
{
Q_D(const QMediaPlayer);
@@ -949,6 +965,8 @@ bool QMediaPlayer::isAvailable() const
*/
/*!
+ \property QMediaPlayer::metaData
+
Returns meta data for the current media used by the media player.
Meta data can contain information such as the title of the video or its creation date.