Audacity 3.2.0
Public Member Functions | List of all members
ComponentInterface Class Referenceabstract

ComponentInterface provides name / vendor / version functions to identify plugins. It is what makes a class a plug-in. Additionally it provides an optional parameter definitions function, for those components such as commands, effects and (soon) preference pagess that define parameters. More...

#include <ComponentInterface.h>

Inheritance diagram for ComponentInterface:
[legend]

Public Member Functions

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
 

Detailed Description

ComponentInterface provides name / vendor / version functions to identify plugins. It is what makes a class a plug-in. Additionally it provides an optional parameter definitions function, for those components such as commands, effects and (soon) preference pagess that define parameters.

Definition at line 59 of file ComponentInterface.h.

Constructor & Destructor Documentation

◆ ~ComponentInterface()

ComponentInterface::~ComponentInterface ( )
virtualdefault

Member Function Documentation

◆ GetDescription()

virtual TranslatableString ComponentInterface::GetDescription ( ) const
pure virtual

Implemented in Effect, BuiltinEffectsModule, VST3EffectBase, VST3EffectsModule, AudacityCommand, CompareAudioCommand, DemoCommand, DragCommand, GetInfoCommand, GetTrackInfoCommand, HelpCommand, CommentCommand, ImportCommand, ExportCommand, BuiltinCommandsModule, MessageCommand, OpenProjectCommand, SaveProjectCommand, SaveCopyCommand, SaveLogCommand, ClearLogCommand, GetPreferenceCommand, SetPreferenceCommand, ScreenshotCommand, SelectTimeCommand, SelectFrequenciesCommand, SelectTracksCommand, SelectCommand, SetClipCommand, SetEnvelopeCommand, SetLabelCommand, SetProjectCommand, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, SetTrackCommand, EffectAmplify, AudioUnitEffect, AudioUnitEffectsModule, EffectAutoDuck, EffectBassTreble, EffectChangeSpeed, EffectClickRemoval, EffectCompressor, EffectDistortion, EffectDtmf, EffectEcho, EffectEqualization, EffectFade, EffectFindClipping, EffectInvert, LadspaEffect, LadspaEffectsModule, EffectLoudness, LV2EffectsModule, LV2Effect, EffectNoise, EffectNoiseReduction, EffectNormalize, NyquistEffectsModule, NyquistEffect, EffectPaulstretch, EffectPhaser, EffectRepair, EffectRepeat, EffectReverb, EffectReverse, EffectScienFilter, EffectSilence, EffectStereoToMono, EffectTimeScale, EffectToneGen, EffectTruncSilence, VampEffectsModule, VampEffect, VSTEffect, VSTEffectsModule, EffectWahwah, ApplicationPrefs, BatchPrefs, DevicePrefs, DirectoriesPrefs, EffectsPrefs, ExtImportPrefs, GUIPrefs, ImportExportPrefs, KeyConfigPrefs, LibraryPrefs, ModulePrefs, MousePrefs, PlaybackPrefs, QualityPrefs, RecordingPrefs, SpectrumPrefs, ThemePrefs, TracksBehaviorsPrefs, TracksPrefs, WarningsPrefs, and WaveformPrefs.

◆ GetName()

TranslatableString ComponentInterface::GetName ( ) const

Definition at line 1535 of file PluginManager.cpp.

1536{
1537 return GetSymbol().Msgid();
1538}
ComponentInterface::GetSymbol
virtual ComponentInterfaceSymbol GetSymbol() const =0
ComponentInterfaceSymbol::Msgid
const TranslatableString & Msgid() const
Definition: ComponentInterfaceSymbol.h:56

References PluginManager::GetSymbol(), and ComponentInterfaceSymbol::Msgid().

Referenced by AudacityCommand::CreateUI(), AudacityCommand::DoAudacityCommand(), EffectBase::DoEffect(), EffectUIServices::DoMessageBox(), EffectEqualization::EffectEqualization(), EffectUIHost::EffectUIHost(), AudioUnitEffect::Export(), AudacityCommand::LoadSettingsFromString(), Effect::LoadSettingsFromString(), AudacityCommand::MessageBox(), EffectUIHost::OnApply(), EffectBase::Preview(), and NyquistEffect::ProcessOne().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetPath()

virtual PluginPath ComponentInterface::GetPath ( ) const
pure virtual

Implemented in Effect, BuiltinEffectsModule, VST3EffectBase, VST3EffectsModule, AudacityCommand, BuiltinCommandsModule, AudioUnitEffect, AudioUnitEffectsModule, LadspaEffect, LadspaEffectsModule, LV2EffectsModule, LV2Effect, NyquistEffectsModule, NyquistEffect, VampEffectsModule, VampEffect, VSTEffect, VSTEffectsModule, and PrefsPanel.

Referenced by EffectBase::DoEffect(), PluginManager::GetID(), ModuleManager::GetID(), and PluginManager::OldGetID().

Here is the caller graph for this function:

◆ GetSymbol()

virtual ComponentInterfaceSymbol ComponentInterface::GetSymbol ( ) const
pure virtual

Implemented in Effect, BuiltinEffectsModule, VST3EffectBase, VST3EffectsModule, OldStyleCommandType, CompareAudioCommand, DemoCommand, DragCommand, GetInfoCommand, GetTrackInfoCommand, HelpCommand, CommentCommand, ImportCommand, ExportCommand, BuiltinCommandsModule, MessageCommand, OpenProjectCommand, SaveProjectCommand, SaveCopyCommand, SaveLogCommand, ClearLogCommand, GetPreferenceCommand, SetPreferenceCommand, ScreenshotCommand, SelectTimeCommand, SelectFrequenciesCommand, SelectTracksCommand, SelectCommand, SetClipCommand, SetEnvelopeCommand, SetLabelCommand, SetProjectCommand, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, SetTrackCommand, EffectAmplify, AudioUnitEffect, AudioUnitEffectsModule, EffectAutoDuck, EffectBassTreble, EffectChangeSpeed, EffectClickRemoval, EffectCompressor, EffectDistortion, EffectDtmf, EffectEcho, EffectEqualization, EffectFade, EffectFindClipping, EffectInvert, LadspaEffect, LadspaEffectsModule, EffectLoudness, LV2EffectsModule, LV2Effect, EffectNoise, EffectNoiseReduction, EffectNormalize, NyquistEffectsModule, NyquistEffect, EffectPaulstretch, EffectPhaser, EffectRepair, EffectRepeat, EffectReverb, EffectReverse, EffectSBSMS, EffectScienFilter, EffectSilence, EffectStereoToMono, EffectTimeScale, EffectToneGen, EffectTruncSilence, VampEffectsModule, VampEffect, VSTEffect, VSTEffectsModule, EffectWahwah, ApplicationPrefs, BatchPrefs, DevicePrefs, DirectoriesPrefs, EffectsPrefs, ExtImportPrefs, GUIPrefs, ImportExportPrefs, KeyConfigPrefs, LibraryPrefs, ModulePrefs, MousePrefs, PlaybackPrefs, QualityPrefs, RecordingPrefs, SpectrumPrefs, ThemePrefs, TracksBehaviorsPrefs, TracksPrefs, WarningsPrefs, WaveformPrefs, SetWaveClipNameCommand, SetTrackNameCommand, and AudacityCommand.

Referenced by BasicEffectUIServices::ExportPresets(), PluginManager::GetID(), ModuleManager::GetID(), PrefsPanel::GetPath(), BasicEffectUIServices::ImportPresets(), and PluginManager::OldGetID().

Here is the caller graph for this function:

◆ GetVendor()

virtual VendorSymbol ComponentInterface::GetVendor ( ) const
pure virtual

Implemented in Effect, BuiltinEffectsModule, VST3EffectBase, VST3EffectsModule, AudacityCommand, BuiltinCommandsModule, AudioUnitEffect, AudioUnitEffectsModule, LadspaEffect, LadspaEffectsModule, LV2EffectsModule, LV2Effect, NyquistEffectsModule, NyquistEffect, VampEffectsModule, VampEffect, VSTEffect, VSTEffectsModule, and PrefsPanel.

Referenced by PluginManager::GetID(), ModuleManager::GetID(), and PluginManager::OldGetID().

Here is the caller graph for this function:

◆ GetVersion()

virtual wxString ComponentInterface::GetVersion ( ) const
pure virtual

Implemented in Effect, BuiltinEffectsModule, VST3EffectBase, VST3EffectsModule, AudacityCommand, BuiltinCommandsModule, AudioUnitEffect, AudioUnitEffectsModule, LadspaEffect, LadspaEffectsModule, LV2EffectsModule, LV2Effect, NyquistEffectsModule, NyquistEffect, VampEffectsModule, VampEffect, VSTEffect, VSTEffectsModule, and PrefsPanel.

Referenced by anonymous_namespace{EffectUI.cpp}::GetVersionForDisplay(), and RealtimeEffectState::WriteXML().

Here is the caller graph for this function:
The documentation for this class was generated from the following files:
Generated by doxygen 1.9.3