This sound fades another sound. More...

#include <Fader.h>

Inheritance diagram for Fader:

[legend]

Public Member Functions
	Fader (std::shared_ptr< ISound > sound, FadeType type=FADE_IN, double start=0, double length=1)
	Creates a new fader sound.

FadeType	getType () const
	Returns the fading type.

double	getStart () const
	Returns the fading start.

double	getLength () const
	Returns the fading length.

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 fades another sound.

If the fading type is FADE_IN, everything before the fading start will be silenced, for FADE_OUT that's true for everything after fading ends.

Constructor & Destructor Documentation

Creates a new fader sound.

Parameters

sound	The input sound.
type	The fading type.
start	The time where fading should start in seconds.
length	How long fading should last in seconds.

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

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