ParameterInfo Class Reference

Public Member Functions
	ParameterInfo ()
bool	Get (AudioUnit mUnit, AudioUnitParameterID parmID)

Public Attributes
wxString	name
AudioUnitParameterInfo	info

Static Public Attributes
static const char	idBeg = wxT('<')
static const char	idSep = wxT(',')
static const char	idEnd = wxT('>')

Detailed Description

Definition at line 80 of file AudioUnitEffect.cpp.

Constructor & Destructor Documentation

ParameterInfo()

ParameterInfo::ParameterInfo ( )

inline

Definition at line 83 of file AudioUnitEffect.cpp.

   {
      info = {};
   }

References info.

Member Function Documentation

Get()

bool ParameterInfo::Get ( AudioUnit  mUnit, AudioUnitParameterID  parmID  )

inline

Definition at line 88 of file AudioUnitEffect.cpp.

   {
      UInt32 dataSize;
 
      info = {};
      // Note non-default element parameter, parmID
      if (AudioUnitUtils::GetFixedSizeProperty(mUnit,
         kAudioUnitProperty_ParameterInfo, info,
         kAudioUnitScope_Global, parmID))
         return false;
 
      if (info.flags & kAudioUnitParameterFlag_HasCFNameString)
         name = wxCFStringRef::AsString(info.cfNameString);
      else
         name = wxString(info.name);
 
#if defined(USE_EXTENDED_NAMES)
      // If the parameter has a non-empty name, then the final parameter name will
      // be either:
      //
      //    <parmID,ParameterName>
      //
      // or (if the name isn't available):
      //
      //    <parmID>
      if (!name.empty())
      {
         name.Replace(idBeg, wxT('_'));
         name.Replace(idSep, wxT('_'));
         name.Replace(idEnd, wxT('_'));
         name.Append(idSep);
      }
      name = wxString::Format(wxT("%c%s%x%c"),
                              idBeg,
                              name,
                              parmID,
                              idEnd);
 
      // If the parameter has a clumpID, then the final parameter name will be
      // either:
      //
      //    <clumpID,clumpName><parmID,ParameterName>
      //
      // or (if the clumpName isn't available):
      //
      //    <clumpID><parmID,ParameterName>
      if (info.flags & kAudioUnitParameterFlag_HasClump)
      {
         wxString clumpName;
         AudioUnitUtils::ParameterNameInfo clumpInfo{
            info.clumpID, kAudioUnitParameterName_Full
         };
 
         if (!AudioUnitUtils::GetFixedSizeProperty(mUnit,
            kAudioUnitProperty_ParameterClumpName, clumpInfo)) {
            clumpName =  wxCFStringRef::AsString(clumpInfo.outName);
            clumpName.Replace(idBeg, wxT('_'));
            clumpName.Replace(idSep, wxT('_'));
            clumpName.Replace(idEnd, wxT('_'));
            clumpName.Append(idSep);
         }
         name = wxString::Format(wxT("%c%s%x%c%s"),
                                 idBeg,
                                 clumpName,
                                 info.clumpID,
                                 idEnd,
                                 name);
      }
#endif
 
      return true;
   }

References AudioUnitUtils::GetFixedSizeProperty(), idBeg, idEnd, idSep, info, and name.

Referenced by AudioUnitEffect::LoadSettings(), AudioUnitEffect::SaveSettings(), and AudioUnitEffect::SupportsAutomation().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

idBeg

const char ParameterInfo::idBeg = wxT('<')

static

Definition at line 161 of file AudioUnitEffect.cpp.

Referenced by Get().

idEnd

const char ParameterInfo::idEnd = wxT('>')

static

Definition at line 163 of file AudioUnitEffect.cpp.

Referenced by Get().

idSep

const char ParameterInfo::idSep = wxT(',')

static

Definition at line 162 of file AudioUnitEffect.cpp.

Referenced by Get().

info

AudioUnitParameterInfo ParameterInfo::info

Definition at line 166 of file AudioUnitEffect.cpp.

Referenced by Get(), ParameterInfo(), and AudioUnitEffect::SupportsAutomation().

name

wxString ParameterInfo::name

Definition at line 165 of file AudioUnitEffect.cpp.

Referenced by Get(), AudioUnitEffect::LoadSettings(), and AudioUnitEffect::SaveSettings().

---

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

• AudioUnitEffect.cpp