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>
This commit is contained in:
committed by
Qt by Nokia
parent
51ca5582c2
commit
c0fd63d143
@@ -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
|
||||
|
||||
@@ -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
|
||||
*/
|
||||
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
/*!
|
||||
\class QMediaPlaylistProvider
|
||||
\internal
|
||||
|
||||
\brief The QMediaPlaylistProvider class provides an abstract list of media.
|
||||
\inmodule QtMultimedia
|
||||
|
||||
@@ -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}
|
||||
*/
|
||||
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user