src/multimedia/audio/qaudioinput.cpp
changeset 30 5dc02b23752f
parent 25 e24348a560a6
equal deleted inserted replaced
29:b72c6db6890b 30:5dc02b23752f
   209      error() is set to QAudio::NoError and the stateChanged() signal is emitted.
   209      error() is set to QAudio::NoError and the stateChanged() signal is emitted.
   210 
   210 
   211      If a problem occurs during this process the error() is set to QAudio::OpenError,
   211      If a problem occurs during this process the error() is set to QAudio::OpenError,
   212      state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
   212      state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
   213 
   213 
   214     In either case, the stateChanged() signal may be emitted either synchronously
   214      \l{QAudioInput#Symbian Platform Security Requirements}
   215     during execution of the start() function or asynchronously after start() has
       
   216     returned to the caller.
       
   217 
       
   218      \sa {Symbian Platform Security Requirements}
       
   219 
   215 
   220      \sa QIODevice
   216      \sa QIODevice
   221 */
   217 */
   222 
   218 
   223 void QAudioInput::start(QIODevice* device)
   219 void QAudioInput::start(QIODevice* device)
   235     and the stateChanged() signal is emitted.
   231     and the stateChanged() signal is emitted.
   236 
   232 
   237     If a problem occurs during this process the error() is set to QAudio::OpenError,
   233     If a problem occurs during this process the error() is set to QAudio::OpenError,
   238     state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
   234     state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
   239 
   235 
   240     In either case, the stateChanged() signal may be emitted either synchronously
   236     \l{QAudioInput#Symbian Platform Security Requirements}
   241     during execution of the start() function or asynchronously after start() has
       
   242     returned to the caller.
       
   243 
       
   244     \sa {Symbian Platform Security Requirements}
       
   245 
   237 
   246     \sa QIODevice
   238     \sa QIODevice
   247 */
   239 */
   248 
   240 
   249 QIODevice* QAudioInput::start()
   241 QIODevice* QAudioInput::start()
   284 /*!
   276 /*!
   285     Stops processing audio data, preserving buffered audio data.
   277     Stops processing audio data, preserving buffered audio data.
   286 
   278 
   287     Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and
   279     Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and
   288     emit stateChanged() signal.
   280     emit stateChanged() signal.
   289 
       
   290     Note: signal will always be emitted during execution of the resume() function.
       
   291 */
   281 */
   292 
   282 
   293 void QAudioInput::suspend()
   283 void QAudioInput::suspend()
   294 {
   284 {
   295     d->suspend();
   285     d->suspend();
   308 {
   298 {
   309      d->resume();
   299      d->resume();
   310 }
   300 }
   311 
   301 
   312 /*!
   302 /*!
   313     Sets the audio buffer size to \a value bytes.
   303     Sets the audio buffer size to \a value milliseconds.
   314 
   304 
   315     Note: This function can be called anytime before start(), calls to this
   305     Note: This function can be called anytime before start(), calls to this
   316     are ignored after start(). It should not be assumed that the buffer size
   306     are ignored after start(). It should not be assumed that the buffer size
   317     set is the actual buffer size used, calling bufferSize() anytime after start()
   307     set is the actual buffer size used, calling bufferSize() anytime after start()
   318     will return the actual buffer size being used.
   308     will return the actual buffer size being used.
   323 {
   313 {
   324     d->setBufferSize(value);
   314     d->setBufferSize(value);
   325 }
   315 }
   326 
   316 
   327 /*!
   317 /*!
   328     Returns the audio buffer size in bytes.
   318     Returns the audio buffer size in milliseconds.
   329 
   319 
   330     If called before start(), returns platform default value.
   320     If called before start(), returns platform default value.
   331     If called before start() but setBufferSize() was called prior, returns value set by setBufferSize().
   321     If called before start() but setBufferSize() was called prior, returns value set by setBufferSize().
   332     If called after start(), returns the actual buffer size being used. This may not be what was set previously
   322     If called after start(), returns the actual buffer size being used. This may not be what was set previously
   333     by setBufferSize().
   323     by setBufferSize().