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>
This commit is contained in:
committed by
Qt by Nokia
parent
80f37d2d80
commit
f5e3fdc4a7
@@ -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.
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
||||
Reference in New Issue
Block a user