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 AudioUnitEffectBase, AudioUnitEffectsModule, Effect, BuiltinEffectsModule, LadspaEffectBase, LadspaEffectsModule, LV2EffectsModule, LV2EffectBase, LibraryPrefs, VSTEffectBase, VSTEffectsModule, VST3EffectBase, VST3EffectsModule, anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel, AudacityCommand, CompareAudioCommand, DemoCommand, DragCommand, GetInfoCommand, GetTrackInfoCommand, HelpCommand, CommentCommand, ImportCommand, ExportCommand, BuiltinCommandsModule, MessageCommand, OpenProjectCommand, SaveProjectCommand, SaveCopyCommand, SaveLogCommand, ClearLogCommand, GetPreferenceCommand, SetPreferenceCommand, SelectTimeCommand, SelectFrequenciesCommand, SelectTracksCommand, SelectCommand, SetClipCommand, SetEnvelopeCommand, SetLabelCommand, SetProjectCommand, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, SetTrackCommand, EffectAmplify, EffectAutoDuck, EffectBassTreble, EffectChangeSpeed, EffectClickRemoval, EffectCompressor, EffectDistortion, EffectDtmf, EffectEcho, EffectEqualization, EffectFade, EffectFindClipping, EffectInvert, EffectLimiter, EffectLoudness, EffectNoise, EffectNoiseReduction, EffectNormalize, NyquistEffectsModule, NyquistEffect, EffectPaulstretch, EffectPhaser, EffectRepair, EffectRepeat, EffectReverb, EffectReverse, EffectScienFilter, EffectSilence, EffectStereoToMono, EffectTimeScale, EffectToneGen, EffectTruncSilence, VampEffectsModule, VampEffect, EffectWahwah, ApplicationPrefs, BatchPrefs, DevicePrefs, DirectoriesPrefs, EffectsPrefs, ExtImportPrefs, GUIPrefs, ImportExportPrefs, KeyConfigPrefs, MidiIOPrefs, ModulePrefs, PlaybackPrefs, QualityPrefs, RecordingPrefs, SpectrumPrefs, ThemePrefs, TracksBehaviorsPrefs, TracksPrefs, WarningsPrefs, and WaveformPrefs.

◆ GetName()

TranslatableString ComponentInterface::GetName ( ) const

Definition at line 1511 of file PluginManager.cpp.

1512{
1513 return GetSymbol().Msgid();
1514}
virtual ComponentInterfaceSymbol GetSymbol() const =0
const TranslatableString & Msgid() const

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

Referenced by AudacityCommand::CreateUI(), AudacityCommand::DoAudacityCommand(), EffectBase::DoEffect(), EffectUIServices::DoMessageBox(), EffectEqualization::EffectEqualization(), EffectPreview(), EffectUIHost::EffectUIHost(), AudioUnitEffectBase::Export(), AudacityCommand::LoadSettingsFromString(), Effect::LoadSettingsFromString(), AudacityCommand::MessageBox(), and EffectUIHost::OnApply().

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

◆ GetPath()

virtual PluginPath ComponentInterface::GetPath ( ) const
pure virtual

◆ GetSymbol()

virtual ComponentInterfaceSymbol ComponentInterface::GetSymbol ( ) const
pure virtual

Implemented in AudioUnitEffectBase, AudioUnitEffectsModule, Effect, BuiltinEffectsModule, LadspaEffectBase, LadspaEffectsModule, LV2EffectsModule, LV2EffectBase, LibraryPrefs, VSTEffectBase, VSTEffectsModule, VST3EffectBase, VST3EffectsModule, anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel, OldStyleCommandType, CompareAudioCommand, DemoCommand, DragCommand, GetInfoCommand, GetTrackInfoCommand, HelpCommand, CommentCommand, ImportCommand, ExportCommand, BuiltinCommandsModule, MessageCommand, OpenProjectCommand, SaveProjectCommand, SaveCopyCommand, SaveLogCommand, ClearLogCommand, GetPreferenceCommand, SetPreferenceCommand, SelectTimeCommand, SelectFrequenciesCommand, SelectTracksCommand, SelectCommand, SetClipCommand, SetEnvelopeCommand, SetLabelCommand, SetProjectCommand, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, SetTrackCommand, EffectAmplify, EffectAutoDuck, EffectBassTreble, EffectChangeSpeed, EffectClickRemoval, EffectCompressor, EffectDistortion, EffectDtmf, EffectEcho, EffectEqualization, EffectFade, EffectFindClipping, EffectInvert, EffectLimiter, EffectLoudness, EffectNoise, EffectNoiseReduction, EffectNormalize, NyquistEffectsModule, NyquistEffect, EffectPaulstretch, EffectPhaser, EffectRepair, EffectRepeat, EffectReverb, EffectReverse, EffectSBSMS, EffectScienFilter, EffectSilence, EffectStereoToMono, EffectTimeScale, EffectToneGen, EffectTruncSilence, VampEffectsModule, VampEffect, EffectWahwah, ApplicationPrefs, BatchPrefs, DevicePrefs, DirectoriesPrefs, EffectsPrefs, ExtImportPrefs, GUIPrefs, ImportExportPrefs, KeyConfigPrefs, MidiIOPrefs, ModulePrefs, 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

◆ GetVersion()

virtual wxString ComponentInterface::GetVersion ( ) const
pure virtual

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