SoundQueue Class Reference

Used to put Sounds in a Queue and play them in the order they have been added. More...

#include <queue.h>

List of all members.

Public Member Functions
void	AddItem (const char *filename)
	Used to create a new.
void	AddItem (const char *filename)
	Used to create a new.
void	DeleteItem (SoundQueueItem *&item)
	Used to remove a.
void	DeleteItem (SoundQueueItem *&item)
	Used to remove a.
size_t	GetSize ()
	Returns elements still in the queue to be played.
size_t	GetSize ()
	Returns elements still in the queue to be played.
void	Purge ()
	Stops playback and purges all SoundQueueItem(s).
void	Purge ()
	Stops playback and purges all SoundQueueItem(s).
	SoundQueue (SoundControl *&ctrl, float vol)
	Constructor.
	SoundQueue (SoundControl *&ctrl, float vol)
	Constructor.
void	Work ()
	Checks if there are queued items which can be played.
void	Work ()
	Checks if there are queued items which can be played.
	~SoundQueue ()
	Destructor.
	~SoundQueue ()
	Destructor.

---

Detailed Description

Used to put Sounds in a Queue and play them in the order they have been added.

Definition at line 61 of file queue.h.

---

Constructor & Destructor Documentation

SoundQueue::SoundQueue	(	SoundControl *&	ctrl,
		float	vol
	)

Constructor.

Parameters:

ctrl	a valid SoundControl
vol	volume as float

SoundQueue::~SoundQueue

(

)

Destructor.

SoundQueue::SoundQueue	(	SoundControl *&	ctrl,
		float	vol
	)

Constructor.

Parameters:

ctrl	a valid SoundControl
vol	volume as float

SoundQueue::~SoundQueue

(

)

Destructor.

---

Member Function Documentation

void SoundQueue::AddItem

(

const char *

filename

)

Used to create a new.

See also:

SoundQueueItem. Will create a new

SoundQueueItem and adds it to the Queue

Parameters:

filename

a unique (not enforced) filename

void SoundQueue::AddItem

(

const char *

filename

)

Used to create a new.

See also:

SoundQueueItem. Will create a new

SoundQueueItem and adds it to the Queue

Parameters:

filename

a unique (not enforced) filename

void SoundQueue::DeleteItem

(

SoundQueueItem *&

item

)

Used to remove a.

See also:

SoundQueueItem from the Queue. Will remove that

SoundQueueItem and deletes it from the Queue.

Parameters:

item	a valid SoundQueueItem

void SoundQueue::DeleteItem

(

SoundQueueItem *&

item

)

Used to remove a.

See also:

SoundQueueItem from the Queue. Will remove that

SoundQueueItem and deletes it from the Queue.

Parameters:

item	a valid SoundQueueItem

size_t SoundQueue::GetSize

(

)

Returns elements still in the queue to be played.

Returns:

The amount of elements still to be played which are in the queue.

size_t SoundQueue::GetSize

(

)

Returns elements still in the queue to be played.

Returns:

The amount of elements still to be played which are in the queue.

void SoundQueue::Purge

(

)

Stops playback and purges all SoundQueueItem(s).

void SoundQueue::Purge

(

)

Stops playback and purges all SoundQueueItem(s).

void SoundQueue::Work

(

)

Checks if there are queued items which can be played.

Walks over

See also:

queue and checks if there are items to play or to delete. Faulty Items will be removed.

void SoundQueue::Work

(

)

Checks if there are queued items which can be played.

Walks over

See also:

queue and checks if there are items to play or to delete. Faulty Items will be removed.

---

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

• common/sound/queue.h
• plugins/common/soundmanager/queue.h