![]() |
Audacity 3.2.0
|
EffectDefinitionInterface is a ComponentInterface that adds some basic read-only information about effect properties, and getting and setting of parameters. More...
#include <EffectInterface.h>
Public Member Functions | |
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... | |
![]() | |
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 |
Static Public Member Functions | |
static Identifier | GetSquashedName (const Identifier &ident) |
A utility that strips spaces and CamelCases a name. More... | |
EffectDefinitionInterface is a ComponentInterface that adds some basic read-only information about effect properties, and getting and setting of parameters.
Definition at line 183 of file EffectInterface.h.
|
virtualdefault |
|
virtual |
Whether the effect dialog should have a Debug button; default, always false.
Reimplemented in NyquistEffect.
Definition at line 68 of file EffectInterface.cpp.
Referenced by EffectUIHost::Initialize().
|
virtual |
Determines which menu it appears in; default same as GetType().
Reimplemented in NyquistEffect.
Definition at line 63 of file EffectInterface.cpp.
References GetType().
Referenced by PluginManager::RegisterPlugin().
|
pure virtual |
Report identifier and user-visible name of the effect protocol.
Implemented in AudioUnitEffect, Effect, LadspaEffect, LV2Effect, NyquistEffect, VampEffect, VSTEffect, and VST3Effect.
Referenced by PluginManager::GetID(), PluginManager::OldGetID(), EffectBase::Preview(), and PluginManager::RegisterPlugin().
|
static |
A utility that strips spaces and CamelCases a name.
Definition at line 40 of file EffectInterface.cpp.
References TranslatableString::empty(), id, ident(), and name.
Referenced by Effect::ExportPresets(), EffectManager::GetCommandIdentifier(), and Effect::ImportPresets().
|
pure virtual |
Type determines how it behaves.
Implemented in EffectAmplify, AudioUnitEffect, EffectAutoDuck, EffectBassTreble, EffectChangeSpeed, EffectClickRemoval, EffectCompressor, EffectDistortion, EffectDtmf, EffectEcho, Effect, EffectEqualization, EffectFade, EffectFindClipping, EffectInvert, LadspaEffect, EffectLoudness, LV2Effect, EffectNoise, EffectNoiseReduction, EffectNoiseRemoval, EffectNormalize, NyquistEffect, EffectPaulstretch, EffectPhaser, EffectRepair, EffectRepeat, EffectReverb, EffectReverse, EffectScienFilter, EffectSilence, EffectStereoToMono, EffectTimeScale, EffectToneGen, EffectTruncSilence, VampEffect, VSTEffect, VST3Effect, and EffectWahwah.
Referenced by EffectUIHost::BuildButtonBar(), EffectBase::DoEffect(), GetClassification(), EffectUIHost::OnApply(), EffectBase::Preview(), and EffectUIHost::UpdateControls().
|
virtual |
Fully qualified local help file name, default is empty.
Reimplemented in NyquistEffect.
Definition at line 78 of file EffectInterface.cpp.
Referenced by EffectUIHost::Initialize(), and EffectUIHost::OnHelp().
|
pure virtual |
Whether the effect sorts "above the line" in the menus.
Implemented in AudioUnitEffect, Effect, LadspaEffect, LV2Effect, NyquistEffect, VampEffect, VSTEffect, and VST3Effect.
Referenced by PluginManager::RegisterPlugin().
|
virtual |
Default is false.
Reimplemented in EffectStereoToMono.
Definition at line 83 of file EffectInterface.cpp.
|
pure virtual |
Whether the effect needs a dialog for entry of settings.
Implemented in AudioUnitEffect, Effect, EffectFade, EffectInvert, LadspaEffect, LV2Effect, NyquistEffect, EffectRepair, EffectReverse, EffectStereoToMono, VampEffect, VSTEffect, and VST3Effect.
Referenced by EffectBase::DoEffect(), and PluginManager::RegisterPlugin().
|
virtual |
Name of a page in the Audacity alpha manual, default is empty.
Reimplemented in EffectAmplify, EffectAutoDuck, EffectBassTreble, EffectChangeSpeed, EffectClickRemoval, EffectCompressor, EffectDistortion, EffectDtmf, EffectEcho, EffectEqualization, EffectFindClipping, EffectLoudness, EffectNoise, EffectNormalize, NyquistEffect, EffectPaulstretch, EffectPhaser, EffectRepeat, EffectReverb, EffectScienFilter, EffectSilence, EffectTimeScale, EffectToneGen, EffectTruncSilence, and EffectWahwah.
Definition at line 73 of file EffectInterface.cpp.
Referenced by EffectUIHost::Initialize(), and EffectUIHost::OnHelp().
|
pure virtual |
Whether the effect has any automatable controls.
Implemented in AudioUnitEffect, Effect, LadspaEffect, LV2Effect, EffectNoiseRemoval, VSTEffect, and VST3Effect.
Referenced by PluginManager::RegisterPlugin().
|
pure virtual |
Whether the effect supports realtime previewing (while audio is playing).
Implemented in AudioUnitEffect, EffectBassTreble, EffectDistortion, Effect, LadspaEffect, LV2Effect, EffectPhaser, EffectReverb, VSTEffect, VST3Effect, and EffectWahwah.
Referenced by PluginManager::RegisterPlugin().