diff options
| author | Michael Goddard <michael.goddard@nokia.com> | 2012-06-12 11:27:24 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-06-13 05:53:50 +0200 |
| commit | f5e3fdc4a72e1ab26342c4b97408928debc68551 (patch) | |
| tree | 9347329291a255be9cd993853b780589ff6a6106 /src/multimedia/controls | |
| parent | 80f37d2d80f16fd653c3e8076acf2865eae028d3 (diff) | |
Clarify documentation about QAudioDecoder::read and blocking.
It doesn't block - not safe to implement in all cases. Applications
can implement blocking semantics based on their usage of event loops
or threads.
Change-Id: If9a6b1ae7014df63a43989c4940524bc5eaae383
Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
Diffstat (limited to 'src/multimedia/controls')
| -rw-r--r-- | src/multimedia/controls/qaudiodecodercontrol.cpp | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/src/multimedia/controls/qaudiodecodercontrol.cpp b/src/multimedia/controls/qaudiodecodercontrol.cpp index f8e7a0f3f..a44824883 100644 --- a/src/multimedia/controls/qaudiodecodercontrol.cpp +++ b/src/multimedia/controls/qaudiodecodercontrol.cpp @@ -177,9 +177,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent): \fn QAudioDecoderControl::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 may block until a buffer is available or - the end of the media is reached + and false otherwise. */ /*! @@ -249,7 +247,8 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent): /*! \fn QAudioDecoderControl::read() - Read a buffer from the decoder. Returns invalid buffer on failure. + Attempts to read a buffer from the decoder, without blocking. Returns invalid buffer if there are + no decoded buffers available, or on error. */ /*! |