diff options
author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2022-09-29 10:20:50 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-10-07 12:33:11 +0000 |
commit | 5a6e631a51d22b30529d7e2776b0c26598aa5d8f (patch) | |
tree | 3cfd60e25a635d4a3527e65cb928ddf039e3947b | |
parent | d76ece0841cb01a2557a0dab5897faa349740424 (diff) | |
download | qtmultimedia-5a6e631a51d22b30529d7e2776b0c26598aa5d8f.tar.gz |
Doc: Fix undocumented members warning
Change-Id: I465dd06e2bd20755c39b1f5953a6e57d49c877b3
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
(cherry picked from commit 01f969d7ce7f011ee683974df5d7edc406f892cd)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/multimedia/qmediadevices.cpp | 14 | ||||
-rw-r--r-- | src/multimedia/qmediaformat.cpp | 32 | ||||
-rw-r--r-- | src/multimedia/qmediametadata.cpp | 40 | ||||
-rw-r--r-- | src/multimedia/qmediatimerange.cpp | 6 |
4 files changed, 91 insertions, 1 deletions
diff --git a/src/multimedia/qmediadevices.cpp b/src/multimedia/qmediadevices.cpp index ae359043d..d8486e603 100644 --- a/src/multimedia/qmediadevices.cpp +++ b/src/multimedia/qmediadevices.cpp @@ -104,6 +104,8 @@ QT_BEGIN_NAMESPACE */ /*! + \property QMediaDevices::audioInputs + Returns a list of available audio input devices on the system. Those devices are usually microphones. Devices can be either built-in, or @@ -123,6 +125,8 @@ QList<QAudioDevice> QMediaDevices::audioInputs() */ /*! + \property QMediaDevices::audioOutputs + Returns a list of available audio output devices on the system. Those devices are usually loudspeakers or head sets. Devices can be either @@ -139,6 +143,8 @@ QList<QAudioDevice> QMediaDevices::audioOutputs() */ /*! + \property QMediaDevices::videoInputs + Returns a list of available cameras on the system. */ QList<QCameraDevice> QMediaDevices::videoInputs() @@ -155,6 +161,8 @@ QList<QCameraDevice> QMediaDevices::videoInputs() */ /*! + \property QMediaDevices::defaultAudioInput + Returns the default audio input device. The default device can change during the runtime of the application. @@ -180,6 +188,8 @@ QAudioDevice QMediaDevices::defaultAudioInput() */ /*! + \property QMediaDevices::defaultAudioOutput + Returns the default audio output device. The default device can change during the runtime of the application. The @@ -208,9 +218,11 @@ QAudioDevice QMediaDevices::defaultAudioOutput() */ /*! + \property QMediaDevices::defaultVideoInput + Returns the default camera on the system. - /note The returned object should be checked using isNull() before being used, + \note The returned object should be checked using isNull() before being used, in case there is no default camera or no cameras at all. The default device can change during the runtime of the application. The diff --git a/src/multimedia/qmediaformat.cpp b/src/multimedia/qmediaformat.cpp index afcaf8a20..f6c35d630 100644 --- a/src/multimedia/qmediaformat.cpp +++ b/src/multimedia/qmediaformat.cpp @@ -367,6 +367,11 @@ QMediaFormat::~QMediaFormat() = default; QMediaFormat::QMediaFormat(const QMediaFormat &other) noexcept = default; /*! + \fn void swap(QMediaFormat &other) noexcept + + Swaps the media format with \a other. +*/ +/*! Copies \a other into this QMediaFormat object. */ QMediaFormat &QMediaFormat::operator=(const QMediaFormat &other) noexcept = default; @@ -722,6 +727,17 @@ QString QMediaFormat::videoCodecDescription(QMediaFormat::VideoCodec codec) return QString::fromUtf8(descriptions[int(codec) + 1]); } +/*! + \fn bool QMediaFormat::operator!=(const QMediaFormat &other) const + + Returns \c true if \a other is not equal to the current media format, + otherwise returns \c false. +*/ + +/*! + Returns \c true if \a other is equal to the current media format, otherwise + returns \c false. +*/ bool QMediaFormat::operator==(const QMediaFormat &other) const { Q_ASSERT(!d); @@ -857,4 +873,20 @@ void QMediaFormat::resolveForEncoding(ResolveFlags flags) } } +/*! + \variable QMediaFormat::audio + \internal +*/ +/*! + \variable QMediaFormat::d + \internal +*/ +/*! + \variable QMediaFormat::video + \internal +*/ +/*! + \variable QMediaFormat::fmt + \internal +*/ QT_END_NAMESPACE diff --git a/src/multimedia/qmediametadata.cpp b/src/multimedia/qmediametadata.cpp index 3390c1bb3..2ebf18ca3 100644 --- a/src/multimedia/qmediametadata.cpp +++ b/src/multimedia/qmediametadata.cpp @@ -244,6 +244,46 @@ QMetaType QMediaMetaData::keyType(Key key) */ /*! + \enum QMediaMetaData::Key + + The following meta data keys can be used: + + \value Title Media title + \value Author Media author + \value Comment Comment + \value Description Brief desripttion + \value Genre Genre the media belongs to + \value Date Creation date + \value Language Media language + \value Publisher Media publisher info. + \value Copyright Media copyright info. + \value Url Publisher's website URL + \value Duration Media playback duration + \value MediaType Type of the media + \value FileFormat File format + \value AudioBitRate + \value AudioCodec + \value VideoBitRate + \value VideoCodec + \value VideoFrameRate + \value AlbumTitle Album's title + \value AlbumArtist Artist's info. + \value ContributingArtist + \value TrackNumber + \value Composer Media composer's info. + \value LeadPerformer + \value ThumbnailImage Media thumbnail image + \value CoverArtImage Media cover art + \value Orientation + \value Resolution +*/ + +/*! + \variable QMediaMetaData::NumMetaData + \internal +*/ + +/*! \qmlmethod variant QtMultimedia::mediaMetaData::value(Key key) Returns the meta data value for Key \a key, or a null QVariant if no diff --git a/src/multimedia/qmediatimerange.cpp b/src/multimedia/qmediatimerange.cpp index 7299f79a5..51e82d32b 100644 --- a/src/multimedia/qmediatimerange.cpp +++ b/src/multimedia/qmediatimerange.cpp @@ -260,6 +260,12 @@ QMediaTimeRange::QMediaTimeRange(const QMediaTimeRange &range) noexcept = defaul */ /*! + \fn void QMediaTimeRange::swap(QMediaTimeRange &other) noexcept + + Swaps the current instance with the \a other. +*/ + +/*! \fn QMediaTimeRange::~QMediaTimeRange() Destructor. |