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>

1 files changed, 10 insertions, 2 deletions

diff --git a/src/multimedia/playback/qmediaplayer.cpp b/src/multimedia/playback/qmediaplayer.cpp
index 0ad958198..3b1b06b3b 100644
--- a/src/multimedia/playback/qmediaplayer.cpp
+++ b/src/multimedia/playback/qmediaplayer.cpp
@@ -68,8 +68,8 @@ QT_BEGIN_NAMESPACE
 
     The QMediaPlayer class is a high level media playback class. It can be used
     to playback such content as songs, movies and internet radio. The content
-    to playback is specified as a QMediaContent, which can be thought of as a
-    main or canonical URL with addition information attached. When provided
+    to playback is specified as a QMediaContent object, which can be thought of as a
+    main or canonical URL with additional information attached. When provided
     with a QMediaContent playback may be able to commence.
 
     \snippet doc/src/snippets/multimedia-snippets/media.cpp Player
@@ -79,6 +79,14 @@ QT_BEGIN_NAMESPACE
 
     \snippet doc/src/snippets/multimedia-snippets/media.cpp Movie playlist
 
+    Since QMediaPlayer is a QMediaObject, you can use several of the QMediaObject
+    functions for things like:
+
+    \list
+    \li Accessing the currently playing media's metadata (\l {QMediaObject::metaData()} and \l predefined \l {QtMultimedia::MetaData}{meta-data keys})
+    \li Checking to see if the media playback service is currently available (\l {QMediaObject::availabilityError()})
+    \endlist
+
     \sa QMediaObject, QMediaService, QVideoWidget, QMediaPlaylist
 */