AUInputElement

Superclasses : AUIOElement
Subclasses : none
Header : AUInputElement

class AUInputElement : public AUIOElement 

An element class for input scope elements. Contains methods for making connections and pulling inputs.


Methods

Buffers


NeedsBufferSpace

public virtual method


 virtual bool NeedsBufferSpace() const;

Buffer space is only needed if this input uses a callback function to get its input. Inputs connected to other AudioUnits will use the other unit's output buffer to get its input.



Connections


Disconnect

protected nonvirtual method


 void Disconnect();

Breaks any connection to this element from either another AudioUnit or an input callback.



HasConnection

public nonvirtual method


 bool HasConnection() const;

Returns true if this element is connected to another AudioUnit.



IsActive

public nonvirtual method


 bool IsActive() const;

Returns true if this element is connected either to another AudioUnit or an input callback.



IsCallback

public nonvirtual method


 bool IsCallback() const;

Returns true if this element pulls its input from a callback function.



SetConnection

public nonvirtual method


 void SetConnection(const AudioUnitConnection &conn);

Makes a connection from another AudioUnit to this element.



SetInputCallback

public nonvirtual method


 void SetInputCallback(
          ProcPtr                         proc,
          void*                           refCon
    );

Set a function to call to get data for this element.



Constructor


AUInputElement

public constructor


 AUInputElement(AUBase *audioUnit);



Destructor


~AUInputElement

public virtual destructor


 virtual ~AUInputElement();



Format


SetStreamFormat

public virtual method


 virtual OSStatus SetStreamFormat(const CAStreamBasicDescription &desc);

Overridden to allocate buffer space.



Rendering


PullInput

public nonvirtual method


 ComponentResult PullInput(
          AudioUnitRenderActionFlags&     ioActionFlags,
          const AudioTimeStamp&           inTimeStamp,
          AudioUnitElement                inElement,
          UInt32                          inNumberFrames
    );

A convenience method for getting data for an input.



Data


Other


mConnInstanceStorage

protected instance variable


 void* mConnInstanceStorage;



mConnRenderProc

protected instance variable


 ProcPtr mConnRenderProc;



mConnection

protected instance variable


 AudioUnitConnection mConnection;



mCritical

protected instance variable


 bool mCritical;

A (broken) way of preventing a change of connection from happening during a render call.



mInputProc

protected instance variable


 ProcPtr mInputProc;



mInputProcRefCon

protected instance variable


 void* mInputProcRefCon;



mInputType

protected instance variable


 EInputType mInputType;