Audaspace 1.5.0
A high level audio library.
No Matches
Public Member Functions | List of all members
Volume Class Reference

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

#include <Volume.h>

Inheritance diagram for Volume:
Inheritance graph

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< IReadercreateReader ()
 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< ISoundgetSound () 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< IReadergetReader () const
 Returns the reader created out of the sound.
- Protected Attributes inherited from Effect
std::shared_ptr< ISoundm_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::Volume ( std::shared_ptr< ISound > sound,
float volume )

Creates a new volume sound.

soundThe input sound.
volumeThe desired volume.

Member Function Documentation

◆ createReader()

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

Creates a reader for playback of the sound source.

A pointer to an IReader object or nullptr if there has been an error.
ExceptionAn exception may be thrown if there has been a more unexpected error during reader creation.

Implements ISound.

◆ getVolume()

float Volume::getVolume ( ) const

Returns the volume.

The current volume.

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