SoundManagerMsg Struct Reference

A small header that preceeds data sent by SoundManager between processes. More...

#include <SoundManagerMsg.h>

---

Detailed Description

A small header that preceeds data sent by SoundManager between processes.

Definition at line 8 of file SoundManagerMsg.h.

List of all members.

Private Types
enum	MsgType { add, del, wakeup, unknown }
	Denotes what type of message this is. More...
typedef unsigned short	Snd_ID
	the type to use when referring to Sounds
Private Member Functions
	SoundManagerMsg ()
	constructor
virtual	~SoundManagerMsg ()
	virtual destructor
Snd_ID	getID () const
	Accessor for the id number, set by SoundManager.
void	setAdd (Snd_ID sndid, unsigned int sndsn)
	Sets up the header as an add message.
void	setDelete (RCRegion *rcregion)
	Sets up the header as an erase message.
void	setWakeup ()
	Sets up the header as a wakeup message.
	SoundManagerMsg (const SoundManagerMsg &)
	don't call
SoundManagerMsg	operator= (const SoundManagerMsg &)
	don't call
Private Attributes
enum SoundManagerMsg::MsgType	type
	Denotes what type of message this is.
Snd_ID	id
	The id of the sound this is in reference to.
RCRegion *	region
	The RCRegion to free, if it's a deletion.
unsigned int	sn
	The serial number of the sound this is in reference to, see SoundManager::sn.
Friends
class	SoundManager

---

Member Typedef Documentation

typedef unsigned short SoundManagerMsg::Snd_ID [private]

the type to use when referring to Sounds

Definition at line 13 of file SoundManagerMsg.h.

---

Member Enumeration Documentation

enum SoundManagerMsg::MsgType [private]

Denotes what type of message this is.

Enumerator:

add	indicates a new sound to be played
del	indicates the sound with id should be stopped
wakeup	indicates that it's time to start sending sounds to the system
unknown	initial value for type until one of the others is assigned

Definition at line 16 of file SoundManagerMsg.h.

---

Constructor & Destructor Documentation

SoundManagerMsg::SoundManagerMsg

(

)

[private]

constructor

Definition at line 33 of file SoundManagerMsg.h.

virtual SoundManagerMsg::~SoundManagerMsg

(

)

[private, virtual]

virtual destructor

doesn't do anything, but don't remove it, otherwise this would no longer be a virtual base class

Definition at line 37 of file SoundManagerMsg.h.

SoundManagerMsg::SoundManagerMsg

(

const SoundManagerMsg &

)

[private]

don't call

---

Member Function Documentation

Snd_ID SoundManagerMsg::getID

(

)

const [private]

Accessor for the id number, set by SoundManager.

Definition at line 40 of file SoundManagerMsg.h.

Referenced by SoundManager::loadBuffer().

SoundManagerMsg SoundManagerMsg::operator=

(

const SoundManagerMsg &

)

[private]

don't call

void SoundManagerMsg::setAdd	(	Snd_ID	sndid,
		unsigned int	sndsn
	)			[private]

Sets up the header as an add message.

Definition at line 43 of file SoundManagerMsg.h.

Referenced by SoundManager::loadBuffer().

void SoundManagerMsg::setDelete

(

RCRegion *

rcregion

)

[private]

Sets up the header as an erase message.

Definition at line 50 of file SoundManagerMsg.h.

Referenced by SoundManager::release().

void SoundManagerMsg::setWakeup

(

)

[private]

Sets up the header as a wakeup message.

Definition at line 56 of file SoundManagerMsg.h.

Referenced by SoundManager::play(), and SoundManager::resumePlay().

---

Friends And Related Function Documentation

friend class SoundManager [friend]

Definition at line 10 of file SoundManagerMsg.h.

---

Member Data Documentation

Snd_ID SoundManagerMsg::id [private]

The id of the sound this is in reference to.

Definition at line 24 of file SoundManagerMsg.h.

Referenced by getID(), and SoundManager::ProcessMsg().

RCRegion* SoundManagerMsg::region [private]

The RCRegion to free, if it's a deletion.

Definition at line 27 of file SoundManagerMsg.h.

Referenced by SoundManager::ProcessMsg().

unsigned int SoundManagerMsg::sn [private]

The serial number of the sound this is in reference to, see SoundManager::sn.

Definition at line 30 of file SoundManagerMsg.h.

Referenced by SoundManager::ProcessMsg(), and setAdd().

enum SoundManagerMsg::MsgType SoundManagerMsg::type [private]

Denotes what type of message this is.

indicates how this message should be processed

Referenced by SoundManager::ProcessMsg(), setAdd(), setDelete(), and setWakeup().

---

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

• SoundManagerMsg.h