| AAX SDK 2.8.0 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- Class List
- Class Index
- Class Hierarchy
- Class Members

Loading...
Searching...
No Matches
List of all members | Public Member Functions
AAX_IACFComponentDescriptor_V2 Class Referenceabstract

`#include <AAX_IACFComponentDescriptor.h>`

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

## Description

Versioned description interface for an AAX plug-in algorithm callback.

## Public Member Functions
virtual AAX_Result | AddTemporaryData (AAX_CFieldIndex inFieldIndex, uint32_t inDataElementSize)=0
| Adds a block of data to a context that is not saved between callbacks and is scaled by the system buffer size.
Public Member Functions inherited from AAX_IACFComponentDescriptor
virtual AAX_Result | Clear ()=0
| Clears the descriptor.
virtual AAX_Result | AddReservedField (AAX_CFieldIndex inFieldIndex, uint32_t inFieldType)=0
| Subscribes a context field to host-provided services or information.
virtual AAX_Result | AddAudioIn (AAX_CFieldIndex inFieldIndex)=0
| Subscribes an audio input context field.
virtual AAX_Result | AddAudioOut (AAX_CFieldIndex inFieldIndex)=0
| Subscribes an audio output context field.
virtual AAX_Result | AddAudioBufferLength (AAX_CFieldIndex inFieldIndex)=0
| Subscribes a buffer length context field.
virtual AAX_Result | AddSampleRate (AAX_CFieldIndex inFieldIndex)=0
| Subscribes a sample rate context field.
virtual AAX_Result | AddClock (AAX_CFieldIndex inFieldIndex)=0
| Subscribes a clock context field.
virtual AAX_Result | AddSideChainIn (AAX_CFieldIndex inFieldIndex)=0
| Subscribes a side-chain input context field.
virtual AAX_Result | AddDataInPort (AAX_CFieldIndex inFieldIndex, uint32_t inPacketSize, AAX_EDataInPortType inPortType)=0
| Adds a custom data port to the algorithm context.
virtual AAX_Result | AddAuxOutputStem (AAX_CFieldIndex inFieldIndex, int32_t inStemFormat, const char inNameUTF8[])=0
| Adds an auxiliary output stem for a plug-in.
virtual AAX_Result | AddPrivateData (AAX_CFieldIndex inFieldIndex, int32_t inDataSize, uint32_t inOptions=AAX_ePrivateDataOptions_DefaultOptions)=0
| Adds a private data port to the algorithm context.
virtual AAX_Result | AddDmaInstance (AAX_CFieldIndex inFieldIndex, AAX_IDma::EMode inDmaMode)=0
| Adds a DMA field to the plug-in's context.
virtual AAX_Result | AddMIDINode (AAX_CFieldIndex inFieldIndex, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t channelMask)=0
| Adds a MIDI node field to the plug-in's context.
virtual AAX_Result | AddProcessProc_Native (AAX_CProcessProc inProcessProc, IACFUnknown *inProperties, AAX_CInstanceInitProc inInstanceInitProc, AAX_CBackgroundProc inBackgroundProc, AAX_CSelector *outProcID)=0
| Registers an algorithm processing entrypoint (process procedure) for the native architecture.
virtual AAX_Result | AddProcessProc_TI (const char inDLLFileNameUTF8[], const char inProcessProcSymbol[], IACFUnknown *inProperties, const char inInstanceInitProcSymbol[], const char inBackgroundProcSymbol[], AAX_CSelector *outProcID)=0
| Registers an algorithm processing entrypoint (process procedure) for the native architecture.
virtual AAX_Result | AddMeters (AAX_CFieldIndex inFieldIndex, const AAX_CTypeID *inMeterIDs, const uint32_t inMeterCount)=0
| Adds a meter field to the plug-in's context.
Public Member Functions inherited from IACFUnknown
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE | QueryInterface (const acfIID &iid, void **ppOut)=0
| Returns pointers to supported interfaces.
virtual acfUInt32 ACFMETHODCALLTYPE | AddRef (void)=0
| Increments reference count.
virtual acfUInt32 ACFMETHODCALLTYPE | Release (void)=0
| Decrements reference count.

## Member Function Documentation

## ◆ AddTemporaryData()

virtual AAX_Result AAX_IACFComponentDescriptor_V2::AddTemporaryData | ( | AAX_CFieldIndex | inFieldIndex,
|  | uint32_t | inDataElementSize
| ) |  |
| pure virtual

Adds a block of data to a context that is not saved between callbacks and is scaled by the system buffer size.

This can be very useful if you use block processing and need to store intermediate results. Just specify your base element size and the system will scale the overall block size by the buffer size. For example, to create a buffer of floats that is the length of the block, specify 4 bytes as the elementsize.

This data block does not retain state across callback and can also be reused across instances on memory contrained systems.

Parameters

  [in] | inFieldIndex | Unique identifier for the port, generated using AAX_FIELD_INDEX
  [in] | inDataElementSize | The size of a single piece of data in the block. This number will be multipied by the processing block size to determine total block size.

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

- AAX_IACFComponentDescriptor.h