Audacity  2.2.2
Classes | Typedefs | Enumerations
EffectInterface.h File Reference
#include "audacity/Types.h"
#include "audacity/IdentInterface.h"
#include "audacity/ConfigInterface.h"
#include "audacity/EffectAutomationParameters.h"
#include <wx/dialog.h>

Go to the source code of this file.

Classes

class  ParamsInterface
 ParamsInterface provides a DefineParameters virtual function, that defines the parameters of the command. More...
 
class  CommandDefinitionInterface
 CommandDefinitionInterface is an IdentInterface (to name the command) along with a DefineParameters virtual function, that defines the parameters of the command. More...
 
class  EffectDefinitionInterface
 EffectDefinitionInterface is a CommandDefinitionInterface that additionally tracks flag-functions for interactivity, play-preview and whether the effect can run without a GUI. More...
 
class  EffectHostInterface
 EffectHostInterface is a decorator of a EffectUIClientInterface. It adds virtual (abstract) functions to get presets and actually apply the effect. It uses ConfigClientInterface to add Getters/setters for private and shared configs. More...
 
class  EffectClientInterface
 EffectClientInterface provides the ident interface to Effect, and is what makes Effect into a plug-in command. It has functions for realtime that are not part of AudacityCommand. More...
 
class  EffectUIHostInterface
 EffectUIHostInterface has nothing in it. It is provided so that an Effect can call SetHostUI passing in a pointer to an EffectUIHostInterface. It contains no functionality and is provided, apparently, for type checking. Since only EffectUIHost uses it, EffectUIHost could be used instead. More...
 
class  EffectUIClientInterface
 EffectUIClientInterface is an abstract base class to populate a UI and validate UI values. It can import and export presets. More...
 
class  EffectManagerInterface
 UNUSED. EffectManagerInterface provides a single function to find files matching a pattern in a list. More...
 

Typedefs

typedef enum EffectType EffectType
 
using NumericFormatId = IdentInterfaceSymbol
 

Enumerations

enum  EffectType {
  EffectTypeNone, EffectTypeHidden, EffectTypeGenerate, EffectTypeProcess,
  EffectTypeAnalyze, EffectTypeTool
}
 

Typedef Documentation

typedef enum EffectType EffectType

Definition at line 62 of file EffectInterface.h.

Enumeration Type Documentation

enum EffectType
Enumerator
EffectTypeNone 
EffectTypeHidden 
EffectTypeGenerate 
EffectTypeProcess 
EffectTypeAnalyze 
EffectTypeTool 

Definition at line 52 of file EffectInterface.h.