This class allows to create a sound with its own volume. More...

Inheritance diagram for VolumeSound:

Public Member Functions
	VolumeSound (std::shared_ptr< ISound > sound, std::shared_ptr< VolumeStorage > volumeStorage)
	Creates a new VolumeSound.

virtual std::shared_ptr< IReader >	createReader ()
	Creates a reader for playback of the sound source.

std::shared_ptr< VolumeStorage >	getSharedVolume ()
	Retrieves the shared volume of this sound.

void	setSharedVolume (std::shared_ptr< VolumeStorage > volumeStorage)
	Changes the shared volume of this sound, it'll only affect newly created readers.

Public Member Functions inherited from ISound
virtual	~ISound ()
	Destroys the sound.

Detailed Description

This class allows to create a sound with its own volume.

Constructor & Destructor Documentation

VolumeSound::VolumeSound	(	std::shared_ptr< ISound >	sound,
		std::shared_ptr< VolumeStorage >	volumeStorage )

Creates a new VolumeSound.

Parameters

sound	The sound in which shall have its own volume.
volumeStorage	A shared pointer to a VolumeStorage object. It allows to change the volume of various sound in one go.

virtual std::shared_ptr< IReader > VolumeSound::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.

std::shared_ptr< VolumeStorage > VolumeSound::getSharedVolume ( )

Retrieves the shared volume of this sound.

Returns: A shared pointer to the VolumeStorage object that this sound is using.

void VolumeSound::setSharedVolume ( std::shared_ptr< VolumeStorage > volumeStorage )

Changes the shared volume of this sound, it'll only affect newly created readers.

Parameters

volumeStorage A shared pointer to the new VolumeStorage object.

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