| Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members |
#include <ik_IAudioStream.h>
Public Member Functions | |
| virtual SAudioStreamFormat | getFormat ()=0 |
| returns format of the audio stream | |
| virtual bool | getIsSeekingSupported () |
| returns true if the audio stream is seekable | |
| virtual ik_s32 | readFrames (void *target, ik_s32 frameCountToRead)=0 |
| tells the audio stream to read frameCountToRead audio frames into the specified buffer | |
| virtual bool | setPosition (ik_s32 pos)=0 |
| sets the position of the audio stream. | |
| virtual | ~IAudioStream () |
| destructor | |
Definition at line 16 of file ik_IAudioStream.h.
| virtual irrklang::IAudioStream::~IAudioStream | ( | ) | [inline, virtual] |
| virtual SAudioStreamFormat irrklang::IAudioStream::getFormat | ( | ) | [pure virtual] |
returns format of the audio stream
| virtual bool irrklang::IAudioStream::getIsSeekingSupported | ( | ) | [inline, virtual] |
| 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
| 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. |
| 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.
| pos,: | Position in frames. |
 |
The irrKlang
Engine Documentation © 2003-2007 by Nikolaus Gebhardt. Generated
on Sun Oct 12 13:44:50 2008 by Doxygen
(1.5.4) |