ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Audio::QueuingAudioStream Class Reference

#include <audiostream.h>

Inheritance diagram for Audio::QueuingAudioStream:
Collaboration diagram for Audio::QueuingAudioStream:

List of all members.

Public Member Functions

virtual void queueAudioStream (Audio::AudioStream *audStream, DisposeAfterUse::Flag disposeAfterUse=DisposeAfterUse::YES)=0
 Queue an audio stream for playback.
void queueBuffer (byte *data, uint32 size, DisposeAfterUse::Flag disposeAfterUse, byte flags)
 Queue a block of raw audio data for playback.
virtual void finish ()=0
 Mark this stream as finished.
virtual uint32 numQueuedStreams () const =0
 Return the number of streams still queued for playback (including the currently playing stream).

Detailed Description

Definition at line 308 of file audiostream.h.


Member Function Documentation

virtual void Audio::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 Audio::QueuingAudioStreamImpl.

virtual uint32 Audio::QueuingAudioStream::numQueuedStreams (  )  const [pure virtual]

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

Implemented in Audio::QueuingAudioStreamImpl.

virtual void Audio::QueuingAudioStream::queueAudioStream ( Audio::AudioStream audStream,
DisposeAfterUse::Flag  disposeAfterUse = DisposeAfterUse::YES 
) [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 Audio::QueuingAudioStreamImpl.

void Audio::QueuingAudioStream::queueBuffer ( byte data,
uint32  size,
DisposeAfterUse::Flag  disposeAfterUse,
byte  flags 
)

Queue a block of raw audio data for playback.

This stream plays all queued block, in the order they were queued. If disposeAfterUse is set to DisposeAfterUse::YES, then the queued block is released using free() after all data contained in it has been played.

Note:
Make sure to allocate the data block with malloc(), not with new[].
Parameters:
data pointer to the audio data block
size length of the audio data block
disposeAfterUse if equal to DisposeAfterUse::YES, the block is released using free() after use.
flags a bit-ORed combination of RawFlags describing the audio data format

Definition at line 277 of file audiostream.cpp.


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


Generated on Sat Mar 16 2019 05:05:19 for ResidualVM by doxygen 1.7.1
curved edge   curved edge