summaryrefslogtreecommitdiffstats
path: root/src/multimedia/qmediaobject.cpp
diff options
context:
space:
mode:
authorMichael Goddard <michael.goddard@nokia.com>2012-06-05 16:36:35 +1000
committerQt by Nokia <qt-info@nokia.com>2012-06-07 07:01:42 +0200
commita8ec84e3ca3abec75f99801db9128bf9ea490e31 (patch)
tree904b0cc2236f89d9c4ca5f3a561252d3228e026b /src/multimedia/qmediaobject.cpp
parent32337e544082d30ebdd25a95c5b0ccccb4a9daf0 (diff)
Clarify the metadata functionality of QMediaPlayer.
By linking to QMediaObject functions. Also clean that up a bit so it's a bit more useful for people looking for higher level functionality. Change-Id: Ie452122c4d55f88326a7b71c5882dfe38f489791 Reviewed-by: Angus Cummings <angus.cummings@nokia.com> Reviewed-by: Ling Hu <ling.hu@nokia.com> Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com> Reviewed-by: Daniel Kovacic <daniel.kovacic@nokia.com>
Diffstat (limited to 'src/multimedia/qmediaobject.cpp')
-rw-r--r--src/multimedia/qmediaobject.cpp23
1 files changed, 14 insertions, 9 deletions
diff --git a/src/multimedia/qmediaobject.cpp b/src/multimedia/qmediaobject.cpp
index dfb7a46e2..e9a620bb8 100644
--- a/src/multimedia/qmediaobject.cpp
+++ b/src/multimedia/qmediaobject.cpp
@@ -85,17 +85,20 @@ void QMediaObjectPrivate::_q_availabilityChanged()
\ingroup multimedia
\ingroup multimedia_core
+ It provides some basic functionality that is common to other high level classes
+ like \l QMediaPlayer, \l QAudioDecoder and \l QCamera, including availability
+ and meta-data functionality, as well as functionality to connect media objects
+ with support classes like QMediaPlaylist.
- QMediaObject derived classes provide access to the functionality of a
- QMediaService. Each media object hosts a QMediaService and uses the
- QMediaControl interfaces implemented by the service to implement its
- API. Most media objects when constructed will request a new
- QMediaService instance from a QMediaServiceProvider, but some like
- QMediaRecorder will share a service with another object.
+ The higher level QMediaObject derived classes provide the actual multimedia
+ functionality, by internally using a QMediaService. Each media object
+ hosts a QMediaService and uses the QMediaControl interfaces implemented by the service to implement its
+ API. These controls can be accessed from the media object if necessary, but in general
+ the useful functionality can be accessed from the higher level classes.
- QMediaObject itself provides an API for accessing a media
- service's \l {metaData()}{meta-data} and a means of connecting other media objects,
- and peripheral classes like QVideoWidget and QMediaPlaylist.
+ Most media objects when constructed will request a new
+ QMediaService instance, but some like
+ QMediaRecorder and QAudioRecorder will share a service with another object.
\sa QMediaService, QMediaControl
*/
@@ -338,6 +341,8 @@ bool QMediaObject::isMetaDataAvailable() const
/*!
Returns the value associated with a meta-data \a key.
+
+ See the list of predefined \l {QtMultimedia::MetaData}{meta-data keys}.
*/
QVariant QMediaObject::metaData(const QString &key) const
{