#include <plWin32Sound.h>

Inheritance diagram for plWin32Sound:

Public Types
enum	ChannelSelect { kLeftChannel, kRightChannel }
Public Types inherited from plSound
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
unsigned char	getChannel () const
void	setChannel (unsigned char channel)
Public Member Functions inherited from plSound
	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	fChannelSelect
Protected Attributes inherited from plSound
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 plWin32Sound::ChannelSelect

Enumerator:

kLeftChannel
kRightChannel

Member Function Documentation

unsigned char plWin32Sound::getChannel ( ) const

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

Reimplemented in plWin32GroupedSound.

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

Reimplemented in plWin32GroupedSound.