Audacity 3.2.0
Public Member Functions | List of all members
EffectInstanceFactory Class Referenceabstract

#include <EffectInterface.h>

Inheritance diagram for EffectInstanceFactory:
Collaboration diagram for EffectInstanceFactory:

Public Member Functions

virtual ~EffectInstanceFactory ()
virtual std::shared_ptr< EffectInstanceMakeInstance () const =0
 Make an object maintaining short-term state of an Effect. More...
- Public Member Functions inherited from EffectSettingsManager
virtual ~EffectSettingsManager ()
virtual bool VisitSettings (SettingsVisitor &visitor, EffectSettings &settings)
virtual bool VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const
virtual EffectSettings MakeSettings () const
virtual bool CopySettingsContents (const EffectSettings &src, EffectSettings &dst, SettingsCopyDirection copyDirection) const
 Update one settings object from another. More...
virtual bool SaveSettings (const EffectSettings &settings, CommandParameters &parms) const =0
 Store settings as keys and values. More...
virtual bool LoadSettings (const CommandParameters &parms, EffectSettings &settings) const =0
 Restore settings from keys and values. More...
virtual RegistryPaths GetFactoryPresets () const =0
 Report names of factory presets. More...
virtual bool LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const =0
 Change settings to a user-named preset. More...
virtual bool SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const =0
 Save settings in the configuration file as a user-named preset. More...
virtual bool LoadFactoryPreset (int id, EffectSettings &settings) const =0
 Change settings to the preset whose name is GetFactoryPresets()[id] More...
virtual bool LoadFactoryDefaults (EffectSettings &settings) const =0
 Change settings back to "factory default". More...
- Public Member Functions inherited from EffectDefinitionInterface
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

Additional Inherited Members

- Public Types inherited from EffectDefinitionInterface
enum class  RealtimeSince : unsigned { Never , Since_3_2 , Always }
 In which versions of Audacity was an effect realtime capable? More...
- Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier GetSquashedName (const Identifier &ident)
 A utility that strips spaces and CamelCases a name. More...

Detailed Description

Definition at line 536 of file EffectInterface.h.

Constructor & Destructor Documentation

◆ ~EffectInstanceFactory()

EffectInstanceFactory::~EffectInstanceFactory ( )

Member Function Documentation

◆ MakeInstance()

virtual std::shared_ptr< EffectInstance > EffectInstanceFactory::MakeInstance ( ) const
pure virtual

Make an object maintaining short-term state of an Effect.

One effect may have multiple instances extant simultaneously. Instances have state, may be implemented in foreign code, and are temporary, whereas EffectSettings represents persistent effect state that can be saved and reloaded from files.

settingsmay be assumed to have a lifetime enclosing the instance's
true (no promises that the result isn't null)

Implemented in AudioUnitEffect, EffectDtmf, EffectEcho, StatefulEffect, LadspaEffect, LV2Effect, EffectReverb, StatefulPerTrackEffect, VSTEffect, VST3Effect, and EffectWahwah.

Referenced by EffectBase::DoEffect(), RealtimeEffectState::EnsureInstance(), RealtimeEffectState::GetInstance(), EffectUIHost::InitializeInstance(), EffectBase::Preview(), and PerTrackEffect::ProcessPass().

Here is the caller graph for this function:

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