AUElement

Superclasses : none
Subclasses : AUIOElement
Header : AUScopeElement

class AUElement 

Each scope of an AudioUnit contains elements which contain the parameters that can be set in that scope. For input and output scopes, elements represent busses and each buss contains some number of channels of audio. For global scope there is a single element containing all of the parameters that affect the entire audio unit. For group scope, the parameters affect that group.


Methods

Constructor


AUElement

public constructor


 AUElement(AUBase *audioUnit);



Destructor


~AUElement

public virtual destructor


 virtual ~AUElement();



Other


GetAudioUnit

public nonvirtual method


 AUBase* GetAudioUnit() const;

Internal. Accessor. Return the AudioUnit that owns this element.



GetName

public nonvirtual method


 CFStringRef GetName () const;



GetRampSliceStartEnd

public nonvirtual method


 void GetRampSliceStartEnd(
          AudioUnitParameterID            paramID,
          Float32&                        outStartValue,
          Float32&                        outEndValue,
          Float32&                        outValuePerFrameDelta
    );



HasName

public nonvirtual method


 bool HasName () const;



SetName

public nonvirtual method


 void SetName (CFStringRef inName);



SetRampParameter

public nonvirtual method


 void SetScheduledEvent(
          AudioUnitParameterID            paramID,
          const AudioUnitParameterEvent&  inEvent,
          UInt32                          inSliceOffsetInBuffer,
          UInt32                          inSliceDurationFrames
    );



UseIndexedParameters

public virtual method


 virtual void UseIndexedParameters(int inNumberOfParameters);



Parameters


GetNumberOfParameters

public nonvirtual method


 UInt32 GetNumberOfParameters();

Internal. Return the number of parameters in this element.



GetParameter

public nonvirtual method


 Float32 GetParameter(AudioUnitParameterID paramID);

Internal. Return the the value of a parameter in this element. This gets called from AUBase::GetParameter.



GetParameterList

public nonvirtual method


 void GetParameterList(AudioUnitParameterID *outList);



RestoreState

public nonvirtual method


 const UInt8* RestoreState(const UInt8 *state);

Internal. Restores the state of this element's parameters from a CFMutableDataRef. This gets called from AUBase::RestoreState.



SaveState

public nonvirtual method


 void SaveState(CFMutableDataRef data);

Internal. Saves the state of this element's parameters to a CFMutableDataRef. This gets called from AUBase::SaveState.



SetParameter

public nonvirtual method


 void SetParameter(
          AudioUnitParameterID            paramID,
          Float32                         value
    );

Internal. Set the the value of a parameter in this element. This gets called from AUBase::SetParameter.



Data


Other


mAudioUnit

private instance variable


 AUBase* mAudioUnit;

The owning AUBase object.



mElementName

private instance variable


 CFStringRef mElementName;



mIndexedParameters

private instance variable


 std::vector<ParameterMapEvent> mIndexedParameters;



mParameters

private instance variable


 ParameterMap mParameters;

A data structure containing all of the parameter values for this element.



mUseIndexedParameters

private instance variable


 bool mUseIndexedParameters;