summaryrefslogtreecommitdiffstats
path: root/src/multimedia/audio/qaudioprobe.cpp
diff options
context:
space:
mode:
authorMichael Goddard <michael.goddard@nokia.com>2012-02-08 23:48:58 +1000
committerQt by Nokia <qt-info@nokia.com>2012-02-09 01:33:18 +0100
commitdb781f29e0ccc1fa83f405a308aef73589ca3736 (patch)
treeced5c28d3d70da841f8e0e0794515f138b499281 /src/multimedia/audio/qaudioprobe.cpp
parentc77e442b9947fb9e7101cd2d9c6df236b5840dd6 (diff)
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>
Diffstat (limited to 'src/multimedia/audio/qaudioprobe.cpp')
-rw-r--r--src/multimedia/audio/qaudioprobe.cpp6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/multimedia/audio/qaudioprobe.cpp b/src/multimedia/audio/qaudioprobe.cpp
index e51c56a7c..9a71b65d6 100644
--- a/src/multimedia/audio/qaudioprobe.cpp
+++ b/src/multimedia/audio/qaudioprobe.cpp
@@ -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)