src/multimedia/audio/qaudioinput.cpp
changeset 22 79de32ba3296
parent 19 fcece45ef507
child 25 e24348a560a6
--- a/src/multimedia/audio/qaudioinput.cpp	Mon May 03 13:17:34 2010 +0300
+++ b/src/multimedia/audio/qaudioinput.cpp	Fri May 14 16:40:13 2010 +0300
@@ -146,6 +146,20 @@
     \snippet doc/src/snippets/audio/main.cpp 0
 
     \sa QAudioOutput, QAudioDeviceInfo
+
+    \section1 Symbian Platform Security Requirements
+
+    On Symbian, processes which use this class must have the
+    \c UserEnvironment platform security capability.  If the client
+    process lacks this capability, calls to either overload of start()
+    will fail.
+    This failure is indicated by the QAudioInput object setting
+    its error() value to \l{QAudio::OpenError} and then emitting a
+    \l{stateChanged()}{stateChanged}(\l{QAudio::StoppedState}) signal.
+
+    Platform security capabilities are added via the
+    \l{qmake-variable-reference.html#target-capability}{TARGET.CAPABILITY}
+    qmake variable.
 */
 
 /*!
@@ -197,6 +211,8 @@
      If a problem occurs during this process the error() is set to QAudio::OpenError,
      state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
 
+     \sa {Symbian Platform Security Requirements}
+
      \sa QIODevice
 */
 
@@ -217,6 +233,8 @@
     If a problem occurs during this process the error() is set to QAudio::OpenError,
     state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
 
+    \sa {Symbian Platform Security Requirements}
+
     \sa QIODevice
 */