Add some recent things to the overview docs.

Also clean up a few other doc related bits and pieces.

Change-Id: I56714e1811e38a7225131c1d141430b49f5f509c
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
Michael Goddard
2012-02-08 23:48:58 +10:00
committed by Qt by Nokia
parent c77e442b99
commit db781f29e0
18 changed files with 276 additions and 18 deletions

View File

@@ -94,8 +94,10 @@ void QDeclarativeAttenuationModel::setName(const QString& name)
\since 5.0
\brief The AttenuationModelLinear element allows you to define a linear attenuation curve for
Sound element.
\ingroup qml-multimedia
\inmodule QtMultimedia
\ingroup multimedia_audioengine
\inherits Item
\preliminary
This element is part of the \bold{QtAudioEngine 1.0} module.
@@ -224,8 +226,10 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene
\since 5.0
\brief The AttenuationModelInverse element allows you to define a non-linear attenuation curve
for Sound element.
\ingroup qml-multimedia
\inmodule QtMultimedia
\ingroup multimedia_audioengine
\inherits Item
\preliminary
This element is part of the \bold{QtAudioEngine 1.0} module.

View File

@@ -50,8 +50,10 @@ QT_USE_NAMESPACE
\qmlclass AudioCategory QDeclarativeAudioCategory
\since 5.0
\brief The AudioCategory element allows you to control all active sound instances by group
\ingroup qml-multimedia
\inmodule QtMultimedia
\ingroup multimedia_audioengine
\inherits Item
\preliminary
This element is part of the \bold{QtAudioEngine 1.0} module.

View File

@@ -59,8 +59,10 @@ QT_USE_NAMESPACE
\qmlclass AudioEngine QDeclarativeAudioEngine
\since 5.0
\brief The AudioEngine element allows you to organize all your 3d audio content in one place.
\ingroup qml-multimedia
\inmodule QtMultimedia
\ingroup multimedia_audioengine
\inherits Item
\preliminary
This element is part of the \bold{QtAudioEngine 1.0} module.

View File

@@ -51,8 +51,10 @@ QT_USE_NAMESPACE
\qmlclass AudioListener QDeclarativeAudioListener
\since 5.0
\brief The AudioListener element allows you to control global listener parameters.
\ingroup qml-multimedia
\inmodule QtMultimedia
\ingroup multimedia_audioengine
\inherits Item
\preliminary
This element is part of the \bold{QtAudioEngine 1.0} module.

View File

@@ -53,8 +53,10 @@ QT_USE_NAMESPACE
\qmlclass AudioSample QDeclarativeAudioSample
\since 5.0
\brief The AudioSample element allows you to load audio samples, mostly wav file.
\ingroup qml-multimedia
\inmodule QtMultimedia
\ingroup multimedia_audioengine
\inherits Item
\preliminary
This element is part of the \bold{QtAudioEngine 1.0} module.

View File

@@ -55,8 +55,10 @@ QT_USE_NAMESPACE
So each time the playback of the same sound can be a slightly different even with the same
AudioSample.
\ingroup qml-multimedia
\inmodule QtMultimedia
\ingroup multimedia_audioengine
\inherits Item
\preliminary
This element is part of the \bold{QtAudioEngine 1.0} module.

View File

@@ -142,8 +142,10 @@ void QDeclarativeSoundCone::componentComplete()
\since 5.0
\brief The Sound element allows you to define a variety of samples and parameters to be used for
SoundInstance.
\ingroup qml-multimedia
\inmodule QtMultimedia
\ingroup multimedia_audioengine
\inherits Item
\preliminary
This element is part of the \bold{QtAudioEngine 1.0} module.

View File

@@ -54,8 +54,10 @@ QT_USE_NAMESPACE
\qmlclass SoundInstance QDeclarativeSoundInstance
\since 5.0
\brief The SoundInstance element allows you to play 3d audio content.
\ingroup qml-multimedia
\inmodule QtMultimedia
\ingroup multimedia_audioengine
\inherits Item
\preliminary
This element is part of the \bold{QtAudioEngine 1.0} module.

View File

@@ -151,14 +151,16 @@ bool QAudioProbe::setSource(QMediaObject *source)
/*!
Starts monitoring the given \a mediaRecorder.
Returns true on success.
If \a source is zero, this probe will be deactivated
and this function wil return true.
and this function will return true.
If the media recorder instance does not support monitoring
audio, this function will return false.
Any previously monitored objects will no longer be monitored.
Passing in the same object will be ignored, but
Passing in the same (valid) object will be ignored, but
monitoring will continue.
*/
bool QAudioProbe::setSource(QMediaRecorder *mediaRecorder)