RioEngine  0.1
My first attempt to create a 3D WYSIWYG Game Engine
irrklang::IAudioStreamLoader Class Referenceabstract

Class which is able to create an audio file stream from a file. More...

#include <ik_IAudioStreamLoader.h>

Inheritance diagram for irrklang::IAudioStreamLoader:
irrklang::IRefCounted

Public Member Functions

virtual ~IAudioStreamLoader ()
 destructor More...
 
virtual bool isALoadableFileExtension (const ik_c8 *fileName)=0
 Returns true if the file maybe is able to be loaded by this class. More...
 
virtual IAudioStreamcreateAudioStream (IFileReader *file)=0
 Creates an audio file input stream from a file. More...
 
- Public Member Functions inherited from irrklang::IRefCounted
 IRefCounted ()
 Constructor. More...
 
virtual ~IRefCounted ()
 Destructor. More...
 
void grab ()
 
bool drop ()
 

Detailed Description

Class which is able to create an audio file stream from a file.

Definition at line 17 of file ik_IAudioStreamLoader.h.

Constructor & Destructor Documentation

virtual irrklang::IAudioStreamLoader::~IAudioStreamLoader ( )
inlinevirtual

destructor

Definition at line 22 of file ik_IAudioStreamLoader.h.

Member Function Documentation

virtual IAudioStream* irrklang::IAudioStreamLoader::createAudioStream ( IFileReader file)
pure virtual

Creates an audio file input stream from a file.

Returns
Pointer to the created audio stream. Returns 0 if loading failed. If you no longer need the stream, you should call IAudioFileStream::drop(). See IRefCounted::drop() for more information.
virtual bool irrklang::IAudioStreamLoader::isALoadableFileExtension ( const ik_c8 fileName)
pure virtual

Returns true if the file maybe is able to be loaded by this class.

This decision should be based only on the file extension (e.g. ".wav"). The given filename string is guaranteed to be lower case.


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