arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
AudioEffectCommon Class Reference

#include <AudioEffects.h>

Public Member Functions

void addEffect (AudioEffect &effect)
 Adds an effect object (by reference)
 
void addEffect (AudioEffect *effect)
 Adds an effect using a pointer.
 
void clear ()
 deletes all defined effects
 
AudioEffectfindEffect (int id)
 Finds an effect by id.
 
AudioEffectoperator[] (int idx)
 gets an effect by index
 
size_t size ()
 Provides the actual number of defined effects.
 

Protected Attributes

Vector< AudioEffect * > effects
 

Detailed Description

Common functionality for managing a collection of effects

Author
Phil Schatzmann

Member Function Documentation

◆ addEffect() [1/2]

void addEffect ( AudioEffect effect)
inline

Adds an effect object (by reference)

◆ addEffect() [2/2]

void addEffect ( AudioEffect effect)
inline

Adds an effect using a pointer.

◆ clear()

void clear ( )
inline

deletes all defined effects

◆ findEffect()

AudioEffect * findEffect ( int  id)
inline

Finds an effect by id.

◆ operator[]()

AudioEffect * operator[] ( int  idx)
inline

gets an effect by index

◆ size()

size_t size ( )
inline

Provides the actual number of defined effects.

Member Data Documentation

◆ effects

Vector<AudioEffect*> effects
protected

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