Audaspace 1.4.0
A high level audio library.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Delay Class Reference

This sound plays another sound delayed. More...

#include <Delay.h>

Inheritance diagram for Delay:
Inheritance graph
[legend]

Public Member Functions

 Delay (std::shared_ptr< ISound > sound, double delay=0)
 Creates a new delay sound.
 
double getDelay () const
 Returns the delay in seconds.
 
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.
 
virtual std::shared_ptr< IReadercreateReader ()=0
 Creates a reader for playback of the sound source.
 

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 plays another sound delayed.

Constructor & Destructor Documentation

◆ Delay()

Delay::Delay ( std::shared_ptr< ISound sound,
double  delay = 0 
)

Creates a new delay sound.

Parameters
soundThe input sound.
delayThe desired delay in seconds.

Member Function Documentation

◆ createReader()

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