Audacity  2.3.1
Public Types | Public Member Functions | List of all members
ModuleInterface Class Referenceabstract

#include <ModuleInterface.h>

Inheritance diagram for ModuleInterface:
ComponentInterface AudioUnitEffectsModule BuiltinCommandsModule BuiltinEffectsModule LadspaEffectsModule LV2EffectsModule NyquistEffectsModule VampEffectsModule VSTEffectsModule

Public Types

using RegistrationCallback = std::function< const PluginID &(ModuleInterface *, ComponentInterface *) >
 

Public Member Functions

virtual ~ModuleInterface ()
 
virtual bool Initialize ()=0
 
virtual void Terminate ()=0
 
virtual wxArrayString FileExtensions ()=0
 
virtual wxString InstallPath ()=0
 
virtual bool AutoRegisterPlugins (PluginManagerInterface &pluginManager)=0
 
virtual wxArrayString FindPluginPaths (PluginManagerInterface &pluginManager)=0
 
virtual unsigned DiscoverPluginsAtPath (const wxString &path, wxString &errMsg, const RegistrationCallback &callback)=0
 
virtual bool IsPluginValid (const wxString &path, bool bFast)=0
 
virtual ComponentInterfaceCreateInstance (const wxString &path)=0
 
virtual void DeleteInstance (ComponentInterface *instance)=0
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
virtual wxString GetPath ()=0
 
virtual ComponentInterfaceSymbol GetSymbol ()=0
 
virtual ComponentInterfaceSymbol GetVendor ()=0
 
virtual wxString GetVersion ()=0
 
virtual wxString GetDescription ()=0
 
const wxString & GetTranslatedName ()
 
virtual bool DefineParams (ShuttleParams &WXUNUSED(S))
 

Detailed Description

ModuleInterface is a generic dll or so interface for Audacity, that is used for plug ins. Classes derived from it can handle more specific plug in types.

Definition at line 67 of file ModuleInterface.h.

Member Typedef Documentation

Definition at line 116 of file ModuleInterface.h.

Constructor & Destructor Documentation

virtual ModuleInterface::~ModuleInterface ( )
inlinevirtual

Definition at line 70 of file ModuleInterface.h.

70 {};

Member Function Documentation

virtual bool ModuleInterface::AutoRegisterPlugins ( PluginManagerInterface pluginManager)
pure virtual
virtual ComponentInterface* ModuleInterface::CreateInstance ( const wxString &  path)
pure virtual
virtual void ModuleInterface::DeleteInstance ( ComponentInterface instance)
pure virtual
virtual unsigned ModuleInterface::DiscoverPluginsAtPath ( const wxString &  path,
wxString &  errMsg,
const RegistrationCallback callback 
)
pure virtual
virtual wxArrayString ModuleInterface::FileExtensions ( )
pure virtual
virtual wxArrayString ModuleInterface::FindPluginPaths ( PluginManagerInterface pluginManager)
pure virtual
virtual bool ModuleInterface::Initialize ( )
pure virtual
virtual wxString ModuleInterface::InstallPath ( )
pure virtual
virtual bool ModuleInterface::IsPluginValid ( const wxString &  path,
bool  bFast 
)
pure virtual
virtual void ModuleInterface::Terminate ( )
pure virtual

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