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

This sound fades another sound. More...

#include <Fader.h>

Inheritance diagram for Fader:
Inheritance graph

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< 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 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

◆ Fader()

Fader::Fader ( std::shared_ptr< ISound > sound,
FadeType type = FADE_IN,
double start = 0,
double length = 1 )

Creates a new fader sound.

soundThe input sound.
typeThe fading type.
startThe time where fading should start in seconds.
lengthHow long fading should last in seconds.

Member Function Documentation

◆ createReader()

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

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