ScummVM API documentation
Audio::LoopableAudioStream Class Referenceabstract

#include <audiostream.h>

Inheritance diagram for Audio::LoopableAudioStream:
Audio::AudioStream Audio::LoopingAudioStream Audio::SubLoopingAudioStream

Public Member Functions

virtual uint getCompleteIterations () const =0
 
virtual void setRemainingIterations (uint loops)=0
 
- Public Member Functions inherited from Audio::AudioStream
virtual int readBuffer (int16 *buffer, const int numSamples)=0
 
virtual bool isStereo () const =0
 
virtual int getRate () const =0
 
virtual bool endOfData () const =0
 
virtual bool endOfStream () const
 

Detailed Description

Generic loopable audio stream. Subclasses of this are used to feed looping sampled audio data into ScummVM's audio mixer.

Member Function Documentation

◆ getCompleteIterations()

virtual uint Audio::LoopableAudioStream::getCompleteIterations ( ) const
pure virtual

Return the number of loops that the stream has played.

Implemented in Audio::SubLoopingAudioStream, and Audio::LoopingAudioStream.

◆ setRemainingIterations()

virtual void Audio::LoopableAudioStream::setRemainingIterations ( uint  loops)
pure virtual

Set the number of remaining loops the stream should play before stopping.

Implemented in Audio::SubLoopingAudioStream, and Audio::LoopingAudioStream.


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