AUD_VolumeFactory Class Reference

#include <AUD_VolumeFactory.h>

Inheritance diagram for AUD_VolumeFactory:

List of all members.

Public Member Functions
	AUD_VolumeFactory (AUD_Reference< AUD_IFactory > factory, float volume)
float	getVolume () const
virtual AUD_Reference < AUD_IReader >	createReader ()

---

Detailed Description

This factory changes the volume of another factory. The set volume should be a value between 0.0 and 1.0, higher values at your own risk!

Definition at line 40 of file AUD_VolumeFactory.h.

---

Constructor & Destructor Documentation

AUD_VolumeFactory::AUD_VolumeFactory	(	AUD_Reference< AUD_IFactory >	factory,
		float	volume
	)

Creates a new volume factory.

Parameters:

factory	The input factory.
volume	The desired volume.

Definition at line 33 of file AUD_VolumeFactory.cpp.

---

Member Function Documentation

AUD_Reference< AUD_IReader > AUD_VolumeFactory::createReader

(

)

[virtual]

Creates a reader for playback of the sound source.

Returns:

A pointer to an AUD_IReader object or NULL if there has been an error.

Exceptions:

AUD_Exception

An exception may be thrown if there has been a more unexpected error during reader creation.

Implements AUD_IFactory.

Definition at line 44 of file AUD_VolumeFactory.cpp.

References AUD_EffectFactory::getReader().

float AUD_VolumeFactory::getVolume

(

)

const

Returns the volume.

Returns:

The current volume.

Definition at line 39 of file AUD_VolumeFactory.cpp.

---

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

• AUD_VolumeFactory.h
• AUD_VolumeFactory.cpp