Audacity  3.2.0
Classes | Typedefs | Enumerations
EffectInterface.h File Reference
#include "ComponentInterface.h"
#include "ComponentInterfaceSymbol.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 adds some basic read-only information about effect properties, and getting and setting of parameters. More...
 
class  EffectProcessor
 EffectClientInterface provides the ident interface to Effect, and is what makes Effect into a plug-in command. It has functions for effect calculations that are not part of AudacityCommand. 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 62 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 158 of file EffectInterface.h.

◆ EffectType

enum EffectType : int
Enumerator
EffectTypeNone 
EffectTypeHidden 
EffectTypeGenerate 
EffectTypeProcess 
EffectTypeAnalyze 
EffectTypeTool 

Definition at line 51 of file EffectInterface.h.

ChannelNameBackRight
@ ChannelNameBackRight
Definition: EffectInterface.h:170
EffectTypeProcess
@ EffectTypeProcess
Definition: EffectInterface.h:56
ChannelNameBottomFrontCenter
@ ChannelNameBottomFrontCenter
Definition: EffectInterface.h:186
ChannelNameTopFrontRight
@ ChannelNameTopFrontRight
Definition: EffectInterface.h:178
ChannelNameTopBackLeft
@ ChannelNameTopBackLeft
Definition: EffectInterface.h:181
ChannelNameFrontRight
@ ChannelNameFrontRight
Definition: EffectInterface.h:166
EffectTypeGenerate
@ EffectTypeGenerate
Definition: EffectInterface.h:55
EffectTypeNone
@ EffectTypeNone
Definition: EffectInterface.h:53
ChannelNameTopBackCenter
@ ChannelNameTopBackCenter
Definition: EffectInterface.h:185
ChannelNameFrontLeft
@ ChannelNameFrontLeft
Definition: EffectInterface.h:165
ChannelName
ChannelName
Definition: EffectInterface.h:159
ChannelNameEOL
@ ChannelNameEOL
Definition: EffectInterface.h:161
ChannelNameLowFrequency1
@ ChannelNameLowFrequency1
Definition: EffectInterface.h:168
ChannelNameTopFrontLeft
@ ChannelNameTopFrontLeft
Definition: EffectInterface.h:177
ChannelNameLowFrequency2
@ ChannelNameLowFrequency2
Definition: EffectInterface.h:174
ChannelNameTopFrontCenter
@ ChannelNameTopFrontCenter
Definition: EffectInterface.h:179
ChannelNameBottomFrontLeft
@ ChannelNameBottomFrontLeft
Definition: EffectInterface.h:187
ChannelNameBackLeft
@ ChannelNameBackLeft
Definition: EffectInterface.h:169
ChannelNameTopSideLeft
@ ChannelNameTopSideLeft
Definition: EffectInterface.h:183
EffectTypeTool
@ EffectTypeTool
Definition: EffectInterface.h:58
ChannelNameTopCenter
@ ChannelNameTopCenter
Definition: EffectInterface.h:180
EffectTypeHidden
@ EffectTypeHidden
Definition: EffectInterface.h:54
ChannelNames
enum ChannelName * ChannelNames
ChannelNameTopSideRight
@ ChannelNameTopSideRight
Definition: EffectInterface.h:184
ChannelNameTopBackRight
@ ChannelNameTopBackRight
Definition: EffectInterface.h:182
ChannelNameBackCenter
@ ChannelNameBackCenter
Definition: EffectInterface.h:173
ChannelNameBottomFrontRight
@ ChannelNameBottomFrontRight
Definition: EffectInterface.h:188
EffectTypeAnalyze
@ EffectTypeAnalyze
Definition: EffectInterface.h:57
ChannelNameSideRight
@ ChannelNameSideRight
Definition: EffectInterface.h:176
ChannelNameFrontLeftCenter
@ ChannelNameFrontLeftCenter
Definition: EffectInterface.h:171
ChannelNameFrontRightCenter
@ ChannelNameFrontRightCenter
Definition: EffectInterface.h:172
ChannelNameMono
@ ChannelNameMono
Definition: EffectInterface.h:163
EffectType
EffectType
Definition: EffectInterface.h:52
ChannelNameFrontCenter
@ ChannelNameFrontCenter
Definition: EffectInterface.h:167
ChannelNameSideLeft
@ ChannelNameSideLeft
Definition: EffectInterface.h:175