Audacity  3.0.3
Public Member Functions | List of all members
EffectHostInterface Class Referenceabstract

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

#include <EffectInterface.h>

Inheritance diagram for EffectHostInterface:
[legend]
Collaboration diagram for EffectHostInterface:
[legend]

Public Member Functions

virtual ~EffectHostInterface ()
 
virtual double GetDefaultDuration ()=0
 
virtual double GetDuration ()=0
 
virtual NumericFormatSymbol GetDurationFormat ()=0
 
virtual void SetDuration (double seconds)=0
 
virtual RegistryPath GetUserPresetsGroup (const RegistryPath &name)=0
 
virtual RegistryPath GetCurrentSettingsGroup ()=0
 
virtual RegistryPath GetFactoryDefaultsGroup ()=0
 
- Public Member Functions inherited from ConfigClientInterface
virtual ~ConfigClientInterface ()
 
virtual bool HasSharedConfigGroup (const RegistryPath &group)=0
 
virtual bool GetSharedConfigSubgroups (const RegistryPath &group, RegistryPaths &subgroups)=0
 
virtual bool GetSharedConfig (const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval)=0
 
virtual bool GetSharedConfig (const RegistryPath &group, const RegistryPath &key, int &value, int defval)=0
 
virtual bool GetSharedConfig (const RegistryPath &group, const RegistryPath &key, bool &value, bool defval)=0
 
virtual bool GetSharedConfig (const RegistryPath &group, const RegistryPath &key, float &value, float defval)=0
 
virtual bool GetSharedConfig (const RegistryPath &group, const RegistryPath &key, double &value, double defval)=0
 
virtual bool SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const wxString &value)=0
 
virtual bool SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const int &value)=0
 
virtual bool SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const bool &value)=0
 
virtual bool SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const float &value)=0
 
virtual bool SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const double &value)=0
 
virtual bool RemoveSharedConfigSubgroup (const RegistryPath &group)=0
 
virtual bool RemoveSharedConfig (const RegistryPath &group, const RegistryPath &key)=0
 
virtual bool HasPrivateConfigGroup (const RegistryPath &group)=0
 
virtual bool GetPrivateConfigSubgroups (const RegistryPath &group, RegistryPaths &subgroups)=0
 
virtual bool GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval)=0
 
virtual bool GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, int &value, int defval)=0
 
virtual bool GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, bool &value, bool defval)=0
 
virtual bool GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, float &value, float defval)=0
 
virtual bool GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, double &value, double defval)=0
 
virtual bool SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const wxString &value)=0
 
virtual bool SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const int &value)=0
 
virtual bool SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const bool &value)=0
 
virtual bool SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const float &value)=0
 
virtual bool SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const double &value)=0
 
virtual bool RemovePrivateConfigSubgroup (const RegistryPath &group)=0
 
virtual bool RemovePrivateConfig (const RegistryPath &group, const RegistryPath &key)=0
 

Detailed Description

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.

Definition at line 120 of file EffectInterface.h.

Constructor & Destructor Documentation

◆ ~EffectHostInterface()

EffectHostInterface::~EffectHostInterface ( )
virtualdefault

Member Function Documentation

◆ GetCurrentSettingsGroup()

virtual RegistryPath EffectHostInterface::GetCurrentSettingsGroup ( )
pure virtual

Implemented in Effect.

Referenced by AudioUnitEffect::SetHost(), LV2Effect::SetHost(), and VSTEffect::SetHost().

Here is the caller graph for this function:

◆ GetDefaultDuration()

virtual double EffectHostInterface::GetDefaultDuration ( )
pure virtual

Implemented in Effect.

◆ GetDuration()

virtual double EffectHostInterface::GetDuration ( )
pure virtual

Implemented in Effect.

Referenced by LV2Effect::BuildPlain(), and VSTEffect::BuildPlain().

Here is the caller graph for this function:

◆ GetDurationFormat()

virtual NumericFormatSymbol EffectHostInterface::GetDurationFormat ( )
pure virtual

Implemented in Effect.

Referenced by LV2Effect::BuildPlain(), and VSTEffect::BuildPlain().

Here is the caller graph for this function:

◆ GetFactoryDefaultsGroup()

virtual RegistryPath EffectHostInterface::GetFactoryDefaultsGroup ( )
pure virtual

Implemented in Effect.

Referenced by AudioUnitEffect::LoadFactoryDefaults(), LV2Effect::LoadFactoryDefaults(), VSTEffect::LoadFactoryDefaults(), AudioUnitEffect::SetHost(), LV2Effect::SetHost(), and VSTEffect::SetHost().

Here is the caller graph for this function:

◆ GetUserPresetsGroup()

virtual RegistryPath EffectHostInterface::GetUserPresetsGroup ( const RegistryPath name)
pure virtual

Implemented in Effect.

Referenced by AudioUnitEffectImportDialog::Import().

Here is the caller graph for this function:

◆ SetDuration()

virtual void EffectHostInterface::SetDuration ( double  seconds)
pure virtual

Implemented in Effect.

Referenced by AudioUnitEffect::ValidateUI(), LV2Effect::ValidateUI(), and VSTEffect::ValidateUI().

Here is the caller graph for this function:

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