Guiliani  Version 2.5 revision 7293 (documentation build 13)
FileLoader::WaveLoader Class Reference

#include <WaveLoader.h>

Classes

struct  DataChunk_t
 Structure of data chunk of wave-file. More...
 
struct  FormatChunk_t
 Structure of format chunk of wave-file. More...
 

Public Member Functions

 WaveLoader ()
 Default constructor.
 
 ~WaveLoader ()
 Default destructor.
 
DataChunk_t GetWaveData () const
 
FormatChunk_t GetWaveFormat () const
 
eC_Bool Load (const eC_String &pkPath)
 
void Unload ()
 

Detailed Description

This class is internally used within sound wrappers to load wave-files

Member Function Documentation

◆ GetWaveData()

DataChunk_t FileLoader::WaveLoader::GetWaveData ( ) const
inline

Getter for internal sound buffer

Returns
Data of loaded wave-file

◆ GetWaveFormat()

FormatChunk_t FileLoader::WaveLoader::GetWaveFormat ( ) const
inline

Getter for internal format of loaded wave-file

Returns
Format of loaded wave-file

◆ Load()

eC_Bool FileLoader::WaveLoader::Load ( const eC_String &  pkPath)

Loads a wavefile and prepares the sound data for further use

Parameters
pkPathString with path to file to load
Returns
true, if file was successfully loaded, otherwise false

◆ Unload()

void FileLoader::WaveLoader::Unload ( )

Unload currently loaded wave-file and clear memory buffer


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