slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify documentation about QAudioDecoder::read and blocking.

Browse Source 
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>
This commit is contained in:
Michael Goddard
2012-06-12 11:27:24 +10:00
committed by Qt by Nokia
parent 80f37d2d80
commit f5e3fdc4a7
2 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/multimedia/audio/qaudiodecoder.cpp
View File

@@ -203,8 +203,8 @@ QString QAudioDecoder::errorString() const
when enough data has been decoded. Calling \l read() will then return when enough data has been decoded. Calling \l read() will then return
an audio buffer without blocking. an audio buffer without blocking.
Alternatively, if you wish to block until enough data has been decoded, If you call read() before a buffer is ready, an invalid buffer will
you can call read() at any time to block until a buffer is ready. be returned, again without blocking.
\sa read() \sa read()
*/ */
@@ -372,8 +372,7 @@ QtMultimedia::SupportEstimate QAudioDecoder::hasSupport(const QString &mimeType,
Returns true if a buffer is available to be read, Returns true if a buffer is available to be read,
and false otherwise. If there is no buffer available, calling and false otherwise. If there is no buffer available, calling
the \l read() function may block until a buffer is available or the \l read() function will return an invalid buffer.
the end of the media is reached
*/ */
bool QAudioDecoder::bufferAvailable() const bool QAudioDecoder::bufferAvailable() const
{ {
@@ -410,7 +409,13 @@ qint64 QAudioDecoder::duration() const
} }
/*! /*!
Read a buffer from the decoder. Returns invalid buffer on failure. Read a buffer from the decoder, if one is available. Returns an invalid buffer
if there are no decoded buffers currently available, or on failure. In both cases
this function will not block.
You should either respond to the \l bufferReady() signal or check the
\l bufferAvailable() function before calling read() to make sure
you get useful data.
*/ */
QAudioBuffer QAudioDecoder::read() const QAudioBuffer QAudioDecoder::read() const

7
src/multimedia/controls/qaudiodecodercontrol.cpp
View File

@@ -177,9 +177,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
\fn QAudioDecoderControl::bufferAvailable() const \fn QAudioDecoderControl::bufferAvailable() const
Returns true if a buffer is available to be read, Returns true if a buffer is available to be read,
and false otherwise. If there is no buffer available, calling and false otherwise.
the \l read() function may block until a buffer is available or
the end of the media is reached
*/ */
/*! /*!
@@ -249,7 +247,8 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
/*! /*!
\fn QAudioDecoderControl::read() \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.
*/ */
/*! /*!