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 ChannelName *	ChannelNames

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

using EffectFamilySymbol = ComponentInterfaceSymbol

Definition at line 65 of file EffectInterface.h.

EffectType

typedef enum EffectType EffectType

Enumeration Type Documentation

ChannelName

enum 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.

{
   // Use to mark end of list
   ChannelNameEOL = -1,
   // The default channel assignment
   ChannelNameMono,
   // From this point, the channels follow the 22.2 surround sound format
   ChannelNameFrontLeft,
   ChannelNameFrontRight,
   ChannelNameFrontCenter,
   ChannelNameLowFrequency1,
   ChannelNameBackLeft,
   ChannelNameBackRight,
   ChannelNameFrontLeftCenter,
   ChannelNameFrontRightCenter,
   ChannelNameBackCenter,
   ChannelNameLowFrequency2,
   ChannelNameSideLeft,
   ChannelNameSideRight,
   ChannelNameTopFrontLeft,
   ChannelNameTopFrontRight,
   ChannelNameTopFrontCenter,
   ChannelNameTopCenter,
   ChannelNameTopBackLeft,
   ChannelNameTopBackRight,
   ChannelNameTopSideLeft,
   ChannelNameTopSideRight,
   ChannelNameTopBackCenter,
   ChannelNameBottomFrontCenter,
   ChannelNameBottomFrontLeft,
   ChannelNameBottomFrontRight,
} ChannelName, *ChannelNames;

EffectType

enum EffectType : int

Enumerator
EffectTypeNone
EffectTypeHidden
EffectTypeGenerate
EffectTypeProcess
EffectTypeAnalyze
EffectTypeTool

Definition at line 54 of file EffectInterface.h.

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