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

EffectUIClientInterface is an abstract base class to populate a UI and validate UI values. It can import and export presets. More...

#include <EffectInterface.h>

Inheritance diagram for EffectUIClientInterface:
[legend]
Collaboration diagram for EffectUIClientInterface:
[legend]

Public Member Functions

virtual ~EffectUIClientInterface ()
 
virtual int ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false)=0
 
virtual bool SetHost (EffectHostInterface *host)=0
 
virtual bool IsGraphicalUI ()=0
 
virtual bool PopulateUI (ShuttleGui &S)=0
 Adds controls to a panel that is given as the parent window of S More...
 
virtual bool ValidateUI ()=0
 
virtual bool HideUI ()=0
 
virtual bool CloseUI ()=0
 
virtual bool CanExportPresets ()=0
 
virtual void ExportPresets ()=0
 
virtual void ImportPresets ()=0
 
virtual bool HasOptions ()=0
 
virtual void ShowOptions ()=0
 
- Public Member Functions inherited from EffectProcessor
virtual ~EffectProcessor ()
 
virtual unsigned GetAudioInCount ()=0
 
virtual unsigned GetAudioOutCount ()=0
 
virtual int GetMidiInCount ()=0
 
virtual int GetMidiOutCount ()=0
 
virtual void SetSampleRate (double rate)=0
 
virtual size_t SetBlockSize (size_t maxBlockSize)=0
 
virtual size_t GetBlockSize () const =0
 
virtual sampleCount GetLatency ()=0
 Called for destructive, non-realtime effect computation. More...
 
virtual size_t GetTailSize ()=0
 
virtual bool ProcessInitialize (sampleCount totalLen, ChannelNames chanMap=NULL)=0
 Called for destructive, non-realtime effect computation. More...
 
virtual bool ProcessFinalize ()=0
 Called for destructive, non-realtime effect computation. More...
 
virtual size_t ProcessBlock (float **inBlock, float **outBlock, size_t blockLen)=0
 Called for destructive, non-realtime effect computation. More...
 
virtual bool RealtimeInitialize ()=0
 
virtual bool RealtimeAddProcessor (unsigned numChannels, float sampleRate)=0
 
virtual bool RealtimeFinalize ()=0
 
virtual bool RealtimeSuspend ()=0
 
virtual bool RealtimeResume () noexcept=0
 
virtual bool RealtimeProcessStart ()=0
 
virtual size_t RealtimeProcess (int group, float **inBuf, float **outBuf, size_t numSamples)=0
 
virtual bool RealtimeProcessEnd () noexcept=0
 
- Public Member Functions inherited from EffectDefinitionInterface
virtual ~EffectDefinitionInterface ()
 
virtual EffectType GetType ()=0
 Type determines how it behaves. More...
 
virtual EffectType GetClassification ()
 Determines which menu it appears in; default same as GetType(). More...
 
virtual EffectFamilySymbol GetFamily ()=0
 Report identifier and user-visible name of the effect protocol. More...
 
virtual bool IsInteractive ()=0
 Whether the effect needs a dialog for entry of settings. More...
 
virtual bool IsDefault ()=0
 Whether the effect sorts "above the line" in the menus. More...
 
virtual bool IsLegacy ()=0
 
virtual bool SupportsRealtime ()=0
 Whether the effect supports realtime previewing (while audio is playing). More...
 
virtual bool SupportsAutomation ()=0
 Whether the effect can be used without the UI, in a macro. More...
 
virtual bool EnablesDebug ()
 Whether the effect dialog should have a Debug button; default, always false. More...
 
virtual ManualPageID ManualPage ()
 Name of a page in the Audacity alpha manual, default is empty. More...
 
virtual FilePath HelpPage ()
 Fully qualified local help file name, default is empty. More...
 
virtual bool IsHiddenFromMenus ()
 Default is false. More...
 
virtual bool GetAutomationParameters (CommandParameters &parms)=0
 Save current settings into parms. More...
 
virtual bool SetAutomationParameters (CommandParameters &parms)=0
 Change settings to those stored in parms. More...
 
virtual bool LoadUserPreset (const RegistryPath &name)=0
 Change settings to a user-named preset. More...
 
virtual bool SaveUserPreset (const RegistryPath &name)=0
 Save current settings as a user-named preset. More...
 
virtual RegistryPaths GetFactoryPresets ()=0
 Report names of factory presets. More...
 
virtual bool LoadFactoryPreset (int id)=0
 Change settings to the preset whose name is GetFactoryPresets()[id] More...
 
virtual bool LoadFactoryDefaults ()=0
 Change settings back to "factory default". More...
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
virtual PluginPath GetPath ()=0
 
virtual ComponentInterfaceSymbol GetSymbol ()=0
 
virtual VendorSymbol GetVendor ()=0
 
virtual wxString GetVersion ()=0
 
virtual TranslatableString GetDescription ()=0
 
TranslatableString GetName ()
 
virtual bool DefineParams (ShuttleParams &WXUNUSED(S))
 

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

EffectUIClientInterface is an abstract base class to populate a UI and validate UI values. It can import and export presets.

Definition at line 249 of file EffectInterface.h.

Constructor & Destructor Documentation

◆ ~EffectUIClientInterface()

EffectUIClientInterface::~EffectUIClientInterface ( )
virtualdefault

Member Function Documentation

◆ CanExportPresets()

virtual bool EffectUIClientInterface::CanExportPresets ( )
pure virtual

Implemented in VSTEffect, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by EffectUIHost::OnMenu().

Here is the caller graph for this function:

◆ CloseUI()

virtual bool EffectUIClientInterface::CloseUI ( )
pure virtual

Implemented in VSTEffect, LV2Effect, LadspaEffect, EffectEqualization, Effect, and AudioUnitEffect.

Referenced by EffectUIHost::OnClose().

Here is the caller graph for this function:

◆ ExportPresets()

virtual void EffectUIClientInterface::ExportPresets ( )
pure virtual

Implemented in VSTEffect, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by EffectUIHost::OnExport().

Here is the caller graph for this function:

◆ HasOptions()

virtual bool EffectUIClientInterface::HasOptions ( )
pure virtual

Implemented in VSTEffect, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by EffectUIHost::OnMenu().

Here is the caller graph for this function:

◆ HideUI()

virtual bool EffectUIClientInterface::HideUI ( )
pure virtual

◆ ImportPresets()

virtual void EffectUIClientInterface::ImportPresets ( )
pure virtual

Implemented in VSTEffect, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by EffectUIHost::OnImport().

Here is the caller graph for this function:

◆ IsGraphicalUI()

virtual bool EffectUIClientInterface::IsGraphicalUI ( )
pure virtual

Implemented in VSTEffect, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by EffectUIHost::BuildButtonBar().

Here is the caller graph for this function:

◆ PopulateUI()

virtual bool EffectUIClientInterface::PopulateUI ( ShuttleGui S)
pure virtual

Adds controls to a panel that is given as the parent window of S

Implemented in VSTEffect, LV2Effect, LadspaEffect, AudioUnitEffect, and Effect.

Referenced by EffectUIHost::Initialize().

Here is the caller graph for this function:

◆ SetHost()

virtual bool EffectUIClientInterface::SetHost ( EffectHostInterface host)
pure virtual

Implemented in VSTEffect, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by Effect::SetHost().

Here is the caller graph for this function:

◆ ShowClientInterface()

virtual int EffectUIClientInterface::ShowClientInterface ( wxWindow &  parent,
wxDialog &  dialog,
bool  forceModal = false 
)
pure virtual
Returns
0 if destructive effect processing should not proceed (and there may be a non-modal dialog still opened); otherwise, modal dialog return code

Implemented in Effect, VSTEffect, LV2Effect, LadspaEffect, and AudioUnitEffect.

◆ ShowOptions()

virtual void EffectUIClientInterface::ShowOptions ( )
pure virtual

Implemented in VSTEffect, LV2Effect, LadspaEffect, Effect, and AudioUnitEffect.

Referenced by EffectUIHost::OnOptions().

Here is the caller graph for this function:

◆ ValidateUI()

virtual bool EffectUIClientInterface::ValidateUI ( )
pure virtual

Implemented in VSTEffect, LV2Effect, LadspaEffect, EffectEqualization, Effect, and AudioUnitEffect.

Referenced by EffectUIHost::OnApply(), EffectUIHost::OnPlay(), and EffectUIHost::Resume().

Here is the caller graph for this function:

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