Sound::QueuingAudioStream Class Reference

#include <audiostream.h>

Inheritance diagram for Sound::QueuingAudioStream:

Collaboration diagram for Sound::QueuingAudioStream:

Public Member Functions
virtual void	queueAudioStream (AudioStream *audStream, bool disposeAfterUse=true)=0
	Queue an audio stream for playback. More...
virtual void	finish ()=0
	Mark this stream as finished. More...
virtual bool	isFinished () const =0
	Is the stream marked as finished? More...
virtual size_t	numQueuedStreams () const =0
	Return the number of streams still queued for playback (including the currently playing stream). More...
Public Member Functions inherited from Sound::AudioStream
virtual	~AudioStream ()
virtual size_t	readBuffer (int16 *buffer, const size_t numSamples)=0
	Fill the given buffer with up to numSamples samples. More...
virtual int	getChannels () const =0
	Return the number channels in this stream. More...
virtual int	getRate () const =0
	Sample rate of the stream. More...
virtual bool	endOfData () const =0
	End of data reached? If this returns true, it means that at this time there is no data available in the stream. More...
virtual bool	endOfStream () const
	End of stream reached? If this returns true, it means that all data in this stream is used up and no additional data will appear in it in the future. More...

Additional Inherited Members
Static Public Attributes inherited from Sound::AudioStream
static const size_t	kSizeInvalid = SIZE_MAX

Detailed Description

Definition at line 229 of file audiostream.h.

Member Function Documentation

finish()

virtual void Sound::QueuingAudioStream::finish ( )

pure virtual

Mark this stream as finished.

That is, signal that no further data will be queued to it. Only after this has been done can this stream ever 'end'.

Implemented in Sound::QueuingAudioStreamImpl.

Referenced by Sound::AACDecoder::decodeFrame().

Here is the caller graph for this function:

isFinished()

virtual bool Sound::QueuingAudioStream::isFinished ( ) const

pure virtual

Is the stream marked as finished?

Implemented in Sound::QueuingAudioStreamImpl.

numQueuedStreams()

virtual size_t Sound::QueuingAudioStream::numQueuedStreams ( ) const

pure virtual

Return the number of streams still queued for playback (including the currently playing stream).

Implemented in Sound::QueuingAudioStreamImpl.

queueAudioStream()

virtual void Sound::QueuingAudioStream::queueAudioStream ( AudioStream *  audStream, bool  disposeAfterUse = true  )

pure virtual

Queue an audio stream for playback.

This stream plays all queued streams, in the order they were queued. If disposeAfterUse is set to DisposeAfterUse::YES, then the queued stream is deleted after all data contained in it has been played.

Implemented in Sound::QueuingAudioStreamImpl.

Referenced by Sound::AACDecoder::decodeFrame().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• src/sound/audiostream.h