irrklang::IAudioStreamLoader Class Reference

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

List of all members.

Public Member Functions

virtual ~IAudioStreamLoader ()
 destructor
virtual bool isALoadableFileExtension (const ik_c8 *fileName)=0
 Returns true if the file maybe is able to be loaded by this class.
virtual IAudioStreamcreateAudioStream (IFileReader *file)=0
 Creates an audio file input stream from a file.

Detailed Description

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


Constructor & Destructor Documentation

virtual irrklang::IAudioStreamLoader::~IAudioStreamLoader (  )  [inline, virtual]

destructor


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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines

irrKlang Audio Library
The irrKlang Engine Documentation © 2003-2014 by Nikolaus Gebhardt. Generated by Doxygen (1.6.1)