\hypertarget{a02014}{}\doxysection{AAX\+\_\+\+IACFComponent\+Descriptor Class Reference}
\label{a02014}\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}


{\ttfamily \#include $<$AAX\+\_\+\+IACFComponent\+Descriptor.\+h$>$}



Inheritance diagram for AAX\+\_\+\+IACFComponent\+Descriptor\+:
% FIG 0


Collaboration diagram for AAX\+\_\+\+IACFComponent\+Descriptor\+:
% FIG 1


\doxysubsection{Description}
Versioned description interface for an AAX plug-\/in algorithm callback. \doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_ab93e4b968f3239326ac1046b64eab2f5}{Clear}} ()=0
\begin{DoxyCompactList}\small\item\em Clears the descriptor.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_aa81ce274471a76742e71d02bc3442253}{Add\+Reserved\+Field}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index, uint32\+\_\+t in\+Field\+Type)=0
\begin{DoxyCompactList}\small\item\em Subscribes a context field to host-\/provided services or information.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_a81370dad377b30b3c5dec9ba0e9ad310}{Add\+Audio\+In}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index)=0
\begin{DoxyCompactList}\small\item\em Subscribes an audio input context field.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_a70e7e5c55208bcafd6b402eebf12aeb7}{Add\+Audio\+Out}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index)=0
\begin{DoxyCompactList}\small\item\em Subscribes an audio output context field.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_a38c2683ca133ca0863e4645afd27ab9f}{Add\+Audio\+Buffer\+Length}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index)=0
\begin{DoxyCompactList}\small\item\em Subscribes a buffer length context field.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_aa59e93b261ae1f4951ed84b55b70742e}{Add\+Sample\+Rate}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index)=0
\begin{DoxyCompactList}\small\item\em Subscribes a sample rate context field.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_af9864953ec953720b844e9ad57a2da14}{Add\+Clock}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index)=0
\begin{DoxyCompactList}\small\item\em Subscribes a clock context field.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_ac88f0100827278c2f9bfae2f74ae103f}{Add\+Side\+Chain\+In}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index)=0
\begin{DoxyCompactList}\small\item\em Subscribes a side-\/chain input context field.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_af15ea360a7e581ac796b95b473057dad}{Add\+Data\+In\+Port}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index, uint32\+\_\+t in\+Packet\+Size, \mbox{\hyperlink{a00446_ab5677b173ad8647c24d34d28272d11fc}{AAX\+\_\+\+EData\+In\+Port\+Type}} in\+Port\+Type)=0
\begin{DoxyCompactList}\small\item\em Adds a custom data port to the algorithm context.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_a9207476186fa1b1fb361dd36b242e567}{Add\+Aux\+Output\+Stem}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index, int32\+\_\+t in\+Stem\+Format, const char in\+Name\+UTF8\mbox{[}$\,$\mbox{]})=0
\begin{DoxyCompactList}\small\item\em Adds an auxiliary output stem for a plug-\/in.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_aaec556edd58fea7d4b6c404f7ce1f95c}{Add\+Private\+Data}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index, int32\+\_\+t in\+Data\+Size, uint32\+\_\+t in\+Options=\mbox{\hyperlink{a00446_a9f1ef2cb64daf30eaf145dfbb8cd0d00a59458e9bf18919c51e59eb2fd6e84a9a}{AAX\+\_\+e\+Private\+Data\+Options\+\_\+\+Default\+Options}})=0
\begin{DoxyCompactList}\small\item\em Adds a private data port to the algorithm context.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_aed4d0748c59e03fe18b79b924f7dbaab}{Add\+Dma\+Instance}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index, \mbox{\hyperlink{a02250_af8d0f19f2896dd6dbd126b919b24e39b}{AAX\+\_\+\+IDma\+::\+EMode}} in\+Dma\+Mode)=0
\begin{DoxyCompactList}\small\item\em Adds a DMA field to the plug-\/in\textquotesingle{}s context.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_a72b9908f5bbef7d5fb3d259b76861a82}{Add\+MIDINode}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index, \mbox{\hyperlink{a00446_a5e1dffce35d05990dbbad651702678e4}{AAX\+\_\+\+EMIDINode\+Type}} in\+Node\+Type, const char in\+Node\+Name\mbox{[}$\,$\mbox{]}, uint32\+\_\+t channel\+Mask)=0
\begin{DoxyCompactList}\small\item\em Adds a MIDI node field to the plug-\/in\textquotesingle{}s context.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_a4acfd619cfbd35ffd0ff20ca67bda305}{Add\+Process\+Proc\+\_\+\+Native}} (\mbox{\hyperlink{a00779_ad6dd5e1aa5bd2f8462966685e3b26a6e}{AAX\+\_\+\+CProcess\+Proc}} in\+Process\+Proc, \mbox{\hyperlink{a01770}{IACFUnknown}} $\ast$in\+Properties, \mbox{\hyperlink{a00779_a3963a850079d3186e08c97a1a4d0ef1c}{AAX\+\_\+\+CInstance\+Init\+Proc}} in\+Instance\+Init\+Proc, \mbox{\hyperlink{a00779_aa64561d963284a3124a0821e7dc79c9a}{AAX\+\_\+\+CBackground\+Proc}} in\+Background\+Proc, \mbox{\hyperlink{a00542_aeaf9b387f902c50a8360ff423f4a1f23}{AAX\+\_\+\+CSelector}} $\ast$out\+Proc\+ID)=0
\begin{DoxyCompactList}\small\item\em Registers an algorithm processing entrypoint (process procedure) for the native architecture.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_adf549e7f348c670b79bdb5f283798db2}{Add\+Process\+Proc\+\_\+\+TI}} (const char in\+DLLFile\+Name\+UTF8\mbox{[}$\,$\mbox{]}, const char in\+Process\+Proc\+Symbol\mbox{[}$\,$\mbox{]}, \mbox{\hyperlink{a01770}{IACFUnknown}} $\ast$in\+Properties, const char in\+Instance\+Init\+Proc\+Symbol\mbox{[}$\,$\mbox{]}, const char in\+Background\+Proc\+Symbol\mbox{[}$\,$\mbox{]}, \mbox{\hyperlink{a00542_aeaf9b387f902c50a8360ff423f4a1f23}{AAX\+\_\+\+CSelector}} $\ast$out\+Proc\+ID)=0
\begin{DoxyCompactList}\small\item\em Registers an algorithm processing entrypoint (process procedure) for the native architecture.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02014_a6b7aec8153fb7243d62284ea504c5681}{Add\+Meters}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index, const \mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} $\ast$in\+Meter\+IDs, const uint32\+\_\+t in\+Meter\+Count)=0
\begin{DoxyCompactList}\small\item\em Adds a meter field to the plug-\/in\textquotesingle{}s context.   \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions inherited from \mbox{\hyperlink{a01770}{IACFUnknown}}}
\begin{DoxyCompactItemize}
\item 
virtual BEGIN\+\_\+\+ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE \mbox{\hyperlink{a01770_a8b7f0ae9c78d007ca76aa462ebe53135}{Query\+Interface}} (const \mbox{\hyperlink{a00308_a59df0b41744eee7a066787aaedf97f67}{acf\+IID}} \&iid, void $\ast$$\ast$pp\+Out)=0
\begin{DoxyCompactList}\small\item\em Returns pointers to supported interfaces. \end{DoxyCompactList}\item 
virtual acf\+UInt32 ACFMETHODCALLTYPE \mbox{\hyperlink{a01770_aa9c7a5b9dff341092b7b86bb9b3a58fb}{Add\+Ref}} (void)=0
\begin{DoxyCompactList}\small\item\em Increments reference count. \end{DoxyCompactList}\item 
virtual acf\+UInt32 ACFMETHODCALLTYPE \mbox{\hyperlink{a01770_afabd38cec0a9ed37f1d3e8644a70ac41}{Release}} (void)=0
\begin{DoxyCompactList}\small\item\em Decrements reference count. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{a02014_ab93e4b968f3239326ac1046b64eab2f5}\label{a02014_ab93e4b968f3239326ac1046b64eab2f5}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!Clear@{Clear}}
\index{Clear@{Clear}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{Clear()}{Clear()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Clear (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Clears the descriptor.   

Clears the descriptor and readies it for the next algorithm description   \mbox{\Hypertarget{a02014_aa81ce274471a76742e71d02bc3442253}\label{a02014_aa81ce274471a76742e71d02bc3442253}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddReservedField@{AddReservedField}}
\index{AddReservedField@{AddReservedField}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddReservedField()}{AddReservedField()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Reserved\+Field (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index,  }\item[{uint32\+\_\+t}]{in\+Field\+Type }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Subscribes a context field to host-\/provided services or information.   

\begin{DoxyNote}{Note}
Currently for internal use only.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the field, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}} \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Field\+Type} & Type of field that is being added   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_a81370dad377b30b3c5dec9ba0e9ad310}\label{a02014_a81370dad377b30b3c5dec9ba0e9ad310}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddAudioIn@{AddAudioIn}}
\index{AddAudioIn@{AddAudioIn}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddAudioIn()}{AddAudioIn()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Audio\+In (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Subscribes an audio input context field.   

Defines an audio in port for host-\/provided information in the algorithm\textquotesingle{}s context structure.


\begin{DoxyItemize}
\item Data type\+: float$\ast$$\ast$
\item Data kind\+: An array of float arrays, one for each input channel
\end{DoxyItemize}


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the field, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}}   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_a70e7e5c55208bcafd6b402eebf12aeb7}\label{a02014_a70e7e5c55208bcafd6b402eebf12aeb7}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddAudioOut@{AddAudioOut}}
\index{AddAudioOut@{AddAudioOut}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddAudioOut()}{AddAudioOut()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Audio\+Out (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Subscribes an audio output context field.   

Defines an audio out port for host-\/provided information in the algorithm\textquotesingle{}s context structure.


\begin{DoxyItemize}
\item Data type\+: float$\ast$$\ast$
\item Data kind\+: An array of float arrays, one for each output channel
\end{DoxyItemize}


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the field, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}}   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_a38c2683ca133ca0863e4645afd27ab9f}\label{a02014_a38c2683ca133ca0863e4645afd27ab9f}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddAudioBufferLength@{AddAudioBufferLength}}
\index{AddAudioBufferLength@{AddAudioBufferLength}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddAudioBufferLength()}{AddAudioBufferLength()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Audio\+Buffer\+Length (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Subscribes a buffer length context field.   

Defines a buffer length port for host-\/provided information in the algorithm\textquotesingle{}s context structure.


\begin{DoxyItemize}
\item Data type\+: int32\+\_\+t$\ast$
\item Data kind\+: The number of samples in the current audio buffer
\end{DoxyItemize}


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the field, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}}   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_aa59e93b261ae1f4951ed84b55b70742e}\label{a02014_aa59e93b261ae1f4951ed84b55b70742e}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddSampleRate@{AddSampleRate}}
\index{AddSampleRate@{AddSampleRate}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddSampleRate()}{AddSampleRate()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Sample\+Rate (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Subscribes a sample rate context field.   

Defines a sample rate port for host-\/provided information in the algorithm\textquotesingle{}s context structure.


\begin{DoxyItemize}
\item Data type\+: \mbox{\hyperlink{a00542_a3d9eea08f47e0b0a23432e15baa4e885}{AAX\+\_\+\+CSample\+Rate}} $\ast$
\item Data kind\+: The current sample rate
\end{DoxyItemize}


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the field, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}}   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_af9864953ec953720b844e9ad57a2da14}\label{a02014_af9864953ec953720b844e9ad57a2da14}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddClock@{AddClock}}
\index{AddClock@{AddClock}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddClock()}{AddClock()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Clock (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Subscribes a clock context field.   

Defines a clock port for host-\/provided information in the algorithm\textquotesingle{}s context structure.


\begin{DoxyItemize}
\item Data type\+: \mbox{\hyperlink{a00542_aae7325dbfa53a983f208a68cb563fba5}{AAX\+\_\+\+CTimestamp}} $\ast$
\item Data kind\+: A running counter which increments even when the transport is not playing. The counter increments exactly once per sample quantum.

\begin{DoxyRefDesc}{Host Compatibility Notes}
\item[\mbox{\hyperlink{a00879__compatibility_notes000051}{Host Compatibility Notes}}]As of Pro Tools 11.\+1, this field may be used in both Native and DSP plug-\/ins. The DSP clock data is a 16-\/bit cycling counter. This field was only available for Native plug-\/ins in previous Pro Tools versions.\end{DoxyRefDesc}

\end{DoxyItemize}


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the field, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}}   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_ac88f0100827278c2f9bfae2f74ae103f}\label{a02014_ac88f0100827278c2f9bfae2f74ae103f}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddSideChainIn@{AddSideChainIn}}
\index{AddSideChainIn@{AddSideChainIn}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddSideChainIn()}{AddSideChainIn()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Side\+Chain\+In (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Subscribes a side-\/chain input context field.   

Defines a side-\/chain input port for host-\/provided information in the algorithm\textquotesingle{}s context structure.


\begin{DoxyItemize}
\item Data type\+: int32\+\_\+t$\ast$
\item Data kind\+: The index of the plug-\/in\textquotesingle{}s first side-\/chain input channel within the array of input audio buffers
\end{DoxyItemize}


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the field, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}}   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_af15ea360a7e581ac796b95b473057dad}\label{a02014_af15ea360a7e581ac796b95b473057dad}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddDataInPort@{AddDataInPort}}
\index{AddDataInPort@{AddDataInPort}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddDataInPort()}{AddDataInPort()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Data\+In\+Port (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index,  }\item[{uint32\+\_\+t}]{in\+Packet\+Size,  }\item[{\mbox{\hyperlink{a00446_ab5677b173ad8647c24d34d28272d11fc}{AAX\+\_\+\+EData\+In\+Port\+Type}}}]{in\+Port\+Type }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Adds a custom data port to the algorithm context.   

Defines a read-\/only data port for plug-\/in information in the algorithm\textquotesingle{}s context structure. The plug-\/in can send information to this port using \mbox{\hyperlink{a02222_ae5dd2b5925dbc181513bca1c4ac5e716}{AAX\+\_\+\+IController\+::\+Post\+Packet()}}.

The host guarantees that all packets will be delivered to this port in the order in which they were posted, up to the point of a packet buffer overflow, though some packets may be dropped depending on the {\ttfamily in\+Port\+Type} and host implementation.

\begin{DoxyNote}{Note}
When a plug-\/in is operating in offline (Audio\+Suite) mode, all data ports operate as \mbox{\hyperlink{a00446_ab5677b173ad8647c24d34d28272d11fca43dc59a68b369ee607f70700bfd02c2d}{AAX\+\_\+e\+Data\+In\+Port\+Type\+\_\+\+Unbuffered}} ports
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the port, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}} \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Packet\+Size} & Size of the data packets that will be sent to this port \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Port\+Type} & The requested packet delivery behavior for this port   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_a9207476186fa1b1fb361dd36b242e567}\label{a02014_a9207476186fa1b1fb361dd36b242e567}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddAuxOutputStem@{AddAuxOutputStem}}
\index{AddAuxOutputStem@{AddAuxOutputStem}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddAuxOutputStem()}{AddAuxOutputStem()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Aux\+Output\+Stem (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index,  }\item[{int32\+\_\+t}]{in\+Stem\+Format,  }\item[{const char}]{in\+Name\+UTF8\mbox{[}$\,$\mbox{]} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Adds an auxiliary output stem for a plug-\/in.   

Use this method to add additional output channels to the algorithm context.

The aux output stem audio buffers will be added to the end of the audio outputs array in the order in which they are described. When writing audio data to a specific aux output, find the proper starting channel by accumulating all of the channels of the main output stem format and any previously-\/described aux output stems.

The plug-\/in is responsible for providing a meaningful name for each aux outputs. At the very least, individual outputs should be labeled \char`\"{}\+Output xx\char`\"{}, where \char`\"{}xx\char`\"{} is the aux output number as it is defined in the plug-\/in. The output name should also include the words \char`\"{}mono\char`\"{} and \char`\"{}stereo\char`\"{} to support when users are looking for an output with a specific stem format.

\begin{DoxyRefDesc}{Host Compatibility Notes}
\item[\mbox{\hyperlink{a00879__compatibility_notes000052}{Host Compatibility Notes}}]There is a hard limit to the number of outputs that Pro Tools supports for a single plug-\/in instance. This limit is currently set at 256 channels, which includes all of the plug-\/in\textquotesingle{}s output channels in addition to the sum total of all of its aux output stem channels.\end{DoxyRefDesc}


\begin{DoxyRefDesc}{Host Compatibility Notes}
\item[\mbox{\hyperlink{a00879__compatibility_notes000053}{Host Compatibility Notes}}]Pro Tools supports only mono and stereo auxiliary output stem formats\end{DoxyRefDesc}


\begin{DoxyWarning}{Warning}
This method will return an error code on hosts which do not support auxiliary output stems. This indicates that the host will not provide audio buffers for auxiliary output stems during processing. A plug-\/in must not attempt to write data into auxiliary output stem buffers which have not been provided by the host!
\end{DoxyWarning}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & DEPRECATED\+: This parameter is no longer needed by the host, but is included in the interface for binary compatibility \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Stem\+Format} & The stem format of the new aux output \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Name\+UTF8} & The name of the aux output. This name is static and cannot be changed after the descriptor is submitted to the host   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_aaec556edd58fea7d4b6c404f7ce1f95c}\label{a02014_aaec556edd58fea7d4b6c404f7ce1f95c}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddPrivateData@{AddPrivateData}}
\index{AddPrivateData@{AddPrivateData}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddPrivateData()}{AddPrivateData()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Private\+Data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index,  }\item[{int32\+\_\+t}]{in\+Data\+Size,  }\item[{uint32\+\_\+t}]{in\+Options = {\ttfamily \mbox{\hyperlink{a00446_a9f1ef2cb64daf30eaf145dfbb8cd0d00a59458e9bf18919c51e59eb2fd6e84a9a}{AAX\+\_\+e\+Private\+Data\+Options\+\_\+\+Default\+Options}}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Adds a private data port to the algorithm context.   

Defines a read/write data port for private state data. Data written to this port will be maintained by the host between calls to the algorithm context.

\begin{DoxySeeAlso}{See also}
alg\+\_\+pd\+\_\+registration
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the port, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}} \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Data\+Size} & Size of the data packets that will be sent to this port \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Options} & Options that define the private data port\textquotesingle{}s behavior   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_aed4d0748c59e03fe18b79b924f7dbaab}\label{a02014_aed4d0748c59e03fe18b79b924f7dbaab}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddDmaInstance@{AddDmaInstance}}
\index{AddDmaInstance@{AddDmaInstance}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddDmaInstance()}{AddDmaInstance()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Dma\+Instance (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index,  }\item[{\mbox{\hyperlink{a02250_af8d0f19f2896dd6dbd126b919b24e39b}{AAX\+\_\+\+IDma\+::\+EMode}}}]{in\+Dma\+Mode }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Adds a DMA field to the plug-\/in\textquotesingle{}s context.   

DMA (direct memory access) provides efficient reads from and writes to external memory on the DSP. DMA behavior is emulated in host-\/based plug-\/ins for cross-\/platform portability.

\begin{DoxyNote}{Note}
The order in which DMA instances are added defines their priority and therefore order of execution of DMA operations. In most plug-\/ins, Scatter fields should be placed first in order to achieve the lowest possible access latency.
\end{DoxyNote}
For more information, see \mbox{\hyperlink{a00898}{Direct Memory Access}} .

\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000042}{Todo}}]Update the DMA system management such that operation priority can be set arbitrarily\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the field, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}} \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Dma\+Mode} & \mbox{\hyperlink{a02250_af8d0f19f2896dd6dbd126b919b24e39b}{AAX\+\_\+\+IDma\+::\+EMode}} that will apply to this field   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_a72b9908f5bbef7d5fb3d259b76861a82}\label{a02014_a72b9908f5bbef7d5fb3d259b76861a82}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddMIDINode@{AddMIDINode}}
\index{AddMIDINode@{AddMIDINode}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddMIDINode()}{AddMIDINode()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+MIDINode (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index,  }\item[{\mbox{\hyperlink{a00446_a5e1dffce35d05990dbbad651702678e4}{AAX\+\_\+\+EMIDINode\+Type}}}]{in\+Node\+Type,  }\item[{const char}]{in\+Node\+Name\mbox{[}$\,$\mbox{]},  }\item[{uint32\+\_\+t}]{channel\+Mask }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Adds a MIDI node field to the plug-\/in\textquotesingle{}s context.   


\begin{DoxyItemize}
\item Data type\+: \mbox{\hyperlink{a02290}{AAX\+\_\+\+IMIDINode}} $\ast$
\end{DoxyItemize}

The resulting MIDI node data will be available both in the algorithm context and in the plug-\/in\textquotesingle{}s \mbox{\hyperlink{a02266}{data model}} via \mbox{\hyperlink{a02074_a229029f0d4bd758538c48931b9f9a9ad}{Update\+MIDINodes()}}.

To add a MIDI node that is only accessible to the plug-\/in\textquotesingle{}s data model, use \mbox{\hyperlink{a02254_aa7709de005e0256feb522758ccc5b582}{AAX\+\_\+\+IEffect\+Descriptor\+::\+Add\+Control\+MIDINode()}}

\begin{DoxyRefDesc}{Host Compatibility Notes}
\item[\mbox{\hyperlink{a00879__compatibility_notes000054}{Host Compatibility Notes}}]Due to current restrictions MIDI data won\textquotesingle{}t be delivered to DSP algorithms, only to AAX Native.\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & The ID of the port. MIDI node ports should formatted as a pointer to an \mbox{\hyperlink{a02290}{AAX\+\_\+\+IMIDINode}}. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Node\+Type} & The type of MIDI node, as \mbox{\hyperlink{a00446_a5e1dffce35d05990dbbad651702678e4}{AAX\+\_\+\+EMIDINode\+Type}} \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Node\+Name} & The name of the MIDI node as it should appear in the host\textquotesingle{}s UI \\
\hline
\mbox{\texttt{ in}}  & {\em channel\+Mask} & The channel mask for the MIDI node. This parameter specifies used MIDI channels. For Global MIDI nodes, use a mask of \mbox{\hyperlink{a00446_a349dae6bc64bda67a5440cbc6637f92d}{AAX\+\_\+\+EMidi\+Global\+Node\+Selectors}}   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02014_a4acfd619cfbd35ffd0ff20ca67bda305}\label{a02014_a4acfd619cfbd35ffd0ff20ca67bda305}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddProcessProc\_Native@{AddProcessProc\_Native}}
\index{AddProcessProc\_Native@{AddProcessProc\_Native}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddProcessProc\_Native()}{AddProcessProc\_Native()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Process\+Proc\+\_\+\+Native (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00779_ad6dd5e1aa5bd2f8462966685e3b26a6e}{AAX\+\_\+\+CProcess\+Proc}}}]{in\+Process\+Proc,  }\item[{\mbox{\hyperlink{a01770}{IACFUnknown}} $\ast$}]{in\+Properties,  }\item[{\mbox{\hyperlink{a00779_a3963a850079d3186e08c97a1a4d0ef1c}{AAX\+\_\+\+CInstance\+Init\+Proc}}}]{in\+Instance\+Init\+Proc,  }\item[{\mbox{\hyperlink{a00779_aa64561d963284a3124a0821e7dc79c9a}{AAX\+\_\+\+CBackground\+Proc}}}]{in\+Background\+Proc,  }\item[{\mbox{\hyperlink{a00542_aeaf9b387f902c50a8360ff423f4a1f23}{AAX\+\_\+\+CSelector}} $\ast$}]{out\+Proc\+ID }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Registers an algorithm processing entrypoint (process procedure) for the native architecture.   


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Process\+Proc} & Symbol for this processing callback \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Properties} & A property map for this processing callback. The property map\textquotesingle{}s values are copied by the host and associated with the new Process\+Proc. The property map contents are unchanged and the map may be re-\/used when registering additional Process\+Procs. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Instance\+Init\+Proc} & Initialization routine that will be called when a new instance of the Effect is created. See \mbox{\hyperlink{a00890_alg_initialization}{Algorithm initialization}}. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Background\+Proc} & Background routine that will be called in an idle context within the same address space as the associated process procedure. See \mbox{\hyperlink{a00897}{Background processing callback}} \\
\hline
\mbox{\texttt{ out}}  & {\em out\+Proc\+ID} & \\
\hline
\end{DoxyParams}
\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000043}{Todo}}]document this parameter \end{DoxyRefDesc}
\mbox{\Hypertarget{a02014_adf549e7f348c670b79bdb5f283798db2}\label{a02014_adf549e7f348c670b79bdb5f283798db2}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddProcessProc\_TI@{AddProcessProc\_TI}}
\index{AddProcessProc\_TI@{AddProcessProc\_TI}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddProcessProc\_TI()}{AddProcessProc\_TI()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Process\+Proc\+\_\+\+TI (\begin{DoxyParamCaption}\item[{const char}]{in\+DLLFile\+Name\+UTF8\mbox{[}$\,$\mbox{]},  }\item[{const char}]{in\+Process\+Proc\+Symbol\mbox{[}$\,$\mbox{]},  }\item[{\mbox{\hyperlink{a01770}{IACFUnknown}} $\ast$}]{in\+Properties,  }\item[{const char}]{in\+Instance\+Init\+Proc\+Symbol\mbox{[}$\,$\mbox{]},  }\item[{const char}]{in\+Background\+Proc\+Symbol\mbox{[}$\,$\mbox{]},  }\item[{\mbox{\hyperlink{a00542_aeaf9b387f902c50a8360ff423f4a1f23}{AAX\+\_\+\+CSelector}} $\ast$}]{out\+Proc\+ID }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Registers an algorithm processing entrypoint (process procedure) for the native architecture.   


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+DLLFile\+Name\+UTF8} & UTF-\/8 encoded filename for the ELF DLL containing the algorithm code fragment \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Process\+Proc\+Symbol} & Symbol for this processing callback \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Properties} & A property map for this processing callback. The property map\textquotesingle{}s values are copied by the host and associated with the new Process\+Proc. The property map contents are unchanged and the map may be re-\/used when registering additional Process\+Procs. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Instance\+Init\+Proc\+Symbol} & Initialization routine that will be called when a new instance of the Effect is created. Must be included in the same DLL as the main algorithm entrypoint. See \mbox{\hyperlink{a00890_alg_initialization}{Algorithm initialization}}. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Background\+Proc\+Symbol} & Background routine that will be called in an idle context within the same address space as the associated process procedure. Must be included in the same DLL as the main algorithm entrypoint. See \mbox{\hyperlink{a00897}{Background processing callback}} \\
\hline
\mbox{\texttt{ out}}  & {\em out\+Proc\+ID} & \\
\hline
\end{DoxyParams}
\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000044}{Todo}}]document this parameter \end{DoxyRefDesc}
\mbox{\Hypertarget{a02014_a6b7aec8153fb7243d62284ea504c5681}\label{a02014_a6b7aec8153fb7243d62284ea504c5681}} 
\index{AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}!AddMeters@{AddMeters}}
\index{AddMeters@{AddMeters}!AAX\_IACFComponentDescriptor@{AAX\_IACFComponentDescriptor}}
\doxysubsubsection{\texorpdfstring{AddMeters()}{AddMeters()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFComponent\+Descriptor\+::\+Add\+Meters (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index,  }\item[{const \mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} $\ast$}]{in\+Meter\+IDs,  }\item[{const uint32\+\_\+t}]{in\+Meter\+Count }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Adds a meter field to the plug-\/in\textquotesingle{}s context.   

Meter fields include an array of meter tap values, with one tap per meter per context. Only one meter field should be added per Component. Individual meter behaviors can be described at the Effect level.

For more information, see \mbox{\hyperlink{a00902}{Plug-\/in meters}} .


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & Unique identifier for the field, generated using \mbox{\hyperlink{a00542_acf807247ecd6e5899dc9dc31644e9a1d}{AAX\+\_\+\+FIELD\+\_\+\+INDEX}} \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Meter\+IDs} & Array of 32-\/bit IDs, one for each meter. Meter IDs must be unique within the Effect. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Meter\+Count} & The number of meters included in this field   \\
\hline
\end{DoxyParams}


The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{a00632}{AAX\+\_\+\+IACFComponent\+Descriptor.\+h}}\end{DoxyCompactItemize}
