Audacity  3.0.3
Classes | Typedefs | Enumerations
EffectInterface.h File Reference
#include <functional>
#include "ComponentInterface.h"
#include "ComponentInterfaceSymbol.h"
#include "ConfigInterface.h"
#include "EffectAutomationParameters.h"
Include dependency graph for EffectInterface.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  EffectDefinitionInterface
 EffectDefinitionInterface is a ComponentInterface 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...
 

Typedefs

typedef enum EffectType EffectType
 
using EffectFamilySymbol = ComponentInterfaceSymbol
 
typedef enum ChannelNameChannelNames
 

Enumerations

enum  EffectType : int {
  EffectTypeNone, EffectTypeHidden, EffectTypeGenerate, EffectTypeProcess,
  EffectTypeAnalyze, EffectTypeTool
}
 
enum  ChannelName {
  ChannelNameEOL = -1, ChannelNameMono, ChannelNameFrontLeft, ChannelNameFrontRight,
  ChannelNameFrontCenter, ChannelNameLowFrequency1, ChannelNameBackLeft, ChannelNameBackRight,
  ChannelNameFrontLeftCenter, ChannelNameFrontRightCenter, ChannelNameBackCenter, ChannelNameLowFrequency2,
  ChannelNameSideLeft, ChannelNameSideRight, ChannelNameTopFrontLeft, ChannelNameTopFrontRight,
  ChannelNameTopFrontCenter, ChannelNameTopCenter, ChannelNameTopBackLeft, ChannelNameTopBackRight,
  ChannelNameTopSideLeft, ChannelNameTopSideRight, ChannelNameTopBackCenter, ChannelNameBottomFrontCenter,
  ChannelNameBottomFrontLeft, ChannelNameBottomFrontRight
}
 

Typedef Documentation

◆ ChannelNames

typedef enum ChannelName * ChannelNames

◆ EffectFamilySymbol

Definition at line 65 of file EffectInterface.h.

◆ EffectType

typedef enum EffectType EffectType

Enumeration Type Documentation

◆ ChannelName

Enumerator
ChannelNameEOL 
ChannelNameMono 
ChannelNameFrontLeft 
ChannelNameFrontRight 
ChannelNameFrontCenter 
ChannelNameLowFrequency1 
ChannelNameBackLeft 
ChannelNameBackRight 
ChannelNameFrontLeftCenter 
ChannelNameFrontRightCenter 
ChannelNameBackCenter 
ChannelNameLowFrequency2 
ChannelNameSideLeft 
ChannelNameSideRight 
ChannelNameTopFrontLeft 
ChannelNameTopFrontRight 
ChannelNameTopFrontCenter 
ChannelNameTopCenter 
ChannelNameTopBackLeft 
ChannelNameTopBackRight 
ChannelNameTopSideLeft 
ChannelNameTopSideRight 
ChannelNameTopBackCenter 
ChannelNameBottomFrontCenter 
ChannelNameBottomFrontLeft 
ChannelNameBottomFrontRight 

Definition at line 142 of file EffectInterface.h.

◆ EffectType

enum EffectType : int
Enumerator
EffectTypeNone 
EffectTypeHidden 
EffectTypeGenerate 
EffectTypeProcess 
EffectTypeAnalyze 
EffectTypeTool 

Definition at line 54 of file EffectInterface.h.

ChannelNameBackRight
@ ChannelNameBackRight
Definition: EffectInterface.h:154
EffectTypeProcess
@ EffectTypeProcess
Definition: EffectInterface.h:59
ChannelNameBottomFrontCenter
@ ChannelNameBottomFrontCenter
Definition: EffectInterface.h:170
ChannelNameTopFrontRight
@ ChannelNameTopFrontRight
Definition: EffectInterface.h:162
ChannelNameTopBackLeft
@ ChannelNameTopBackLeft
Definition: EffectInterface.h:165
ChannelNameFrontRight
@ ChannelNameFrontRight
Definition: EffectInterface.h:150
EffectTypeGenerate
@ EffectTypeGenerate
Definition: EffectInterface.h:58
EffectTypeNone
@ EffectTypeNone
Definition: EffectInterface.h:56
ChannelNameTopBackCenter
@ ChannelNameTopBackCenter
Definition: EffectInterface.h:169
ChannelNameFrontLeft
@ ChannelNameFrontLeft
Definition: EffectInterface.h:149
ChannelName
ChannelName
Definition: EffectInterface.h:143
ChannelNameEOL
@ ChannelNameEOL
Definition: EffectInterface.h:145
ChannelNameLowFrequency1
@ ChannelNameLowFrequency1
Definition: EffectInterface.h:152
ChannelNameTopFrontLeft
@ ChannelNameTopFrontLeft
Definition: EffectInterface.h:161
ChannelNameLowFrequency2
@ ChannelNameLowFrequency2
Definition: EffectInterface.h:158
ChannelNameTopFrontCenter
@ ChannelNameTopFrontCenter
Definition: EffectInterface.h:163
ChannelNameBottomFrontLeft
@ ChannelNameBottomFrontLeft
Definition: EffectInterface.h:171
ChannelNameBackLeft
@ ChannelNameBackLeft
Definition: EffectInterface.h:153
ChannelNameTopSideLeft
@ ChannelNameTopSideLeft
Definition: EffectInterface.h:167
EffectTypeTool
@ EffectTypeTool
Definition: EffectInterface.h:61
ChannelNameTopCenter
@ ChannelNameTopCenter
Definition: EffectInterface.h:164
EffectTypeHidden
@ EffectTypeHidden
Definition: EffectInterface.h:57
ChannelNames
enum ChannelName * ChannelNames
ChannelNameTopSideRight
@ ChannelNameTopSideRight
Definition: EffectInterface.h:168
ChannelNameTopBackRight
@ ChannelNameTopBackRight
Definition: EffectInterface.h:166
ChannelNameBackCenter
@ ChannelNameBackCenter
Definition: EffectInterface.h:157
ChannelNameBottomFrontRight
@ ChannelNameBottomFrontRight
Definition: EffectInterface.h:172
EffectTypeAnalyze
@ EffectTypeAnalyze
Definition: EffectInterface.h:60
ChannelNameSideRight
@ ChannelNameSideRight
Definition: EffectInterface.h:160
ChannelNameFrontLeftCenter
@ ChannelNameFrontLeftCenter
Definition: EffectInterface.h:155
ChannelNameFrontRightCenter
@ ChannelNameFrontRightCenter
Definition: EffectInterface.h:156
ChannelNameMono
@ ChannelNameMono
Definition: EffectInterface.h:147
EffectType
EffectType
Definition: EffectInterface.h:55
ChannelNameFrontCenter
@ ChannelNameFrontCenter
Definition: EffectInterface.h:151
ChannelNameSideLeft
@ ChannelNameSideLeft
Definition: EffectInterface.h:159