summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@qt.io>2021-09-21 10:41:39 +0200
committerLars Knoll <lars.knoll@qt.io>2021-09-22 13:51:16 +0200
commit49137f2b93f02fdfb72d4c914f00f3e735d2a5a3 (patch)
tree756549703c694fc734fa16ed33128278e1024fc4
parent631e1b1e3433e122c318102f38aa73d4d041cb9a (diff)
downloadqtmultimedia-49137f2b93f02fdfb72d4c914f00f3e735d2a5a3.tar.gz
Fix API naming inconsistency
The QML type should be MediaMetaData (as the namespace is mediaMetaData). Change-Id: I0b45ef390fc9662c534033977f56d3ce607bcb3e Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io> (cherry picked from commit 5777fe84cf1e7c15c7905b549a34f1df946eab96) Reviewed-by: Lars Knoll <lars.knoll@qt.io>
-rw-r--r--examples/multimedia/video/recorder/SettingsMetaData.qml30
-rw-r--r--src/multimedia/playback/qmediaplayer.cpp34
-rw-r--r--src/multimedia/qmediametadata.cpp25
-rw-r--r--src/multimedia/recording/qmediarecorder.cpp2
-rw-r--r--src/multimediaquick/qtmultimediaquicktypes_p.h2
5 files changed, 43 insertions, 50 deletions
diff --git a/examples/multimedia/video/recorder/SettingsMetaData.qml b/examples/multimedia/video/recorder/SettingsMetaData.qml
index 74db5bc2e..e675e2325 100644
--- a/examples/multimedia/video/recorder/SettingsMetaData.qml
+++ b/examples/multimedia/video/recorder/SettingsMetaData.qml
@@ -82,21 +82,21 @@ ColumnLayout {
height: Style.height
font.pointSize: Style.fontSize
model: ListModel {
- ListElement { text: "Title"; value: MetaData.Title }
- ListElement { text: "Author"; value: MetaData.Author }
- ListElement { text: "Comment"; value: MetaData.Comment }
- ListElement { text: "Description"; value: MetaData.Description }
- ListElement { text: "Genre"; value: MetaData.Genre }
- ListElement { text: "Publisher"; value: MetaData.Publisher }
- ListElement { text: "Copyright"; value: MetaData.Copyright }
- ListElement { text: "Date"; value: MetaData.Date }
- ListElement { text: "Url"; value: MetaData.Url }
- ListElement { text: "MediaType"; value: MetaData.MediaType }
- ListElement { text: "AlbumTitle"; value: MetaData.AlbumTitle }
- ListElement { text: "AlbumArtist"; value: MetaData.AlbumArtist }
- ListElement { text: "ContributingArtist"; value: MetaData.ContributingArtist }
- ListElement { text: "Composer"; value: MetaData.Composer }
- ListElement { text: "LeadPerformer"; value: MetaData.LeadPerformer }
+ ListElement { text: "Title"; value: MediaMetaData.Title }
+ ListElement { text: "Author"; value: MediaMetaData.Author }
+ ListElement { text: "Comment"; value: MediaMetaData.Comment }
+ ListElement { text: "Description"; value: MediaMetaData.Description }
+ ListElement { text: "Genre"; value: MediaMetaData.Genre }
+ ListElement { text: "Publisher"; value: MediaMetaData.Publisher }
+ ListElement { text: "Copyright"; value: MediaMetaData.Copyright }
+ ListElement { text: "Date"; value: MediaMetaData.Date }
+ ListElement { text: "Url"; value: MediaMetaData.Url }
+ ListElement { text: "MediaType"; value: MediaMetaData.MediaType }
+ ListElement { text: "AlbumTitle"; value: MediaMetaData.AlbumTitle }
+ ListElement { text: "AlbumArtist"; value: MediaMetaData.AlbumArtist }
+ ListElement { text: "ContributingArtist"; value: MediaMetaData.ContributingArtist }
+ ListElement { text: "Composer"; value: MediaMetaData.Composer }
+ ListElement { text: "LeadPerformer"; value: MediaMetaData.LeadPerformer }
}
textRole: "text"
valueRole: "value"
diff --git a/src/multimedia/playback/qmediaplayer.cpp b/src/multimedia/playback/qmediaplayer.cpp
index fa7316d41..2bf388f3a 100644
--- a/src/multimedia/playback/qmediaplayer.cpp
+++ b/src/multimedia/playback/qmediaplayer.cpp
@@ -667,18 +667,16 @@ QAudioOutput *QMediaPlayer::audioOutput() const
}
/*!
- \qmlproperty QList<QMediaMetaData> QtMultimedia::MediaPlayer::audioTracks
+ \qmlproperty list<mediaMetaData> QtMultimedia::MediaPlayer::audioTracks
This property holds a list of metadata.
Each index refers to an audio track.
- The metadata holds 2 properties;
- \list
- \li \l{QtMultimedia::MediaPlayer::metaData.language}{Language}
- \li \l{QtMultimedia::MediaPlayer::metaData.mediaType}{MimeType}
- \endlist
+ The metadata holds properties describing the individual tracks. For
+ audio tracks the \l{language}{MediaMetaData::Language} is usually the most
+ important property.
- \sa {MetaData}
+ \sa MediaMetaData
*/
/*!
@@ -696,18 +694,14 @@ QList<QMediaMetaData> QMediaPlayer::audioTracks() const
}
/*!
- \qmlproperty QList<QMediaMetaData> QtMultimedia::MediaPlayer::videoTracks
+ \qmlproperty list<mediaMetaData> 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
+ The metadata holds properties describing the individual tracks.
- \sa {MetaData}
+ \sa MediaMetaData
*/
/*!
@@ -723,18 +717,16 @@ QList<QMediaMetaData> QMediaPlayer::videoTracks() const
}
/*!
- \qmlproperty QList<QMediaMetaData> QtMultimedia::MediaPlayer::subtitleTracks
+ \qmlproperty list<mediaMetaData> 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
+ The metadata holds properties describing the individual tracks. For
+ subtitle tracks the \l{language}{MediaMetaData::Language} is usually the most
+ important property.
- \sa {MetaData}
+ \sa MediaMetaData
*/
/*!
diff --git a/src/multimedia/qmediametadata.cpp b/src/multimedia/qmediametadata.cpp
index c80a2ef32..7c81f3610 100644
--- a/src/multimedia/qmediametadata.cpp
+++ b/src/multimedia/qmediametadata.cpp
@@ -108,7 +108,8 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmltype MetaData
+ \qmltype MediaMetaData
+ \inqmlmodule QtMultimedia
\since 6.2
\instantiates QMediaMetaData
\brief Provides meta-data for media files.
@@ -215,7 +216,7 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlmethod QVariant QtMultimedia::MetaData::value(QMediaMetaData::Key key)
+ \qmlmethod QVariant QtMultimedia::MediaMetaData::value(QMediaMetaData::Key key)
Returns the meta data value for Key \a key, or a null QVariant if no
meta-data for the key is available.
@@ -229,7 +230,7 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlmethod bool QtMultimedia::MetaData::isEmpty()
+ \qmlmethod bool QtMultimedia::MediaMetaData::isEmpty()
Returns \c true if the meta data contains no items: otherwise returns \c{false}.
*/
@@ -239,17 +240,17 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlmethod void QtMultimedia::MetaData::clear()
- Removes all data from the MetaData object.
+ \qmlmethod void QtMultimedia::MediaMetaData::clear()
+ Removes all data from the MediaMetaData object.
*/
/*!
\fn void QMediaMetaData::clear()
- Removes all data from the MetaData object.
+ Removes all data from the meta data object.
*/
/*!
- \qmlmethod void QtMultimedia::MetaData::insert(QMediaMetaData::Key k, const QVariant &value)
+ \qmlmethod void QtMultimedia::MediaMetaData::insert(QMediaMetaData::Key k, const QVariant &value)
Inserts a \a value into a Key: \a{k}.
*/
@@ -258,7 +259,7 @@ QT_BEGIN_NAMESPACE
Inserts a \a value into a Key: \a{k}.
*/
/*!
- \qmlmethod void QtMultimedia::MetaData::remove(QMediaMetaData::Key k)
+ \qmlmethod void QtMultimedia::MediaMetaData::remove(QMediaMetaData::Key k)
Removes meta data from a Key: \a{k}.
*/
@@ -268,8 +269,8 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlmethod QList QtMultimedia::MetaData::keys()
- Returns a QList of MetaData.Keys.
+ \qmlmethod QList QtMultimedia::MediaMetaData::keys()
+ Returns a QList of MediaMetaData.Keys.
*/
/*!
@@ -278,7 +279,7 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlmethod QString QtMultimedia::MetaData::stringValue(QMediaMetaData::Key key)
+ \qmlmethod QString QtMultimedia::MediaMetaData::stringValue(QMediaMetaData::Key key)
Returns the meta data for key \a key as a QString.
This is mainly meant to simplify presenting the meta data to a user.
@@ -342,7 +343,7 @@ QString QMediaMetaData::stringValue(QMediaMetaData::Key key) const
return QString();
}
/*!
- \qmlmethod QString QtMultimedia::MetaData::metaDataKeyToString(QMediaMetaData::Key key)
+ \qmlmethod QString QtMultimedia::MediaMetaData::metaDataKeyToString(QMediaMetaData::Key key)
returns a string representation of \a key that can be used when presenting
meta data to users.
*/
diff --git a/src/multimedia/recording/qmediarecorder.cpp b/src/multimedia/recording/qmediarecorder.cpp
index 2115a9e28..eb4fe8ad6 100644
--- a/src/multimedia/recording/qmediarecorder.cpp
+++ b/src/multimedia/recording/qmediarecorder.cpp
@@ -526,7 +526,7 @@ void QMediaRecorder::stop()
*/
/*!
- \qmlproperty MetaData QtMultimedia::MediaRecorder::metaData
+ \qmlproperty MediaMetaData QtMultimedia::MediaRecorder::metaData
\brief This property holds meta data associated with the recording.
diff --git a/src/multimediaquick/qtmultimediaquicktypes_p.h b/src/multimediaquick/qtmultimediaquicktypes_p.h
index 26765683b..c4051e0b5 100644
--- a/src/multimediaquick/qtmultimediaquicktypes_p.h
+++ b/src/multimediaquick/qtmultimediaquicktypes_p.h
@@ -110,7 +110,7 @@ namespace QMediaMetaDataNamespaceForeign
{
Q_NAMESPACE
QML_FOREIGN_NAMESPACE(QMediaMetaData)
- QML_NAMED_ELEMENT(MetaData)
+ QML_NAMED_ELEMENT(MediaMetaData)
};
struct QMediaDevicesForeign