This sound changes the volume of another sound. More...

#include <Volume.h>

Inheritance diagram for Volume:

[legend]

Public Member Functions
	Volume (std::shared_ptr< ISound > sound, float volume)
	Creates a new volume sound.
float	getVolume () const
	Returns the volume.
virtual std::shared_ptr< IReader >	createReader ()
	Creates a reader for playback of the sound source.
Public Member Functions inherited from Effect
	Effect (std::shared_ptr< ISound > sound)
	Creates a new sound.
virtual	~Effect ()
	Destroys the sound.
std::shared_ptr< ISound >	getSound () const
	Returns the saved sound.
Public Member Functions inherited from ISound
virtual	~ISound ()
	Destroys the sound.

Additional Inherited Members
Protected Member Functions inherited from Effect
std::shared_ptr< IReader >	getReader () const
	Returns the reader created out of the sound.
Protected Attributes inherited from Effect
std::shared_ptr< ISound >	m_sound
	If there is no reader it is created out of this sound.

Detailed Description

This sound changes the volume of another sound.

The set volume should be a value between 0.0 and 1.0, higher values at your own risk!

Constructor & Destructor Documentation

Volume::Volume	(	std::shared_ptr< ISound >	sound,
		float	volume )

Creates a new volume sound.

Parameters

sound	The input sound.
volume	The desired volume.

virtual std::shared_ptr< IReader > Volume::createReader ( )

virtual

Creates a reader for playback of the sound source.

Returns: A pointer to an IReader object or nullptr if there has been an error.

Exceptions

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

Implements ISound.

float Volume::getVolume ( ) const

Returns the volume.

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