summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Goddard <michael.goddard@nokia.com>2012-02-06 15:49:54 +1000
committerQt by Nokia <qt-info@nokia.com>2012-02-06 07:45:05 +0100
commitc0fd63d143e798203f1108824e7a7c6a3ea6e0e2 (patch)
treed6e2d1298e5bdbd535ef9f475a856a70a19e4707
parent51ca5582c2475ea91fe2d86793f000f7bed41f51 (diff)
Documentation tweaks.
Mostly move widgets classes into the QtMultimediaWidgets module, but also mark a few mostly internal playlist classes as \internal. A few other tweaks. Change-Id: If0e376410bf2187cafb24f583108c6beb7b910a9 Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
-rw-r--r--src/imports/multimedia/qdeclarativeaudio.cpp57
-rw-r--r--src/multimedia/audio/qsound.cpp6
-rw-r--r--src/multimedia/playback/qmediaplaylistioplugin.cpp2
-rw-r--r--src/multimedia/playback/qmediaplaylistnavigator.cpp1
-rw-r--r--src/multimedia/playback/qmediaplaylistprovider.cpp1
-rw-r--r--src/multimedia/radio/qradiotuner.cpp2
-rw-r--r--src/multimediawidgets/qcameraviewfinder.cpp2
-rw-r--r--src/multimediawidgets/qgraphicsvideoitem.cpp2
-rw-r--r--src/multimediawidgets/qvideowidget.cpp4
-rw-r--r--src/multimediawidgets/qvideowidgetcontrol.cpp2
-rw-r--r--src/multimediawidgets/qvideowindowcontrol.cpp2
11 files changed, 72 insertions, 9 deletions
diff --git a/src/imports/multimedia/qdeclarativeaudio.cpp b/src/imports/multimedia/qdeclarativeaudio.cpp
index 9445b0fd..3fb4ae7e 100644
--- a/src/imports/multimedia/qdeclarativeaudio.cpp
+++ b/src/imports/multimedia/qdeclarativeaudio.cpp
@@ -45,6 +45,63 @@
QT_BEGIN_NAMESPACE
+/*!
+ \qmlclass MediaPlayer
+ \brief The MediaPlayer element allows you to add media playback to a scene.
+
+ \ingroup multimedia_qml
+
+ This element is part of the \bold{QtMultimedia 5.0} module.
+
+ \qml
+ import QtQuick 2.0
+ import QtMultimedia 5.0
+
+ Text {
+ text: "Click Me!";
+ font.pointSize: 24;
+ width: 150; height: 50;
+
+ MediaPlayer {
+ id: playMusic
+ source: "music.wav"
+ }
+ MouseArea {
+ id: playArea
+ anchors.fill: parent
+ onPressed: { playMusic.play() }
+ }
+ }
+ \endqml
+
+ You can use MediaPlayer by itself to play audio content (like the \l Audio element),
+ or you can use it in conjunction with a \l VideoOutput element for rendering video.
+
+ \qml
+ import QtQuick 2.0
+ import QtMultimedia 5.0
+
+ Item {
+ MediaPlayer {
+ id: mediaplayer
+ source: "groovy_video.mp4"
+ }
+
+ VideoOutput {
+ anchors: parent.fill
+ source: mediaplayer
+ }
+
+ MouseArea {
+ id: playArea
+ anchors.fill: parent
+ onPressed: mediaplayer.play();
+ }
+ }
+ \endqml
+
+ \sa VideoOutput
+*/
/*!
\qmlclass Audio QDeclarativeAudio
diff --git a/src/multimedia/audio/qsound.cpp b/src/multimedia/audio/qsound.cpp
index 5312a3e8..dc07c08b 100644
--- a/src/multimedia/audio/qsound.cpp
+++ b/src/multimedia/audio/qsound.cpp
@@ -46,7 +46,7 @@
/*!
\class QSound
- \brief The QSound class provides a way to play .wav sound files.
+ \brief The QSound class provides a method to play .wav sound files.
\ingroup multimedia
\ingroup multimedia_audio
@@ -74,6 +74,10 @@
static play() function, but it may also play more immediately
(depending on the underlying platform audio facilities).
+ If you require finer control over playing sounds, consider the
+ \l QSoundEffect or \l QAudioOutput classes.
+
+ \sa QSoundEffect
*/
diff --git a/src/multimedia/playback/qmediaplaylistioplugin.cpp b/src/multimedia/playback/qmediaplaylistioplugin.cpp
index 0d1e5784..084c55d6 100644
--- a/src/multimedia/playback/qmediaplaylistioplugin.cpp
+++ b/src/multimedia/playback/qmediaplaylistioplugin.cpp
@@ -45,6 +45,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaPlaylistReader
+ \internal
\brief The QMediaPlaylistReader class provides an interface for reading a playlist file.
\inmodule QtMultimedia
@@ -86,6 +87,7 @@ QMediaPlaylistReader::~QMediaPlaylistReader()
/*!
\class QMediaPlaylistWriter
+ \internal
\brief The QMediaPlaylistWriter class provides an interface for writing a playlist file.
diff --git a/src/multimedia/playback/qmediaplaylistnavigator.cpp b/src/multimedia/playback/qmediaplaylistnavigator.cpp
index 8cce09a6..414f735d 100644
--- a/src/multimedia/playback/qmediaplaylistnavigator.cpp
+++ b/src/multimedia/playback/qmediaplaylistnavigator.cpp
@@ -192,6 +192,7 @@ int QMediaPlaylistNavigatorPrivate::previousItemPos(int steps) const
/*!
\class QMediaPlaylistNavigator
+ \internal
\brief The QMediaPlaylistNavigator class provides navigation for a media playlist.
\inmodule QtMultimedia
diff --git a/src/multimedia/playback/qmediaplaylistprovider.cpp b/src/multimedia/playback/qmediaplaylistprovider.cpp
index 9324b26f..c3e62a1d 100644
--- a/src/multimedia/playback/qmediaplaylistprovider.cpp
+++ b/src/multimedia/playback/qmediaplaylistprovider.cpp
@@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaPlaylistProvider
+ \internal
\brief The QMediaPlaylistProvider class provides an abstract list of media.
\inmodule QtMultimedia
diff --git a/src/multimedia/radio/qradiotuner.cpp b/src/multimedia/radio/qradiotuner.cpp
index e0aeaa2c..69129a79 100644
--- a/src/multimedia/radio/qradiotuner.cpp
+++ b/src/multimedia/radio/qradiotuner.cpp
@@ -87,7 +87,7 @@ namespace
You can change between the frequency bands using setBand() however it is recommended
that you check to make sure the band is available first using isBandSupported().
- \sa {Radio Overview}
+ \sa QRadioData, {Radio Overview}
*/
diff --git a/src/multimediawidgets/qcameraviewfinder.cpp b/src/multimediawidgets/qcameraviewfinder.cpp
index 92d1ccb6..341bd79f 100644
--- a/src/multimediawidgets/qcameraviewfinder.cpp
+++ b/src/multimediawidgets/qcameraviewfinder.cpp
@@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE
\brief The QCameraViewfinder class provides a camera viewfinder widget.
- \inmodule QtMultimedia
+ \inmodule QtMultimediaWidgets
\ingroup camera
\snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera
diff --git a/src/multimediawidgets/qgraphicsvideoitem.cpp b/src/multimediawidgets/qgraphicsvideoitem.cpp
index 97df9f5c..304767a8 100644
--- a/src/multimediawidgets/qgraphicsvideoitem.cpp
+++ b/src/multimediawidgets/qgraphicsvideoitem.cpp
@@ -173,7 +173,7 @@ void QGraphicsVideoItemPrivate::_q_serviceDestroyed()
\brief The QGraphicsVideoItem class provides a graphics item which display video produced by a QMediaObject.
- \inmodule QtMultimedia
+ \inmodule QtMultimediaWidgets
\ingroup multimedia
Attaching a QGraphicsVideoItem to a QMediaObject allows it to display
diff --git a/src/multimediawidgets/qvideowidget.cpp b/src/multimediawidgets/qvideowidget.cpp
index c7a66d64..22d45985 100644
--- a/src/multimediawidgets/qvideowidget.cpp
+++ b/src/multimediawidgets/qvideowidget.cpp
@@ -584,9 +584,7 @@ void QVideoWidgetPrivate::_q_dimensionsChanged()
\brief The QVideoWidget class provides a widget which presents video
produced by a media object.
\ingroup multimedia
- \inmodule QtMultimedia
-
- \inmodule QtMultimedia
+ \inmodule QtMultimediaWidgets
Attaching a QVideoWidget to a QMediaObject allows it to display the
video or image output of that media object. A QVideoWidget is attached
diff --git a/src/multimediawidgets/qvideowidgetcontrol.cpp b/src/multimediawidgets/qvideowidgetcontrol.cpp
index bb0ff711..0b98b869 100644
--- a/src/multimediawidgets/qvideowidgetcontrol.cpp
+++ b/src/multimediawidgets/qvideowidgetcontrol.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
\brief The QVideoWidgetControl class provides a media control which
implements a video widget.
- \inmodule QtMultimedia
+ \inmodule QtMultimediaWidgets
\ingroup multimedia-serv
The videoWidget() property of QVideoWidgetControl provides a pointer to a
diff --git a/src/multimediawidgets/qvideowindowcontrol.cpp b/src/multimediawidgets/qvideowindowcontrol.cpp
index 3f3ea06c..3c56096c 100644
--- a/src/multimediawidgets/qvideowindowcontrol.cpp
+++ b/src/multimediawidgets/qvideowindowcontrol.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QVideoWindowControl
- \inmodule QtMultimedia
+ \inmodule QtMultimediaWidgets
\ingroup multimedia-serv
\brief The QVideoWindowControl class provides a media control for rendering video to a window.