Audacity  3.0.3
Public Member Functions | Public Attributes | List of all members
VSTSubProcess Class Referencefinal
Inheritance diagram for VSTSubProcess:
[legend]
Collaboration diagram for VSTSubProcess:
[legend]

Public Member Functions

 VSTSubProcess ()
 
PluginPath GetPath () override
 
ComponentInterfaceSymbol GetSymbol () override
 
VendorSymbol GetVendor () override
 
wxString GetVersion () override
 
TranslatableString GetDescription () override
 
EffectFamilySymbol GetFamily () override
 
EffectType GetType () override
 
bool IsInteractive () override
 
bool IsDefault () override
 
bool IsLegacy () override
 
bool SupportsRealtime () override
 
bool SupportsAutomation () override
 
- Public Member Functions inherited from EffectDefinitionInterface
virtual ~EffectDefinitionInterface ()
 
virtual EffectType GetClassification ()
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
TranslatableString GetName ()
 
virtual bool DefineParams (ShuttleParams &WXUNUSED(S))
 

Public Attributes

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

Detailed Description

Information about one VST effect.

Definition at line 224 of file VSTEffect.cpp.

Constructor & Destructor Documentation

◆ VSTSubProcess()

VSTSubProcess::VSTSubProcess ( )
inline

Definition at line 228 of file VSTEffect.cpp.

229  {
230  Redirect();
231  }

Member Function Documentation

◆ GetDescription()

TranslatableString VSTSubProcess::GetDescription ( )
inlineoverridevirtual

Implements ComponentInterface.

Definition at line 255 of file VSTEffect.cpp.

256  {
257  return mDescription;
258  }

References mDescription.

◆ GetFamily()

EffectFamilySymbol VSTSubProcess::GetFamily ( )
inlineoverridevirtual

Implements EffectDefinitionInterface.

Definition at line 260 of file VSTEffect.cpp.

261  {
262  return VSTPLUGINTYPE;
263  }

References VSTPLUGINTYPE.

◆ GetPath()

PluginPath VSTSubProcess::GetPath ( )
inlineoverridevirtual

Implements ComponentInterface.

Definition at line 235 of file VSTEffect.cpp.

236  {
237  return mPath;
238  }

References mPath.

◆ GetSymbol()

ComponentInterfaceSymbol VSTSubProcess::GetSymbol ( )
inlineoverridevirtual

Implements ComponentInterface.

Definition at line 240 of file VSTEffect.cpp.

241  {
242  return mName;
243  }

References mName.

Referenced by VSTEffectsModule::DiscoverPluginsAtPath().

Here is the caller graph for this function:

◆ GetType()

EffectType VSTSubProcess::GetType ( )
inlineoverridevirtual

Implements EffectDefinitionInterface.

Definition at line 265 of file VSTEffect.cpp.

266  {
267  return mType;
268  }

References mType.

◆ GetVendor()

VendorSymbol VSTSubProcess::GetVendor ( )
inlineoverridevirtual

Implements ComponentInterface.

Definition at line 245 of file VSTEffect.cpp.

246  {
247  return { mVendor };
248  }

References mVendor.

◆ GetVersion()

wxString VSTSubProcess::GetVersion ( )
inlineoverridevirtual

Implements ComponentInterface.

Definition at line 250 of file VSTEffect.cpp.

251  {
252  return mVersion;
253  }

References mVersion.

◆ IsDefault()

bool VSTSubProcess::IsDefault ( )
inlineoverridevirtual

Implements EffectDefinitionInterface.

Definition at line 275 of file VSTEffect.cpp.

276  {
277  return false;
278  }

◆ IsInteractive()

bool VSTSubProcess::IsInteractive ( )
inlineoverridevirtual

Implements EffectDefinitionInterface.

Definition at line 270 of file VSTEffect.cpp.

271  {
272  return mInteractive;
273  }

References mInteractive.

◆ IsLegacy()

bool VSTSubProcess::IsLegacy ( )
inlineoverridevirtual

Implements EffectDefinitionInterface.

Definition at line 280 of file VSTEffect.cpp.

281  {
282  return false;
283  }

◆ SupportsAutomation()

bool VSTSubProcess::SupportsAutomation ( )
inlineoverridevirtual

Implements EffectDefinitionInterface.

Definition at line 290 of file VSTEffect.cpp.

291  {
292  return mAutomatable;
293  }

References mAutomatable.

◆ SupportsRealtime()

bool VSTSubProcess::SupportsRealtime ( )
inlineoverridevirtual

Implements EffectDefinitionInterface.

Definition at line 285 of file VSTEffect.cpp.

286  {
287  return mType == EffectTypeProcess;
288  }

References EffectTypeProcess, and mType.

Member Data Documentation

◆ mAutomatable

bool VSTSubProcess::mAutomatable

Definition at line 303 of file VSTEffect.cpp.

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

◆ mDescription

TranslatableString VSTSubProcess::mDescription

Definition at line 300 of file VSTEffect.cpp.

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

◆ mInteractive

bool VSTSubProcess::mInteractive

Definition at line 302 of file VSTEffect.cpp.

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

◆ mName

wxString VSTSubProcess::mName

Definition at line 297 of file VSTEffect.cpp.

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

◆ mPath

wxString VSTSubProcess::mPath

Definition at line 296 of file VSTEffect.cpp.

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

◆ mType

EffectType VSTSubProcess::mType

◆ mVendor

wxString VSTSubProcess::mVendor

Definition at line 298 of file VSTEffect.cpp.

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

◆ mVersion

wxString VSTSubProcess::mVersion

Definition at line 299 of file VSTEffect.cpp.

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


The documentation for this class was generated from the following file:
EffectTypeProcess
@ EffectTypeProcess
Definition: EffectInterface.h:59
VSTSubProcess::mDescription
TranslatableString mDescription
Definition: VSTEffect.cpp:300
VSTSubProcess::mName
wxString mName
Definition: VSTEffect.cpp:297
VSTSubProcess::mVersion
wxString mVersion
Definition: VSTEffect.cpp:299
VSTSubProcess::mType
EffectType mType
Definition: VSTEffect.cpp:301
VSTPLUGINTYPE
#define VSTPLUGINTYPE
Definition: VSTEffect.h:34
VSTSubProcess::mPath
wxString mPath
Definition: VSTEffect.cpp:296
VSTSubProcess::mInteractive
bool mInteractive
Definition: VSTEffect.cpp:302
VSTSubProcess::mVendor
wxString mVendor
Definition: VSTEffect.cpp:298
VSTSubProcess::mAutomatable
bool mAutomatable
Definition: VSTEffect.cpp:303