AudioUnitEffectOptionsDialog Class Reference

Inheritance diagram for AudioUnitEffectOptionsDialog:

Collaboration diagram for AudioUnitEffectOptionsDialog:

Public Member Functions
	AudioUnitEffectOptionsDialog (wxWindow *parent, EffectHostInterface *host)
virtual	~AudioUnitEffectOptionsDialog ()
void	PopulateOrExchange (ShuttleGui &S)
void	OnOk (wxCommandEvent &evt)
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Attributes
EffectHostInterface *	mHost
bool	mUseLatency
TranslatableString	mUIType

Detailed Description

Definition at line 498 of file AudioUnitEffect.cpp.

Constructor & Destructor Documentation

AudioUnitEffectOptionsDialog()

AudioUnitEffectOptionsDialog::AudioUnitEffectOptionsDialog	(	wxWindow *	parent,
		EffectHostInterface *	host
	)

Definition at line 521 of file AudioUnitEffect.cpp.

:  wxDialogWrapper(parent, wxID_ANY, XO("Audio Unit Effect Options"))
{
   mHost = host;
 
   mHost->GetSharedConfig(wxT("Options"), wxT("UseLatency"), mUseLatency, true);
 
   // Expect one of three string values from the config file
   wxString uiType;
   mHost->GetSharedConfig(wxT("Options"), wxT("UIType"), uiType, wxT("Full"));
 
   // Get the localization of the string for display to the user
   mUIType = TranslatableString{ uiType, {} };
 
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
}

References eIsCreating.

~AudioUnitEffectOptionsDialog()

AudioUnitEffectOptionsDialog::~AudioUnitEffectOptionsDialog ( )

virtual

Definition at line 539 of file AudioUnitEffect.cpp.

{
}

Member Function Documentation

OnOk()

void AudioUnitEffectOptionsDialog::OnOk

(

wxCommandEvent &

evt

)

Definition at line 608 of file AudioUnitEffect.cpp.

{
   if (!Validate())
   {
      return;
   }
 
   ShuttleGui S(this, eIsGettingFromDialog);
   PopulateOrExchange(S);
 
   // un-translate the type
   auto uiType = mUIType.MSGID().GET();
 
   mHost->SetSharedConfig(wxT("Options"), wxT("UseLatency"), mUseLatency);
   mHost->SetSharedConfig(wxT("Options"), wxT("UIType"), uiType);
 
   EndModal(wxID_OK);
}

References eIsGettingFromDialog, Identifier::GET(), mHost, TranslatableString::MSGID(), mUIType, mUseLatency, PopulateOrExchange(), and ConfigClientInterface::SetSharedConfig().

Here is the call graph for this function:

PopulateOrExchange()

void AudioUnitEffectOptionsDialog::PopulateOrExchange

(

ShuttleGui &

S

)

Definition at line 543 of file AudioUnitEffect.cpp.

{
   
   S.SetBorder(5);
   S.StartHorizontalLay(wxEXPAND, 1);
   {
      S.StartVerticalLay(false);
      {
         S.StartStatic(XO("Latency Compensation"));
         {
            S.AddVariableText(XO(
"As part of their processing, some Audio Unit effects must delay returning "
"audio to Audacity. When not compensating for this delay, you will "
"notice that small silences have been inserted into the audio. "
"Enabling this option will provide that compensation, but it may "
"not work for all Audio Unit effects."),
               false, 0, 650);
 
            S.StartHorizontalLay(wxALIGN_LEFT);
            {
               S.TieCheckBox(XXO("Enable &compensation"),
                             mUseLatency);
            }
            S.EndHorizontalLay();
         }
         S.EndStatic();
 
         S.StartStatic(XO("User Interface"));
         {
            S.AddVariableText(XO(
"Select \"Full\" to use the graphical interface if supplied by the Audio Unit."
" Select \"Generic\" to use the system supplied generic interface."
#if defined(HAVE_AUDIOUNIT_BASIC_SUPPORT)
" Select \"Basic\" for a basic text-only interface."
#endif
" Reopen the effect for this to take effect."),
               false, 0, 650);
 
            S.StartHorizontalLay(wxALIGN_LEFT);
            {
               S.TieChoice(XXO("Select &interface"),
                  mUIType,
                  {
                     XO("Full"),
                     XO("Generic"),
#if defined(HAVE_AUDIOUNIT_BASIC_SUPPORT)
                     XO("Basic")
#endif
                  });
            }
            S.EndHorizontalLay();
         }
         S.EndStatic();
      }
      S.EndVerticalLay();
   }
   S.EndHorizontalLay();
 
   S.AddStandardButtons();
 
   Layout();
   Fit();
   Center();
}

References ShuttleGui::AddStandardButtons(), ShuttleGuiBase::AddVariableText(), ShuttleGuiBase::EndHorizontalLay(), ShuttleGuiBase::EndStatic(), ShuttleGuiBase::EndVerticalLay(), mUIType, mUseLatency, ShuttleGuiBase::SetBorder(), ShuttleGuiBase::StartHorizontalLay(), ShuttleGuiBase::StartStatic(), ShuttleGuiBase::StartVerticalLay(), ShuttleGuiBase::TieCheckBox(), ShuttleGuiBase::TieChoice(), XO, and XXO.

Referenced by OnOk().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mHost

EffectHostInterface* AudioUnitEffectOptionsDialog::mHost

private

Definition at line 509 of file AudioUnitEffect.cpp.

Referenced by OnOk().

mUIType

TranslatableString AudioUnitEffectOptionsDialog::mUIType

private

Definition at line 512 of file AudioUnitEffect.cpp.

Referenced by OnOk(), and PopulateOrExchange().

mUseLatency

bool AudioUnitEffectOptionsDialog::mUseLatency

private

Definition at line 511 of file AudioUnitEffect.cpp.

Referenced by OnOk(), and PopulateOrExchange().

---

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

• AudioUnitEffect.cpp