EffectDefinitionInterface Class Reference

EffectDefinitionInterface is a ComponentInterface that additionally tracks flag-functions for interactivity, play-preview and whether the effect can run without a GUI. More...

#include <EffectInterface.h>

Inheritance diagram for EffectDefinitionInterface:

Collaboration diagram for EffectDefinitionInterface:

Public Member Functions
virtual	~EffectDefinitionInterface ()
virtual EffectType	GetType ()=0
virtual EffectType	GetClassification ()
virtual EffectFamilySymbol	GetFamily ()=0
virtual bool	IsInteractive ()=0
virtual bool	IsDefault ()=0
virtual bool	IsLegacy ()=0
virtual bool	SupportsRealtime ()=0
virtual bool	SupportsAutomation ()=0
Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()
virtual PluginPath	GetPath ()=0
virtual ComponentInterfaceSymbol	GetSymbol ()=0
virtual VendorSymbol	GetVendor ()=0
virtual wxString	GetVersion ()=0
virtual TranslatableString	GetDescription ()=0
TranslatableString	GetName ()
virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Detailed Description

EffectDefinitionInterface is a ComponentInterface that additionally tracks flag-functions for interactivity, play-preview and whether the effect can run without a GUI.

Definition at line 73 of file EffectInterface.h.

Constructor & Destructor Documentation

~EffectDefinitionInterface()

virtual EffectDefinitionInterface::~EffectDefinitionInterface ( )

inlinevirtual

Definition at line 76 of file EffectInterface.h.

{};

Member Function Documentation

GetClassification()

virtual EffectType EffectDefinitionInterface::GetClassification ( )

inlinevirtual

Reimplemented in NyquistEffect.

Definition at line 81 of file EffectInterface.h.

{ return GetType();};

Referenced by PluginManager::RegisterPlugin().

Here is the caller graph for this function:

GetFamily()

virtual EffectFamilySymbol EffectDefinitionInterface::GetFamily ( )

pure virtual

Implemented in VSTEffect, VSTSubProcess, VampEffect, NyquistEffect, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by Effect::GetFamily(), PluginManager::GetID(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

GetType()

virtual EffectType EffectDefinitionInterface::GetType ( )

pure virtual

Implemented in EffectWahwah, VSTEffect, VSTSubProcess, VampEffect, EffectTruncSilence, EffectToneGen, EffectTimeScale, EffectStereoToMono, EffectSilence, EffectScienFilter, EffectReverse, EffectReverb, EffectRepeat, EffectRepair, EffectPhaser, EffectPaulstretch, NyquistEffect, EffectNormalize, EffectNoiseRemoval, EffectNoiseReduction, EffectNoise, LV2Effect, EffectLoudness, LadspaEffect, EffectInvert, EffectFindClipping, EffectFade, EffectEqualization, Effect, EffectEcho, EffectDtmf, EffectDistortion, EffectCompressor, EffectClickRemoval, EffectChangeSpeed, EffectBassTreble, EffectAutoDuck, AudioUnitEffect, and EffectAmplify.

Referenced by Effect::GetType(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

IsDefault()

virtual bool EffectDefinitionInterface::IsDefault ( )

pure virtual

Implemented in VSTEffect, VSTSubProcess, VampEffect, NyquistEffect, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by Effect::IsDefault(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

IsInteractive()

virtual bool EffectDefinitionInterface::IsInteractive ( )

pure virtual

Implemented in VSTEffect, VSTSubProcess, VampEffect, EffectStereoToMono, EffectReverse, EffectRepair, NyquistEffect, LV2Effect, LadspaEffect, EffectInvert, EffectFade, Effect, and AudioUnitEffect.

Referenced by Effect::IsInteractive(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

IsLegacy()

virtual bool EffectDefinitionInterface::IsLegacy ( )

pure virtual

Implemented in VSTEffect, VSTSubProcess, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by EffectManager::GetEffect().

Here is the caller graph for this function:

SupportsAutomation()

virtual bool EffectDefinitionInterface::SupportsAutomation ( )

pure virtual

Implemented in VSTEffect, VSTSubProcess, EffectNoiseRemoval, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by PluginManager::RegisterPlugin(), and Effect::SupportsAutomation().

Here is the caller graph for this function:

SupportsRealtime()

virtual bool EffectDefinitionInterface::SupportsRealtime ( )

pure virtual

Implemented in EffectWahwah, VSTEffect, VSTSubProcess, EffectPhaser, LV2Effect, LadspaEffect, Effect, EffectDistortion, EffectBassTreble, and AudioUnitEffect.

Referenced by PluginManager::RegisterPlugin(), and Effect::SupportsRealtime().

Here is the caller graph for this function:

---

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

• EffectInterface.h