plSound Class Reference

#include <plSound.h>

Inheritance diagram for plSound:

Classes
class	plFadeParams

Public Types
enum	Property {   kPropIs3DSound = 0x1, kPropDisableLOD = 0x2, kPropLooping = 0x4, kPropAutoStart = 0x8,   kPropLocalOnly = 0x10, kPropLoadOnlyOnCall = 0x20, kPropFullyDisabled = 0x40, kPropDontFade = 0x80,   kPropIncidental = 0x100 }
enum	Type {   kStartType = 0, kSoundFX = kStartType, kAmbience, kBackgroundMusic,   kGUISound, kNPCVoices, kNumTypes }
enum	StreamType { kNoStream, kStreamFromRAM, kStreamFromDisk, kStreamCompressed }
Public Types inherited from plSynchedObject
enum	Flags {   kDontDirty = 0x1, kSendReliably = 0x2, kHasConstantNetGroup = 0x4, kDontSynchGameMessages = 0x8,   kExcludePersistentState = 0x10, kExcludeAllPersistentState = 0x20, kLocalOnly = kExcludeAllPersistentState | kDontSynchGameMessages, kHasVolatileState = 0x40,   kAllStateIsVolatile = 0x80 }
enum	SDLSendFlags {   kBCastToClients = 0x1, kForceFullSend = 0x2, kSkipLocalOwnershipCheck = 0x4, kSendImmediately = 0x8,   kDontPersistOnServer = 0x10, kUseRelevanceRegions = 0x20, kNewState = 0x40, kIsAvatarState = 0x80 }

Public Member Functions
	plSound ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
unsigned char	getType () const
unsigned char	getPriority () const
bool	isPlaying () const
double	getTime () const
int	getMaxFalloff () const
int	getMinFalloff () const
int	getOuterVol () const
int	getInnerCone () const
int	getOuterCone () const
float	getCurrVolume () const
float	getDesiredVolume () const
float	getFadedVolume () const
unsigned int	getProperties () const
plKey	getSoftRegion () const
plKey	getSoftOcclusionRegion () const
plKey	getDataBuffer () const
plString	getSubtitleId () const
void	setType (unsigned char type)
void	setPriority (unsigned char priority)
void	setPlaying (bool playing)
void	setTime (double time)
void	setFalloff (int min, int max)
void	setOuterVol (int vol)
void	setCone (int inner, int outer)
void	setCurrVolume (float vol)
void	setDesiredVolume (float vol)
void	setFadedVolume (float vol)
void	setProperties (unsigned int props)
void	setSoftRegion (plKey region)
void	setSoftOcclusionRegion (plKey region)
void	setDataBuffer (plKey buffer)
void	setSubtitleId (const plString &subtitle)
const plEAXSourceSettings &	getEAXSettings () const
const plFadeParams &	getFadeInParams () const
const plFadeParams &	getFadeOutParams () const
plEAXSourceSettings &	getEAXSettings ()
plFadeParams &	getFadeInParams ()
plFadeParams &	getFadeOutParams ()
Public Member Functions inherited from plSynchedObject
	plSynchedObject ()
int	getFlags () const
void	setFlags (int flags)
const std::vector< plString > &	getExcludes () const
const std::vector< plString > &	getVolatiles () const
void	setExclude (const plString &sdl)
void	setVolatile (const plString &sdl)
void	clearExcludes ()
void	clearVolatiles ()
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)
virtual void	IRead (hsStream *S, plResManager *mgr)
virtual void	IWrite (hsStream *S, plResManager *mgr)

Protected Attributes
unsigned char	fType
unsigned char	fPriority
bool	fPlaying
double	fTime
int	fMaxFalloff
int	fMinFalloff
int	fOuterVol
int	fInnerCone
int	fOuterCone
float	fCurrVolume
float	fDesiredVol
float	fFadedVolume
unsigned int	fProperties
plEAXSourceSettings	fEAXSettings
plFadeParams	fFadeInParams
plFadeParams	fFadeOutParams
plKey	fSoftRegion
plKey	fSoftOcclusionRegion
plKey	fDataBuffer
plString	fSubtitleId
Protected Attributes inherited from plSynchedObject
unsigned int	fSynchFlags
std::vector< plString >	fSDLExcludeList
std::vector< plString >	fSDLVolatileList

Member Enumeration Documentation

enum plSound::Property

Enumerator:

kPropIs3DSound
kPropDisableLOD
kPropLooping
kPropAutoStart
kPropLocalOnly
kPropLoadOnlyOnCall
kPropFullyDisabled
kPropDontFade
kPropIncidental

enum plSound::StreamType

Enumerator:

kNoStream
kStreamFromRAM
kStreamFromDisk
kStreamCompressed

enum plSound::Type

Enumerator:

kStartType
kSoundFX
kAmbience
kBackgroundMusic
kGUISound
kNPCVoices
kNumTypes

Constructor & Destructor Documentation

plSound::plSound

(

)

Member Function Documentation

float plSound::getCurrVolume

(

)

const

plKey plSound::getDataBuffer

(

)

const

float plSound::getDesiredVolume

(

)

const

const plEAXSourceSettings& plSound::getEAXSettings

(

)

const

plEAXSourceSettings& plSound::getEAXSettings

(

)

float plSound::getFadedVolume

(

)

const

const plFadeParams& plSound::getFadeInParams

(

)

const

plFadeParams& plSound::getFadeInParams

(

)

const plFadeParams& plSound::getFadeOutParams

(

)

const

plFadeParams& plSound::getFadeOutParams

(

)

int plSound::getInnerCone

(

)

const

int plSound::getMaxFalloff

(

)

const

int plSound::getMinFalloff

(

)

const

int plSound::getOuterCone

(

)

const

int plSound::getOuterVol

(

)

const

unsigned char plSound::getPriority

(

)

const

unsigned int plSound::getProperties

(

)

const

plKey plSound::getSoftOcclusionRegion

(

)

const

plKey plSound::getSoftRegion

(

)

const

plString plSound::getSubtitleId

(

)

const

double plSound::getTime

(

)

const

unsigned char plSound::getType

(

)

const

virtual void plSound::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 plSynchedObject.

Reimplemented in plDirectMusicSound, plWin32GroupedSound, and plWin32Sound.

virtual void plSound::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 plSynchedObject.

Reimplemented in plDirectMusicSound, plWin32GroupedSound, and plWin32Sound.

virtual void plSound::IRead ( hsStream *  S, plResManager *  mgr  )

protectedvirtual

Reimplemented in plWin32GroupedSound, and plWin32Sound.

bool plSound::isPlaying

(

)

const

virtual void plSound::IWrite ( hsStream *  S, plResManager *  mgr  )

protectedvirtual

Reimplemented in plWin32GroupedSound, and plWin32Sound.

virtual void plSound::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 plSynchedObject.

Reimplemented in plWin32LinkSound, and plDirectMusicSound.

void plSound::setCone	(	int	inner,
		int	outer
	)

void plSound::setCurrVolume

(

float

vol

)

void plSound::setDataBuffer

(

plKey

buffer

)

void plSound::setDesiredVolume

(

float

vol

)

void plSound::setFadedVolume

(

float

vol

)

void plSound::setFalloff	(	int	min,
		int	max
	)

void plSound::setOuterVol

(

int

vol

)

void plSound::setPlaying

(

bool

playing

)

void plSound::setPriority

(

unsigned char

priority

)

void plSound::setProperties

(

unsigned int

props

)

void plSound::setSoftOcclusionRegion

(

plKey

region

)

void plSound::setSoftRegion

(

plKey

region

)

void plSound::setSubtitleId

(

const plString &

subtitle

)

void plSound::setTime

(

double

time

)

void plSound::setType

(

unsigned char

type

)

virtual void plSound::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 plSynchedObject.

Reimplemented in plDirectMusicSound.

Member Data Documentation

float plSound::fCurrVolume

protected

plKey plSound::fDataBuffer

protected

float plSound::fDesiredVol

protected

plEAXSourceSettings plSound::fEAXSettings

protected

float plSound::fFadedVolume

protected

plFadeParams plSound::fFadeInParams

protected

plFadeParams plSound::fFadeOutParams

protected

int plSound::fInnerCone

protected

int plSound::fMaxFalloff

protected

int plSound::fMinFalloff

protected

int plSound::fOuterCone

protected

int plSound::fOuterVol

protected

bool plSound::fPlaying

protected

unsigned char plSound::fPriority

protected

unsigned int plSound::fProperties

protected

plKey plSound::fSoftOcclusionRegion

protected

plKey plSound::fSoftRegion

protected

plString plSound::fSubtitleId

protected

double plSound::fTime

protected

unsigned char plSound::fType

protected

---

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

• core/PRP/Audio/plSound.h