irrklang::IAudioStream Class Reference

Reads and decodes audio data into an usable audio stream for the ISoundEngine. More...

#include <ik_IAudioStream.h>

Inheritance diagram for irrklang::IAudioStream:

Public Member Functions
virtual	~IAudioStream ()
	destructor More...
virtual SAudioStreamFormat	getFormat ()=0
	returns format of the audio stream More...
virtual bool	setPosition (ik_s32 pos)=0
	sets the position of the audio stream. More...
virtual bool	getIsSeekingSupported ()
	returns true if the audio stream is seekable More...
virtual ik_s32	readFrames (void *target, ik_s32 frameCountToRead)=0
	tells the audio stream to read frameCountToRead audio frames into the specified buffer More...
Public Member Functions inherited from irrklang::IRefCounted
	IRefCounted ()
	Constructor. More...
virtual	~IRefCounted ()
	Destructor. More...
void	grab ()
bool	drop ()

Detailed Description

Reads and decodes audio data into an usable audio stream for the ISoundEngine.

Definition at line 16 of file ik_IAudioStream.h.

Constructor & Destructor Documentation

virtual irrklang::IAudioStream::~IAudioStream ( )

inlinevirtual

destructor

Definition at line 21 of file ik_IAudioStream.h.

Member Function Documentation

virtual SAudioStreamFormat irrklang::IAudioStream::getFormat ( )

pure virtual

returns format of the audio stream

virtual bool irrklang::IAudioStream::getIsSeekingSupported ( )

inlinevirtual

returns true if the audio stream is seekable

Definition at line 35 of file ik_IAudioStream.h.

virtual ik_s32 irrklang::IAudioStream::readFrames ( void *  target, ik_s32  frameCountToRead  )

pure virtual

tells the audio stream to read frameCountToRead audio frames into the specified buffer

Parameters

target	Target data buffer to the method will write the read frames into. The specified buffer will be at least getFormat().getFrameSize()*frameCountToRead bytes big.
frameCountToRead	amount of frames to be read.

Returns

Returns amount of frames really read. Should be frameCountToRead in most cases.

virtual bool irrklang::IAudioStream::setPosition ( ik_s32  pos )

pure virtual

sets the position of the audio stream.

For example to let the stream be read from the beginning of the file again, setPosition(0) would be called. This is usually done be the sound engine to loop a stream after if has reached the end. Return true if sucessful and 0 if not.

Parameters

pos	Position in frames.

---

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

• g:/rioengine/libs/include/irrklang/ik_IAudioStream.h