xoreos  0.0.5
Public Member Functions | Static Public Member Functions | List of all members
Sound::XACTWaveBank Class Referenceabstract

An abstract XACT WaveBank interface. More...

#include <xactwavebank.h>

Inheritance diagram for Sound::XACTWaveBank:
Inheritance graph
[legend]

Public Member Functions

virtual ~XACTWaveBank ()
 
virtual const Common::UStringgetName () const =0
 Return the internal name of the WaveBank. More...
 
virtual bool isStreaming () const =0
 Is this WaveBank rating for streaming, or in-memory play? More...
 
virtual size_t getWaveCount () const =0
 Return the number of wave files. More...
 
virtual RewindableAudioStreamgetWave (size_t index) const =0
 Return the audio stream of a wave. More...
 

Static Public Member Functions

static XACTWaveBankload (const Common::UString &name)
 Load an XACT WaveBank, of either ASCII or Binary format. More...
 

Detailed Description

An abstract XACT WaveBank interface.

This interface allows us to treat both binary and ASCII variants of the XWB file the same.

See also xactwavebank_binary.h for the original Xbox version of the XWB file and xactwavebank_ascii.h for the textual representation.

Definition at line 46 of file xactwavebank.h.

Constructor & Destructor Documentation

◆ ~XACTWaveBank()

virtual Sound::XACTWaveBank::~XACTWaveBank ( )
inlinevirtual

Definition at line 48 of file xactwavebank.h.

Member Function Documentation

◆ getName()

virtual const Common::UString& Sound::XACTWaveBank::getName ( ) const
pure virtual

Return the internal name of the WaveBank.

Implemented in Sound::XACTWaveBank_Binary, and Sound::XACTWaveBank_ASCII.

◆ getWave()

virtual RewindableAudioStream* Sound::XACTWaveBank::getWave ( size_t  index) const
pure virtual

Return the audio stream of a wave.

Implemented in Sound::XACTWaveBank_Binary, and Sound::XACTWaveBank_ASCII.

◆ getWaveCount()

virtual size_t Sound::XACTWaveBank::getWaveCount ( ) const
pure virtual

Return the number of wave files.

Implemented in Sound::XACTWaveBank_Binary, and Sound::XACTWaveBank_ASCII.

◆ isStreaming()

virtual bool Sound::XACTWaveBank::isStreaming ( ) const
pure virtual

Is this WaveBank rating for streaming, or in-memory play?

Implemented in Sound::XACTWaveBank_Binary, and Sound::XACTWaveBank_ASCII.

◆ load()

XACTWaveBank * Sound::XACTWaveBank::load ( const Common::UString name)
static

Load an XACT WaveBank, of either ASCII or Binary format.

Definition at line 35 of file xactwavebank.cpp.

References Common::StackException::add(), Common::UString::c_str(), Aurora::kFileTypeTXT, Aurora::kFileTypeXWB, and ResMan.

Referenced by Engines::Jade::Game::run().

Here is the call graph for this function:
Here is the caller graph for this function:

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