EffectDefinitionInterface is a ComponentInterface that adds some basic read-only information about effect properties, and getting and setting of parameters. More...

#include <EffectInterface.h>

Inheritance diagram for EffectDefinitionInterface:

[legend]

Collaboration diagram for EffectDefinitionInterface:

[legend]

Public Types
enum class	RealtimeSince : unsigned { Never , After_3_1 , Always }
	In which versions of Audacity was an effect realtime capable? More...

Public Member Functions
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetType () const =0
	Type determines how it behaves. More...

virtual EffectType	GetClassification () const
	Determines which menu it appears in; default same as GetType(). More...

virtual EffectFamilySymbol	GetFamily () const =0
	Report identifier and user-visible name of the effect protocol. More...

virtual bool	IsInteractive () const =0
	Whether the effect needs a dialog for entry of settings. More...

virtual bool	IsDefault () const =0
	Whether the effect sorts "above the line" in the menus. More...

virtual RealtimeSince	RealtimeSupport () const =0
	Since which version of Audacity has the effect supported realtime? More...

bool	SupportsRealtime () const

virtual bool	SupportsAutomation () const =0
	Whether the effect has any automatable controls. More...

virtual bool	EnablesDebug () const
	Whether the effect dialog should have a Debug button; default, always false. More...

virtual ManualPageID	ManualPage () const
	Name of a page in the Audacity alpha manual, default is empty. More...

virtual FilePath	HelpPage () const
	Fully qualified local help file name, default is empty. More...

virtual bool	IsHiddenFromMenus () const
	Default is false. More...

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

Static Public Member Functions
static Identifier	GetSquashedName (const Identifier &ident)
	A utility that strips spaces and CamelCases a name. More...

Detailed Description

EffectDefinitionInterface is a ComponentInterface that adds some basic read-only information about effect properties, and getting and setting of parameters.

Definition at line 244 of file EffectInterface.h.

Member Enumeration Documentation

◆ RealtimeSince

enum class EffectDefinitionInterface::RealtimeSince : unsigned

strong

In which versions of Audacity was an effect realtime capable?

Enumerator
Never
After_3_1
Always

Definition at line 269 of file EffectInterface.h.

                            : unsigned {
      Never,
      // For built-in effects that became realtime in 3.2.x or a later version
      // but were non-realtime in an earlier version; must also increase
      // REGVERCUR in any release with such a change
      After_3_1,
      Always,
   };

Constructor & Destructor Documentation

◆ ~EffectDefinitionInterface()

EffectDefinitionInterface::~EffectDefinitionInterface ( )

virtualdefault

Member Function Documentation

◆ EnablesDebug()

bool EffectDefinitionInterface::EnablesDebug ( ) const

virtual

Whether the effect dialog should have a Debug button; default, always false.

Reimplemented in NyquistEffect.

Definition at line 81 of file EffectInterface.cpp.

{
   return false;
}

Referenced by EffectUIHost::BuildButtonBar().

Here is the caller graph for this function:

◆ GetClassification()

EffectType EffectDefinitionInterface::GetClassification ( ) const

virtual

Determines which menu it appears in; default same as GetType().

Reimplemented in NyquistEffect.

Definition at line 76 of file EffectInterface.cpp.

{
   return GetType();
}

References GetType().

Referenced by PluginManager::RegisterPlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFamily()

virtual EffectFamilySymbol EffectDefinitionInterface::GetFamily ( ) const

pure virtual

Report identifier and user-visible name of the effect protocol.

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

Referenced by PluginManager::GetID(), PluginManager::OldGetID(), EffectBase::Preview(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ GetSquashedName()

Identifier EffectDefinitionInterface::GetSquashedName ( const Identifier & ident )

static

A utility that strips spaces and CamelCases a name.

Definition at line 53 of file EffectInterface.cpp.

{
   // Get rid of leading and trailing white space
   auto name = ident.GET();
   name.Trim(true).Trim(false);
 
   if (name.empty())
      return {};
 
   wxStringTokenizer st(name, wxT(" "));
   wxString id;
 
   // CamelCase the name
   while (st.HasMoreTokens()) {
      wxString tok = st.GetNextToken();
      id += tok.Left(1).MakeUpper() + tok.Mid(1).MakeLower();
   }
 
   return id;
}