Audacity 3.2.0
LoadNyquist.h
Go to the documentation of this file.
1/**********************************************************************
2
3 Audacity: A Digital Audio Editor
4
5 LoadNyquist.h
6
7 Dominic Mazzoni
8
9**********************************************************************/
10
11#include "PluginProvider.h"
12#include "EffectInterface.h"
13#include "PluginInterface.h"
14
16//
17// NyquistEffectsModule
18//
20
22{
23public:
25 virtual ~NyquistEffectsModule();
26
27 // ComponentInterface implementation
28
29 PluginPath GetPath() const override;
30 ComponentInterfaceSymbol GetSymbol() const override;
31 VendorSymbol GetVendor() const override;
32 wxString GetVersion() const override;
33 TranslatableString GetDescription() const override;
34
35 // PluginProvider implementation
36
37 bool Initialize() override;
38 void Terminate() override;
40
41
42 const FileExtensions &GetFileExtensions() override;
43 FilePath InstallPath() override;
44
47 unsigned DiscoverPluginsAtPath(
48 const PluginPath & path, TranslatableString &errMsg,
49 const RegistrationCallback &callback)
50 override;
51
52 bool CheckPluginExist(const PluginPath& path) const override;
53
54 std::unique_ptr<ComponentInterface>
55 LoadPlugin(const PluginPath & path) override;
56};
std::vector< PluginPath > PluginPaths
Definition: Identifier.h:215
wxString PluginPath
type alias for identifying a Plugin supplied by a module, each module defining its own interpretation...
Definition: Identifier.h:214
Generalized interface for discovery of plug-ins for one protocol.
wxString FilePath
Definition: Project.h:21
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
void Terminate() override
Called just prior to deletion to allow releasing any resources.
VendorSymbol GetVendor() const override
virtual ~NyquistEffectsModule()
Definition: LoadNyquist.cpp:90
bool CheckPluginExist(const PluginPath &path) const override
Performs plugin/module existence check, still plugin may fail to load. Implementation should avoid lo...
unsigned DiscoverPluginsAtPath(const PluginPath &path, TranslatableString &errMsg, const RegistrationCallback &callback) override
std::unique_ptr< ComponentInterface > LoadPlugin(const PluginPath &path) override
Load the plug-in at a path reported by DiscoverPluginsAtPath.
FilePath InstallPath() override
Where plug-in files should be copied to install them.
const FileExtensions & GetFileExtensions() override
File types associated with this protocol.
PluginPath GetPath() const override
Definition: LoadNyquist.cpp:98
void AutoRegisterPlugins(PluginManagerInterface &pm) override
Called so that a provider of a static set of plug-ins can register them.
ComponentInterfaceSymbol GetSymbol() const override
TranslatableString GetDescription() const override
EffectFamilySymbol GetOptionalFamilySymbol() override
A symbol identifying the family of plug-ins provided by this.
PluginPaths FindModulePaths(PluginManagerInterface &pm) override
wxString GetVersion() const override
bool Initialize() override
Called immediately after creation. Let provider initialize.
std::function< const PluginID &(PluginProvider *, ComponentInterface *) > RegistrationCallback
Further expand a path reported by FindModulePaths.
Holds a msgid for the translation catalog; may also bind format arguments.
Extend wxArrayString with move operations and construction and insertion fromstd::initializer_list.