summaryrefslogtreecommitdiffstats
path: root/src/multimedia
diff options
context:
space:
mode:
authorMichael Goddard <michael.goddard@nokia.com>2012-06-13 13:52:05 +1000
committerQt by Nokia <qt-info@nokia.com>2012-06-15 08:49:29 +0200
commit6931cbb35a909b192960205929d4a0efde280ee2 (patch)
tree84ca34a55756f929d255a887c12c01e69d101259 /src/multimedia
parente975897ad7ebbad12f023e83eae8c4b7840ad6ed (diff)
Fix a number of other qdoc issues.
* Several places needed the forward class declaration hack * Missing/wrong minor version numbers on imports * A few typos * Any number of attempts to work around qdoc * A few missing docs * Tweaked soundeffect docs Change-Id: I3c2ab998a11cbb0956712e0423e01fdb70f5bfff Reviewed-by: Peter Yard <peter.yard@nokia.com> Reviewed-by: Angus Cummings <angus.cummings@nokia.com> Reviewed-by: Jonas Rabbe <jonas.rabbe@gmail.com>
Diffstat (limited to 'src/multimedia')
-rw-r--r--src/multimedia/audio/qaudiobuffer_p.h3
-rw-r--r--src/multimedia/audio/qaudiodecoder.cpp7
-rw-r--r--src/multimedia/audio/qaudiosystem.h2
-rw-r--r--src/multimedia/audio/qaudiosystemplugin.h5
-rw-r--r--src/multimedia/audio/qsoundeffect.cpp496
-rw-r--r--src/multimedia/controls/qmediaavailabilitycontrol.h3
-rw-r--r--src/multimedia/gsttools_headers/qgstreamermessage_p.h3
-rw-r--r--src/multimedia/playback/qmediaplaylist.cpp4
-rw-r--r--src/multimedia/qmediaserviceproviderplugin.h18
-rw-r--r--src/multimedia/qtmedianamespace.cpp1
10 files changed, 354 insertions, 188 deletions
diff --git a/src/multimedia/audio/qaudiobuffer_p.h b/src/multimedia/audio/qaudiobuffer_p.h
index af81b7cad..854ca23fc 100644
--- a/src/multimedia/audio/qaudiobuffer_p.h
+++ b/src/multimedia/audio/qaudiobuffer_p.h
@@ -53,6 +53,9 @@ QT_BEGIN_NAMESPACE
QT_MODULE(Multimedia)
+// Required for QDoc workaround
+class QString;
+
class Q_MULTIMEDIA_EXPORT QAbstractAudioBuffer {
public:
virtual ~QAbstractAudioBuffer() {}
diff --git a/src/multimedia/audio/qaudiodecoder.cpp b/src/multimedia/audio/qaudiodecoder.cpp
index 30c9c0ccc..2cc11c02f 100644
--- a/src/multimedia/audio/qaudiodecoder.cpp
+++ b/src/multimedia/audio/qaudiodecoder.cpp
@@ -368,8 +368,6 @@ QtMultimedia::SupportEstimate QAudioDecoder::hasSupport(const QString &mimeType,
}
/*!
- \fn QAudioDecoder::bufferAvailable() const
-
Returns true if a buffer is available to be read,
and false otherwise. If there is no buffer available, calling
the \l read() function will return an invalid buffer.
@@ -549,6 +547,11 @@ QAudioBuffer QAudioDecoder::read() const
\brief the active filename being decoded by the decoder object.
*/
+/*!
+ \property QAudioDecoder::bufferAvailable
+ \brief whether there is a decoded audio buffer available
+*/
+
#include "moc_qaudiodecoder.cpp"
QT_END_NAMESPACE
diff --git a/src/multimedia/audio/qaudiosystem.h b/src/multimedia/audio/qaudiosystem.h
index 390cc9733..e5ef8e44c 100644
--- a/src/multimedia/audio/qaudiosystem.h
+++ b/src/multimedia/audio/qaudiosystem.h
@@ -55,6 +55,8 @@ QT_BEGIN_NAMESPACE
QT_MODULE(Multimedia)
+// Required for QDoc workaround
+class QString;
class Q_MULTIMEDIA_EXPORT QAbstractAudioDeviceInfo : public QObject
{
diff --git a/src/multimedia/audio/qaudiosystemplugin.h b/src/multimedia/audio/qaudiosystemplugin.h
index 44e1646c6..9ed4e45c5 100644
--- a/src/multimedia/audio/qaudiosystemplugin.h
+++ b/src/multimedia/audio/qaudiosystemplugin.h
@@ -59,6 +59,8 @@ QT_BEGIN_NAMESPACE
QT_MODULE(Multimedia)
+// Required for QDoc workaround
+class QString;
struct Q_MULTIMEDIA_EXPORT QAudioSystemFactoryInterface
{
@@ -72,6 +74,9 @@ struct Q_MULTIMEDIA_EXPORT QAudioSystemFactoryInterface
"org.qt-project.qt.audiosystemfactory/5.0"
Q_DECLARE_INTERFACE(QAudioSystemFactoryInterface, QAudioSystemFactoryInterface_iid)
+// Required for QDoc workaround
+class QString;
+
class Q_MULTIMEDIA_EXPORT QAudioSystemPlugin : public QObject, public QAudioSystemFactoryInterface
{
Q_OBJECT
diff --git a/src/multimedia/audio/qsoundeffect.cpp b/src/multimedia/audio/qsoundeffect.cpp
index 3d2ddd506..956f86801 100644
--- a/src/multimedia/audio/qsoundeffect.cpp
+++ b/src/multimedia/audio/qsoundeffect.cpp
@@ -50,190 +50,69 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass SoundEffect QSoundEffect
- \brief The SoundEffect type provides a way to play sound effects in QML.
-
- \inmodule QtMultimedia
- \ingroup multimedia_qml
- \ingroup multimedia_audio_qml
- \inqmlmodule QtMultimedia 5
-
- SoundEffect is part of the \b{QtMultimedia 5.0} module.
-
- The following example plays a WAV file on mouse click.
-
- \snippet doc/src/snippets/multimedia-snippets/soundeffect.qml complete snippet
-*/
-
-/*!
\class QSoundEffect
\brief The QSoundEffect class provides a way to play low latency sound effects.
\ingroup multimedia
\ingroup multimedia_audio
+ \inmodule QtMultimedia
+ This class allows you to play uncompressed audio files (typically WAV files) in
+ a generally lower latency way, and is suitable for "feedback" type sounds in
+ response to user actions (e.g. virtual keyboard sounds, positive or negative
+ feedback for popup dialogs, or game sounds). If low latency is not important,
+ consider using the QMediaPlayer class instead, since it supports a wider
+ variety of media formats and is less resource intensive.
-*/
-
-/*!
- \enum QSoundEffect::Loop
-
- \value Infinite Used as a parameter to \l loops for infinite looping
-*/
-
-/*!
- \enum QSoundEffect::Status
-
- \value Null No source has been set or the source is null.
- \value Loading The SoundEffect is trying to load the source.
- \value Ready The source is loaded and ready for play.
- \value Error An error occurred during operation, such as failure of loading the source.
-
-*/
-
-/*!
- \qmlproperty url QtMultimedia5::SoundEffect::source
- \property QSoundEffect::source
-
- This property provides a way to control the sound to play. For the SoundEffect
- to attempt to load the source, the URL must exist and the application must have read permission
- in the specified directory. If the desired source is a local file the URL may be specified
- using either absolute or relative (to the file that declared the SoundEffect) pathing.
-*/
-
-/*!
- \qmlproperty int QtMultimedia5::SoundEffect::loops
-
- This property provides a way to control the number of times to repeat the sound on each play().
-
- Set to SoundEffect.Infinite to enable infinite looping.
-*/
-
-/*!
- \property QSoundEffect::loops
- This property provides a way to control the number of times to repeat the sound on each play().
-
- Set to QSoundEffect::Infinite to enable infinite looping.
-*/
-
-/*!
- \qmlproperty qreal QtMultimedia5::SoundEffect::volume
- \property QSoundEffect::volume
-
- This property holds the volume of the playback, from 0.0 (silent) to 1.0 (maximum volume).
-*/
-
-/*!
- \qmlproperty bool QtMultimedia5::SoundEffect::muted
- \property QSoundEffect::muted
-
- This property provides a way to control muting. A value of \c true will mute this effect.
-*/
-
-/*!
- \qmlproperty bool QtMultimedia5::SoundEffect::playing
- \property QSoundEffect::playing
-
- This property indicates whether the sound effect is playing or not.
-*/
-
-/*!
- \qmlproperty enumeration QtMultimedia5::SoundEffect::status
-
- This property indicates the current status of the SoundEffect
- as enumerated within SoundEffect.
- Possible statuses are listed below.
-
- \table
- \header \li Value \li Description
- \row \li SoundEffect.Null \li No source has been set or the source is null.
- \row \li SoundEffect.Loading \li The SoundEffect is trying to load the source.
- \row \li SoundEffect.Ready \li The source is loaded and ready for play.
- \row \li SoundEffect.Error \li An error occurred during operation, such as failure of loading the source.
- \endtable
-*/
-
-/*!
- \qmlsignal QtMultimedia5::SoundEffect::sourceChanged()
- \fn void QSoundEffect::sourceChanged()
-
- The \c sourceChanged signal is emitted when the source has been changed.
-
- The corresponding handler is \c onSourceChanged.
-*/
-/*!
- \qmlsignal QtMultimedia5::SoundEffect::loadedChanged()
- \fn void QSoundEffect::loadedChanged()
-
- The \c loadedChanged signal is emitted when the loading state has changed.
-
- The corresponding handler is \c onLoadedChanged.
-*/
-
-/*!
- \qmlsignal QtMultimedia5::SoundEffect::loopCountChanged()
- \fn void QSoundEffect::loopCountChanged()
-
- The \c loopCountChanged signal is emitted when the initial number of loops has changed.
+ This example shows how a looping, somewhat quiet sound effect
+ can be played:
- The corresponding handler is \c onLoopCountChanged.
-*/
+ \snippet doc/src/snippets/multimedia-snippets/qsound.cpp 2
-/*!
- \qmlsignal QtMultimedia5::SoundEffect::loopsRemainingChanged()
- \fn void QSoundEffect::loopsRemainingChanged()
+ Typically the sound effect should be reused, which allows all the
+ parsing and preparation to be done ahead of time, and only triggered
+ when necessary. This assists with lower latency audio playback.
- The \c loopsRemainingChanged signal is emitted when the remaining number of loops has changed.
+ \snippet doc/src/snippets/multimedia-snippets/qsound.cpp 3
- The corresponding handler is \c onLoopsRemainingChanged.
+ Since QSoundEffect requires slightly more resources to achieve lower
+ latency playback, the platform may limit the number of simultaneously playing
+ sound effects.
*/
-/*!
- \qmlsignal QtMultimedia5::SoundEffect::volumeChanged()
- \fn void QSoundEffect::volumeChanged()
-
- The \c volumeChanged signal is emitted when the volume has changed.
-
- The corresponding handler is \c onVolumeChanged.
-*/
-
-/*!
- \qmlsignal QtMultimedia5::SoundEffect::mutedChanged()
- \fn void QSoundEffect::mutedChanged()
-
- The \c mutedChanged signal is emitted when the mute state has changed.
-
- The corresponding handler is \c onMutedChanged.
-*/
/*!
- \qmlsignal QtMultimedia5::SoundEffect::playingChanged()
- \fn void QSoundEffect::playingChanged()
-
- The \c playingChanged signal is emitted when the playing property has changed.
+ \qmlclass SoundEffect QSoundEffect
+ \brief The SoundEffect type provides a way to play sound effects in QML.
- The corresponding handler is \c onPlayingChanged.
-*/
+ \inmodule QtMultimedia
+ \ingroup multimedia_qml
+ \ingroup multimedia_audio_qml
+ \inqmlmodule QtMultimedia 5.0
-/*!
- \qmlsignal QtMultimedia5::SoundEffect::statusChanged()
- \fn void QSoundEffect::statusChanged()
+ SoundEffect is part of the \b{QtMultimedia 5.0} module.
- The \c statusChanged signal is emitted when the status property has changed.
+ This type allows you to play uncompressed audio files (typically WAV files) in
+ a generally lower latency way, and is suitable for "feedback" type sounds in
+ response to user actions (e.g. virtual keyboard sounds, positive or negative
+ feedback for popup dialogs, or game sounds). If low latency is not important,
+ consider using the MediaPlayer or Audio types instead, since they support a wider
+ variety of media formats and are less resource intensive.
- The corresponding handler is \c onStatusChanged.
-*/
+ Typically the sound effect should be reused, which allows all the
+ parsing and preparation to be done ahead of time, and only triggered
+ when necessary. This is easy to achieve with QML, since you can declare your
+ SoundEffect instance and refer to it elsewhere.
-/*!
- \qmlsignal QtMultimedia5::SoundEffect::categoryChanged()
- \fn void QSoundEffect::categoryChanged()
+ The following example plays a WAV file on mouse click.
- The \c categoryChanged signal is emitted when the category property has changed.
+ \snippet doc/src/snippets/multimedia-snippets/soundeffect.qml complete snippet
- The corresponding handler is \c onCategoryChanged.
+ Since SoundEffect requires slightly more resources to achieve lower
+ latency playback, the platform may limit the number of simultaneously playing
+ sound effects.
*/
-
/*!
Creates a QSoundEffect with the given \a parent.
*/
@@ -268,11 +147,29 @@ QStringList QSoundEffect::supportedMimeTypes()
return QSoundEffectPrivate::supportedMimeTypes();
}
+/*!
+ \qmlproperty url QtMultimedia5::SoundEffect::source
+
+ This property holds the url for the sound to play. For the SoundEffect
+ to attempt to load the source, the URL must exist and the application must have read permission
+ in the specified directory. If the desired source is a local file the URL may be specified
+ using either absolute or relative (to the file that declared the SoundEffect) pathing.
+*/
+/*!
+ \property QSoundEffect::source
+
+ This property holds the url for the sound to play. For the SoundEffect
+ to attempt to load the source, the URL must exist and the application must have read permission
+ in the specified directory.
+*/
+
+/*! Returns the URL of the current source to play */
QUrl QSoundEffect::source() const
{
return d->source();
}
+/*! Set the current URL to play to \a url. */
void QSoundEffect::setSource(const QUrl &url)
{
if (d->source() == url)
@@ -283,28 +180,41 @@ void QSoundEffect::setSource(const QUrl &url)
emit sourceChanged();
}
+/*!
+ \qmlproperty int QtMultimedia5::SoundEffect::loops
+
+ This property provides a way to control the number of times to repeat the sound on each play().
+
+ Set to SoundEffect.Infinite to enable infinite looping.
+*/
+
+/*!
+ \property QSoundEffect::loops
+ This property provides a way to control the number of times to repeat the sound on each play().
+
+ Set to QSoundEffect::Infinite to enable infinite looping.
+*/
+
+/*!
+ Returns the total number of times that this sound effect will be played before stopping.
+
+ See the \l loopsRemaining() method for the number of loops currently remaining.
+ */
int QSoundEffect::loopCount() const
{
return d->loopCount();
}
/*!
- \qmlproperty int QtMultimedia5::SoundEffect::loopsRemaining
+ \enum QSoundEffect::Loop
- This property contains the number of loops remaining before the sound effect
- stops by itself, or SoundEffect.Infinite if that's what has been set in \l loops.
+ \value Infinite Used as a parameter to \l setLoopCount() for infinite looping
*/
-/*!
- \property QSoundEffect::loopsRemaining
- This property contains the number of loops remaining before the sound effect
- stops by itself, or QSoundEffect::Infinite if that's what has been set in \l loops.
+/*!
+ Set the total number of times to repeat playing this sound effect on each play() call to \a loopCount.
+ Pass \c QSoundEffect::Infinite to repeat until stop() is called.
*/
-int QSoundEffect::loopsRemaining() const
-{
- return d->loopsRemaining();
-}
-
void QSoundEffect::setLoopCount(int loopCount)
{
if (loopCount < 0 && loopCount != Infinite) {
@@ -320,11 +230,46 @@ void QSoundEffect::setLoopCount(int loopCount)
emit loopCountChanged();
}
+/*!
+ \qmlproperty int QtMultimedia5::SoundEffect::loopsRemaining
+
+ This property contains the number of loops remaining before the sound effect
+ stops by itself, or SoundEffect.Infinite if that's what has been set in \l loops.
+*/
+/*!
+ \property QSoundEffect::loopsRemaining
+
+ This property contains the number of loops remaining before the sound effect
+ stops by itself, or QSoundEffect::Infinite if that's what has been set in \l loops.
+*/
+int QSoundEffect::loopsRemaining() const
+{
+ return d->loopsRemaining();
+}
+
+
+/*!
+ \qmlproperty qreal QtMultimedia5::SoundEffect::volume
+
+ This property holds the volume of the sound effect playback, from 0.0 (silent) to 1.0 (maximum volume).
+*/
+/*!
+ \property QSoundEffect::volume
+
+ This property holds the volume of the sound effect playback, from 0.0 (silent) to 1.0 (maximum volume).
+*/
+
+/*!
+ Returns the current volume of this sound effect, from 0.0 (silent) to 1.0 (maximum volume).
+ */
qreal QSoundEffect::volume() const
{
return qreal(d->volume()) / 100;
}
+/*!
+ Sets the volume to play the sound effect at to \a volume, from 0.0 (silent) to 1.0 (maximum volume).
+ */
void QSoundEffect::setVolume(qreal volume)
{
if (volume < 0 || volume > 1) {
@@ -338,11 +283,31 @@ void QSoundEffect::setVolume(qreal volume)
d->setVolume(iVolume);
}
+/*!
+ \qmlproperty bool QtMultimedia5::SoundEffect::muted
+
+ This property provides a way to control muting. A value of \c true will mute this effect.
+ Otherwise, playback will occur with the currently specified \l volume.
+*/
+/*!
+ \property QSoundEffect::muted
+
+ This property provides a way to control muting. A value of \c true will mute this effect.
+*/
+
+/*! Returns whether this sound effect is muted */
bool QSoundEffect::isMuted() const
{
return d->isMuted();
}
+/*!
+ Sets whether to mute this sound effect's playback.
+
+ If \a muted is true, playback will be muted (silenced),
+ and otherwise playback will occur with the currently
+ specified volume().
+*/
void QSoundEffect::setMuted(bool muted)
{
if (d->isMuted() == muted)
@@ -352,9 +317,13 @@ void QSoundEffect::setMuted(bool muted)
}
/*!
- \qmlmethod bool QtMultimedia5::SoundEffect::isLoaded()
\fn QSoundEffect::isLoaded() const
+ Returns whether the sound effect has finished loading the \l source().
+*/
+/*!
+ \qmlmethod bool QtMultimedia5::SoundEffect::isLoaded()
+
Returns whether the sound effect has finished loading the \l source.
*/
bool QSoundEffect::isLoaded() const
@@ -383,12 +352,56 @@ void QSoundEffect::play()
d->play();
}
+/*!
+ \qmlproperty bool QtMultimedia5::SoundEffect::playing
+
+ This property indicates whether the sound effect is playing or not.
+*/
+/*!
+ \property QSoundEffect::playing
+
+ This property indicates whether the sound effect is playing or not.
+*/
+
+/*! Returns true if the sound effect is currently playing, or false otherwise */
bool QSoundEffect::isPlaying() const
{
return d->isPlaying();
}
/*!
+ \enum QSoundEffect::Status
+
+ \value Null No source has been set or the source is null.
+ \value Loading The SoundEffect is trying to load the source.
+ \value Ready The source is loaded and ready for play.
+ \value Error An error occurred during operation, such as failure of loading the source.
+
+*/
+
+/*!
+ \qmlproperty enumeration QtMultimedia5::SoundEffect::status
+
+ This property indicates the current status of the SoundEffect
+ as enumerated within SoundEffect.
+ Possible statuses are listed below.
+
+ \table
+ \header \li Value \li Description
+ \row \li SoundEffect.Null \li No source has been set or the source is null.
+ \row \li SoundEffect.Loading \li The SoundEffect is trying to load the source.
+ \row \li SoundEffect.Ready \li The source is loaded and ready for play.
+ \row \li SoundEffect.Error \li An error occurred during operation, such as failure of loading the source.
+ \endtable
+*/
+/*!
+ \property QSoundEffect::status
+
+ This property indicates the current status of the sound effect
+ from the \l QSoundEffect::Status enumeration.
+*/
+
+/*!
Returns the current status of this sound effect.
*/
QSoundEffect::Status QSoundEffect::status() const
@@ -398,6 +411,17 @@ QSoundEffect::Status QSoundEffect::status() const
/*!
\qmlproperty string QtMultimedia5::SoundEffect::category
+
+ This property contains the \e category of this sound effect.
+
+ Some platforms can perform different audio routing
+ for different categories, or may allow the user to
+ set different volume levels for different categories.
+
+ This setting will be ignored on platforms that do not
+ support audio categories.
+*/
+/*!
\property QSoundEffect::category
This property contains the \e category of this sound effect.
@@ -453,16 +477,11 @@ void QSoundEffect::setCategory(const QString &category)
Stop current playback.
- Note that if the backend is PulseAudio, due to the limitation of the underlying API,
- calling stop will only prevent next looping but will not be able to stop current playback immediately.
-
*/
/*!
\fn QSoundEffect::stop()
- Stop current playback.
- Note that if the backend is PulseAudio, due to the limitation of the underlying API,
- calling stop will only prevent next looping but will not be able to stop current playback immediately.
+ Stop current playback.
*/
void QSoundEffect::stop()
@@ -470,6 +489,125 @@ void QSoundEffect::stop()
d->stop();
}
+/* Signals */
+
+/*!
+ \fn void QSoundEffect::sourceChanged()
+
+ The \c sourceChanged signal is emitted when the source has been changed.
+*/
+/*!
+ \qmlsignal QtMultimedia5::SoundEffect::sourceChanged()
+
+ The \c sourceChanged signal is emitted when the source has been changed.
+
+ The corresponding handler is \c onSourceChanged.
+*/
+/*!
+ \fn void QSoundEffect::loadedChanged()
+
+ The \c loadedChanged signal is emitted when the loading state has changed.
+*/
+/*!
+ \qmlsignal QtMultimedia5::SoundEffect::loadedChanged()
+
+ The \c loadedChanged signal is emitted when the loading state has changed.
+
+ The corresponding handler is \c onLoadedChanged.
+*/
+
+/*!
+ \fn void QSoundEffect::loopCountChanged()
+
+ The \c loopCountChanged signal is emitted when the initial number of loops has changed.
+*/
+/*!
+ \qmlsignal QtMultimedia5::SoundEffect::loopCountChanged()
+
+ The \c loopCountChanged signal is emitted when the initial number of loops has changed.
+
+ The corresponding handler is \c onLoopCountChanged.
+*/
+
+/*!
+ \fn void QSoundEffect::loopsRemainingChanged()
+
+ The \c loopsRemainingChanged signal is emitted when the remaining number of loops has changed.
+*/
+/*!
+ \qmlsignal QtMultimedia5::SoundEffect::loopsRemainingChanged()
+
+ The \c loopsRemainingChanged signal is emitted when the remaining number of loops has changed.
+
+ The corresponding handler is \c onLoopsRemainingChanged.
+*/
+
+/*!
+ \fn void QSoundEffect::volumeChanged()
+
+ The \c volumeChanged signal is emitted when the volume has changed.
+*/
+/*!
+ \qmlsignal QtMultimedia5::SoundEffect::volumeChanged()
+
+ The \c volumeChanged signal is emitted when the volume has changed.
+
+ The corresponding handler is \c onVolumeChanged.
+*/
+
+/*!
+ \fn void QSoundEffect::mutedChanged()
+
+ The \c mutedChanged signal is emitted when the mute state has changed.
+*/
+/*!
+ \qmlsignal QtMultimedia5::SoundEffect::mutedChanged()
+
+ The \c mutedChanged signal is emitted when the mute state has changed.
+
+ The corresponding handler is \c onMutedChanged.
+*/
+
+/*!
+ \fn void QSoundEffect::playingChanged()
+
+ The \c playingChanged signal is emitted when the playing property has changed.
+*/
+/*!
+ \qmlsignal QtMultimedia5::SoundEffect::playingChanged()
+
+ The \c playingChanged signal is emitted when the playing property has changed.
+
+ The corresponding handler is \c onPlayingChanged.
+*/
+
+/*!
+ \fn void QSoundEffect::statusChanged()
+
+ The \c statusChanged signal is emitted when the status property has changed.
+*/
+/*!
+ \qmlsignal QtMultimedia5::SoundEffect::statusChanged()
+
+ The \c statusChanged signal is emitted when the status property has changed.
+
+ The corresponding handler is \c onStatusChanged.
+*/
+
+/*!
+ \fn void QSoundEffect::categoryChanged()
+
+ The \c categoryChanged signal is emitted when the category property has changed.
+*/
+/*!
+ \qmlsignal QtMultimedia5::SoundEffect::categoryChanged()
+
+ The \c categoryChanged signal is emitted when the category property has changed.
+
+ The corresponding handler is \c onCategoryChanged.
+*/
+
+
QT_END_NAMESPACE
#include "moc_qsoundeffect.cpp"
diff --git a/src/multimedia/controls/qmediaavailabilitycontrol.h b/src/multimedia/controls/qmediaavailabilitycontrol.h
index 479db4916..16f46f0f0 100644
--- a/src/multimedia/controls/qmediaavailabilitycontrol.h
+++ b/src/multimedia/controls/qmediaavailabilitycontrol.h
@@ -52,6 +52,9 @@ QT_BEGIN_NAMESPACE
QT_MODULE(Multimedia)
+// Required for QDoc workaround
+class QString;
+
class Q_MULTIMEDIA_EXPORT QMediaAvailabilityControl : public QMediaControl
{
Q_OBJECT
diff --git a/src/multimedia/gsttools_headers/qgstreamermessage_p.h b/src/multimedia/gsttools_headers/qgstreamermessage_p.h
index 967618245..1a600109e 100644
--- a/src/multimedia/gsttools_headers/qgstreamermessage_p.h
+++ b/src/multimedia/gsttools_headers/qgstreamermessage_p.h
@@ -59,6 +59,9 @@
QT_BEGIN_NAMESPACE
+// Required for QDoc workaround
+class QString;
+
class QGstreamerMessage
{
public:
diff --git a/src/multimedia/playback/qmediaplaylist.cpp b/src/multimedia/playback/qmediaplaylist.cpp
index 354527541..928023e1d 100644
--- a/src/multimedia/playback/qmediaplaylist.cpp
+++ b/src/multimedia/playback/qmediaplaylist.cpp
@@ -284,7 +284,7 @@ QMediaContent QMediaPlaylist::currentMedia() const
Returned value depends on the size of playlist, current position
and playback mode.
- \sa QMediaPlaylist::playbackMode
+ \sa QMediaPlaylist::playbackMode(), previousIndex()
*/
int QMediaPlaylist::nextIndex(int steps) const
{
@@ -295,7 +295,7 @@ int QMediaPlaylist::nextIndex(int steps) const
Returns the index of the item, which would be current after calling previous()
\a steps times.
- \sa QMediaPlaylist::playbackMode
+ \sa QMediaPlaylist::playbackMode(), nextIndex()
*/
int QMediaPlaylist::previousIndex(int steps) const
diff --git a/src/multimedia/qmediaserviceproviderplugin.h b/src/multimedia/qmediaserviceproviderplugin.h
index 346a4438c..ea8003754 100644
--- a/src/multimedia/qmediaserviceproviderplugin.h
+++ b/src/multimedia/qmediaserviceproviderplugin.h
@@ -57,6 +57,9 @@ QT_BEGIN_NAMESPACE
QT_MODULE(Multimedia)
+// Required for QDoc workaround
+class QString;
+
class QMediaService;
class QMediaServiceProviderHintPrivate;
@@ -104,6 +107,8 @@ private:
Q_DECLARE_OPERATORS_FOR_FLAGS(QMediaServiceProviderHint::Features)
+// Required for QDoc workaround
+class QString;
struct Q_MULTIMEDIA_EXPORT QMediaServiceProviderFactoryInterface
{
@@ -115,6 +120,8 @@ struct Q_MULTIMEDIA_EXPORT QMediaServiceProviderFactoryInterface
"org.qt-project.qt.mediaserviceproviderfactory/5.0"
Q_DECLARE_INTERFACE(QMediaServiceProviderFactoryInterface, QMediaServiceProviderFactoryInterface_iid)
+// Required for QDoc workaround
+class QString;
struct Q_MULTIMEDIA_EXPORT QMediaServiceSupportedFormatsInterface
{
@@ -127,6 +134,8 @@ struct Q_MULTIMEDIA_EXPORT QMediaServiceSupportedFormatsInterface
"org.qt-project.qt.mediaservicesupportedformats/5.0"
Q_DECLARE_INTERFACE(QMediaServiceSupportedFormatsInterface, QMediaServiceSupportedFormatsInterface_iid)
+// Required for QDoc workaround
+class QString;
struct Q_MULTIMEDIA_EXPORT QMediaServiceSupportedDevicesInterface
{
@@ -139,7 +148,8 @@ struct Q_MULTIMEDIA_EXPORT QMediaServiceSupportedDevicesInterface
"org.qt-project.qt.mediaservicesupporteddevices/5.0"
Q_DECLARE_INTERFACE(QMediaServiceSupportedDevicesInterface, QMediaServiceSupportedDevicesInterface_iid)
-
+// Required for QDoc workaround
+class QString;
struct Q_MULTIMEDIA_EXPORT QMediaServiceFeaturesInterface
{
@@ -152,6 +162,8 @@ struct Q_MULTIMEDIA_EXPORT QMediaServiceFeaturesInterface
"org.qt-project.qt.mediaservicefeatures/5.0"
Q_DECLARE_INTERFACE(QMediaServiceFeaturesInterface, QMediaServiceFeaturesInterface_iid)
+// Required for QDoc workaround
+class QString;
class Q_MULTIMEDIA_EXPORT QMediaServiceProviderPlugin : public QObject, public QMediaServiceProviderFactoryInterface
{
@@ -214,12 +226,8 @@ public:
*/
#define Q_MEDIASERVICE_AUDIODECODER "org.qt-project.qt.audiodecode"
-
-
QT_END_NAMESPACE
QT_END_HEADER
-
-
#endif // QMEDIASERVICEPROVIDERPLUGIN_H
diff --git a/src/multimedia/qtmedianamespace.cpp b/src/multimedia/qtmedianamespace.cpp
index c45f25fa1..2c4afdf18 100644
--- a/src/multimedia/qtmedianamespace.cpp
+++ b/src/multimedia/qtmedianamespace.cpp
@@ -187,6 +187,7 @@ Q_DEFINE_METADATA(ThumbnailImage);
/*!
\namespace QtMultimedia::MetaData
+ \inheaderfile qtmedianamespace.h
This namespace provides identifiers for meta-data attributes.