plSoundBuffer Class Reference

#include <plSoundBuffer.h>

Inheritance diagram for plSoundBuffer:

Public Types
enum	Flags {   kIsExternal = 0x1, kAlwaysExternal = 0x2, kOnlyLeftChannel = 0x4, kOnlyRightChannel = 0x8,   kStreamCompressed = 0x10 }

Public Member Functions
	plSoundBuffer ()
virtual	~plSoundBuffer ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const plWAVHeader &	getHeader () const
plWAVHeader &	getHeader ()
plString	getFileName () const
unsigned int	getFlags () const
size_t	getDataLength () const
unsigned char *	getData () const
void	setFileName (const plString &name)
void	setFlags (unsigned int flags)
void	setData (size_t length, const unsigned char *data)
Public Member Functions inherited from hsKeyedObject
void	init (const plString &name)
plKey	getKey () const
void	setKey (plKey key)
Public Member Functions inherited from plCreatable
	plCreatable ()
virtual	~plCreatable ()
virtual short	ClassIndex () const =0
short	ClassIndex (PlasmaVer ver) const
virtual const char *	ClassName () const
virtual bool	ClassInstance (short) const
virtual bool	isStub () const
virtual void	prcWrite (pfPrcHelper *prc)
virtual void	prcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Member Functions
virtual void	IPrcWrite (pfPrcHelper *prc)
virtual void	IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes
plWAVHeader	fHeader
plString	fFileName
size_t	fDataLength
unsigned char *	fData
unsigned int	fFlags

Member Enumeration Documentation

enum plSoundBuffer::Flags

Enumerator:

kIsExternal
kAlwaysExternal
kOnlyLeftChannel
kOnlyRightChannel
kStreamCompressed

Constructor & Destructor Documentation

plSoundBuffer::plSoundBuffer

(

)

virtual plSoundBuffer::~plSoundBuffer ( )

virtual

Member Function Documentation

unsigned char* plSoundBuffer::getData

(

)

const

size_t plSoundBuffer::getDataLength

(

)

const

plString plSoundBuffer::getFileName

(

)

const

unsigned int plSoundBuffer::getFlags

(

)

const

const plWAVHeader& plSoundBuffer::getHeader

(

)

const

plWAVHeader& plSoundBuffer::getHeader

(

)

virtual void plSoundBuffer::IPrcParse ( const pfPrcTag *  tag, plResManager *  mgr  )

protectedvirtual

This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.

Reimplemented from hsKeyedObject.

virtual void plSoundBuffer::IPrcWrite ( pfPrcHelper *  prc )

protectedvirtual

This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().

Reimplemented from hsKeyedObject.

virtual void plSoundBuffer::read ( hsStream *  , plResManager *    )

virtual

Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.

Reimplemented from hsKeyedObject.

void plSoundBuffer::setData	(	size_t	length,
		const unsigned char *	data
	)

void plSoundBuffer::setFileName

(

const plString &

name

)

void plSoundBuffer::setFlags

(

unsigned int

flags

)

virtual void plSoundBuffer::write ( hsStream *  , plResManager *    )

virtual

Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.

Reimplemented from hsKeyedObject.

Member Data Documentation

unsigned char* plSoundBuffer::fData

protected

size_t plSoundBuffer::fDataLength

protected

plString plSoundBuffer::fFileName

protected

unsigned int plSoundBuffer::fFlags

protected

plWAVHeader plSoundBuffer::fHeader

protected

---

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

• core/PRP/Audio/plSoundBuffer.h