VSTSubProcess Class Reference

Inheritance diagram for VSTSubProcess:

Collaboration diagram for VSTSubProcess:

Public Member Functions
	VSTSubProcess ()
PluginPath	GetPath () const override
ComponentInterfaceSymbol	GetSymbol () const override
VendorSymbol	GetVendor () const override
wxString	GetVersion () const override
TranslatableString	GetDescription () const override
EffectFamilySymbol	GetFamily () const override
	Report identifier and user-visible name of the effect protocol. More...
EffectType	GetType () const override
	Type determines how it behaves. More...
bool	IsInteractive () const override
	Whether the effect needs a dialog for entry of settings. More...
bool	IsDefault () const override
	Whether the effect sorts "above the line" in the menus. More...
bool	SupportsRealtime () const override
	Whether the effect supports realtime previewing (while audio is playing). More...
bool	SupportsAutomation () const override
	Whether the effect has any automatable controls. 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 bool	SupportsRealtime () const =0
	Whether the effect supports realtime previewing (while audio is playing). More...
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

Public Attributes
wxString	mPath
wxString	mName
wxString	mVendor
wxString	mVersion
TranslatableString	mDescription
EffectType	mType
bool	mInteractive
bool	mAutomatable

Additional Inherited Members
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

Information about one VST effect.

This object exists in a separate process, to validate a newly seen plug-in.

It needs to implement EffectDefinitionInterface but mostly just as stubs

Definition at line 226 of file VSTEffect.cpp.

Constructor & Destructor Documentation

VSTSubProcess()

VSTSubProcess::VSTSubProcess ( )

inline

Definition at line 230 of file VSTEffect.cpp.

   {
      Redirect();
   }

Member Function Documentation

GetDescription()

TranslatableString VSTSubProcess::GetDescription ( ) const

inlineoverridevirtual

Implements ComponentInterface.

Definition at line 257 of file VSTEffect.cpp.

   {
      return mDescription;
   }

References mDescription.

GetFamily()

EffectFamilySymbol VSTSubProcess::GetFamily ( ) const

inlineoverridevirtual

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

Implements EffectDefinitionInterface.

Definition at line 262 of file VSTEffect.cpp.

   {
      return VSTPLUGINTYPE;
   }

References VSTPLUGINTYPE.

GetPath()

PluginPath VSTSubProcess::GetPath ( ) const

inlineoverridevirtual

Implements ComponentInterface.

Definition at line 237 of file VSTEffect.cpp.

   {
      return mPath;
   }

References mPath.

GetSymbol()

ComponentInterfaceSymbol VSTSubProcess::GetSymbol ( ) const

inlineoverridevirtual

Implements ComponentInterface.

Definition at line 242 of file VSTEffect.cpp.

   {
      return mName;
   }

References mName.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath().

Here is the caller graph for this function:

GetType()

EffectType VSTSubProcess::GetType ( ) const

inlineoverridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 267 of file VSTEffect.cpp.

   {
      return mType;
   }

References mType.

GetVendor()

VendorSymbol VSTSubProcess::GetVendor ( ) const

inlineoverridevirtual

Implements ComponentInterface.

Definition at line 247 of file VSTEffect.cpp.

   {
      return { mVendor };
   }

References mVendor.

GetVersion()

wxString VSTSubProcess::GetVersion ( ) const

inlineoverridevirtual

Implements ComponentInterface.

Definition at line 252 of file VSTEffect.cpp.

   {
      return mVersion;
   }

References mVersion.

IsDefault()

bool VSTSubProcess::IsDefault ( ) const

inlineoverridevirtual

Whether the effect sorts "above the line" in the menus.

Implements EffectDefinitionInterface.

Definition at line 277 of file VSTEffect.cpp.

   {
      return false;
   }

IsInteractive()

bool VSTSubProcess::IsInteractive ( ) const

inlineoverridevirtual

Whether the effect needs a dialog for entry of settings.

Implements EffectDefinitionInterface.

Definition at line 272 of file VSTEffect.cpp.

   {
      return mInteractive;
   }

References mInteractive.

SupportsAutomation()

bool VSTSubProcess::SupportsAutomation ( ) const

inlineoverridevirtual

Whether the effect has any automatable controls.

Implements EffectDefinitionInterface.

Definition at line 287 of file VSTEffect.cpp.

   {
      return mAutomatable;
   }

References mAutomatable.

SupportsRealtime()

bool VSTSubProcess::SupportsRealtime ( ) const

inlineoverridevirtual

Whether the effect supports realtime previewing (while audio is playing).

Implements EffectDefinitionInterface.

Definition at line 282 of file VSTEffect.cpp.

   {
      return mType == EffectTypeProcess;
   }

References EffectTypeProcess, and mType.

Member Data Documentation

mAutomatable

bool VSTSubProcess::mAutomatable

Definition at line 300 of file VSTEffect.cpp.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath(), and SupportsAutomation().

mDescription

TranslatableString VSTSubProcess::mDescription

Definition at line 297 of file VSTEffect.cpp.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath(), and GetDescription().

mInteractive

bool VSTSubProcess::mInteractive

Definition at line 299 of file VSTEffect.cpp.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath(), and IsInteractive().

mName

wxString VSTSubProcess::mName

Definition at line 294 of file VSTEffect.cpp.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath(), and GetSymbol().

mPath

wxString VSTSubProcess::mPath

Definition at line 293 of file VSTEffect.cpp.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath(), and GetPath().

mType

EffectType VSTSubProcess::mType

Definition at line 298 of file VSTEffect.cpp.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath(), GetType(), and SupportsRealtime().

mVendor

wxString VSTSubProcess::mVendor

Definition at line 295 of file VSTEffect.cpp.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath(), and GetVendor().

mVersion

wxString VSTSubProcess::mVersion

Definition at line 296 of file VSTEffect.cpp.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath(), and GetVersion().

---

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

• VSTEffect.cpp