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

This sound creates an envelope follower reader. More...

#include <Envelope.h>

Inheritance diagram for Envelope:
Inheritance graph
[legend]

Public Member Functions

 Envelope (std::shared_ptr< ISound > sound, float attack, float release, float threshold, float arthreshold)
 Creates a new envelope sound.
 
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.
 

Static Public Member Functions

static sample_t AUD_LOCAL envelopeFilter (CallbackIIRFilterReader *reader, EnvelopeParameters *param)
 The envelopeFilter function implements the doFilterIIR callback for the callback IIR filter.
 
static void AUD_LOCAL endEnvelopeFilter (EnvelopeParameters *param)
 The endEnvelopeFilter function implements the endFilterIIR callback for the callback IIR filter.
 

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 creates an envelope follower reader.

Constructor & Destructor Documentation

◆ Envelope()

Envelope::Envelope ( std::shared_ptr< ISound > sound,
float attack,
float release,
float threshold,
float arthreshold )

Creates a new envelope sound.

Parameters
soundThe input sound.
attackThe attack value in seconds.
releaseThe release value in seconds.
thresholdThe threshold value.
arthresholdThe attack/release threshold value.

Member Function Documentation

◆ createReader()

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

◆ endEnvelopeFilter()

static void AUD_LOCAL Envelope::endEnvelopeFilter ( EnvelopeParameters * param)
static

The endEnvelopeFilter function implements the endFilterIIR callback for the callback IIR filter.

Parameters
paramThe envelope parameters.

◆ envelopeFilter()

static sample_t AUD_LOCAL Envelope::envelopeFilter ( CallbackIIRFilterReader * reader,
EnvelopeParameters * param )
static

The envelopeFilter function implements the doFilterIIR callback for the callback IIR filter.

Parameters
readerThe CallbackIIRFilterReader that executes the callback.
paramThe envelope parameters.
Returns
The filtered sample.

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