\hypertarget{a02029}{}\doxysection{AAX\+\_\+\+IACFEffect\+Descriptor Class Reference}
\label{a02029}\index{AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}}


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



Inheritance diagram for AAX\+\_\+\+IACFEffect\+Descriptor\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=234pt]{a02028}
\end{center}
\end{figure}


Collaboration diagram for AAX\+\_\+\+IACFEffect\+Descriptor\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=217pt]{a02027}
\end{center}
\end{figure}


\doxysubsection{Description}
Versioned interface for an \mbox{\hyperlink{a02233}{AAX\+\_\+\+IEffect\+Descriptor}}. \doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02029_a9e2eabbcaa46ada4b5f9bab2663f8a9f}{Add\+Component}} (\mbox{\hyperlink{a01757}{IACFUnknown}} $\ast$in\+Component\+Descriptor)=0
\begin{DoxyCompactList}\small\item\em Add a component to an instance of a component descriptor.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02029_a931fdad618c2e12c1e921dca5b3c6f56}{Add\+Name}} (const char $\ast$in\+Plug\+In\+Name)=0
\begin{DoxyCompactList}\small\item\em Add a name to the Effect.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02029_a415d749d8a464a56543733c5270a018c}{Add\+Category}} (uint32\+\_\+t in\+Category)=0
\begin{DoxyCompactList}\small\item\em Add a category to your plug-\/in. See \mbox{\hyperlink{a00443_aef9637518fb1ac0e2f403444c73aba4a}{AAX\+\_\+\+EPlug\+In\+Category}}.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02029_af2f7f299d6012675960263812e7b31aa}{Add\+Category\+Bypass\+Parameter}} (uint32\+\_\+t in\+Category, \mbox{\hyperlink{a00533_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} in\+Param\+ID)=0
\begin{DoxyCompactList}\small\item\em Add a category to your plug-\/in. See \mbox{\hyperlink{a00443_aef9637518fb1ac0e2f403444c73aba4a}{AAX\+\_\+\+EPlug\+In\+Category}}.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02029_a7f33575a0f17b9e869401658b193b978}{Add\+Proc\+Ptr}} (void $\ast$in\+Proc\+Ptr, \mbox{\hyperlink{a00767_af0682195d377392ad356fd2b00c36892}{AAX\+\_\+\+CProc\+Ptr\+ID}} in\+Proc\+ID)=0
\begin{DoxyCompactList}\small\item\em Add a process pointer.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02029_a840a5ddf4d0e94d257709aa67cd29b23}{Set\+Properties}} (\mbox{\hyperlink{a01757}{IACFUnknown}} $\ast$in\+Properties)=0
\begin{DoxyCompactList}\small\item\em Set the properties of a new property map.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02029_a567d1b726a83de8553275300d9cbb763}{Add\+Resource\+Info}} (\mbox{\hyperlink{a00443_ae2805e88175d975589153a04e42898bb}{AAX\+\_\+\+EResource\+Type}} in\+Resource\+Type, const char $\ast$in\+Info)=0
\begin{DoxyCompactList}\small\item\em Set resource file info.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02029_afa79bd68910778239c241fd1d81fef09}{Add\+Meter\+Description}} (\mbox{\hyperlink{a00533_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} in\+Meter\+ID, const char $\ast$in\+Meter\+Name, \mbox{\hyperlink{a01757}{IACFUnknown}} $\ast$in\+Properties)=0
\begin{DoxyCompactList}\small\item\em Add name and property map to meter with given ID.   \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions inherited from \mbox{\hyperlink{a01757}{IACFUnknown}}}
\begin{DoxyCompactItemize}
\item 
virtual BEGIN\+\_\+\+ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE \mbox{\hyperlink{a01757_a8b7f0ae9c78d007ca76aa462ebe53135}{Query\+Interface}} (const \mbox{\hyperlink{a00305_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{a01757_aa9c7a5b9dff341092b7b86bb9b3a58fb}{Add\+Ref}} (void)=0
\begin{DoxyCompactList}\small\item\em Increments reference count. \end{DoxyCompactList}\item 
virtual acf\+UInt32 ACFMETHODCALLTYPE \mbox{\hyperlink{a01757_afabd38cec0a9ed37f1d3e8644a70ac41}{Release}} (void)=0
\begin{DoxyCompactList}\small\item\em Decrements reference count. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{a02029_a9e2eabbcaa46ada4b5f9bab2663f8a9f}\label{a02029_a9e2eabbcaa46ada4b5f9bab2663f8a9f}} 
\index{AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}!AddComponent@{AddComponent}}
\index{AddComponent@{AddComponent}!AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}}
\doxysubsubsection{\texorpdfstring{AddComponent()}{AddComponent()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Descriptor\+::\+Add\+Component (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a01757}{IACFUnknown}} $\ast$}]{in\+Component\+Descriptor }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Add a component to an instance of a component descriptor.   

Unlike with \mbox{\hyperlink{a02189_a5ff114b8c4da2081515186f2faf65c8c}{AAX\+\_\+\+ICollection\+::\+Add\+Effect()}}, the \mbox{\hyperlink{a02233}{AAX\+\_\+\+IEffect\+Descriptor}} does not take ownership of the \mbox{\hyperlink{a02193}{AAX\+\_\+\+IComponent\+Descriptor}} that is passed to it in this method. The host copies out the contents of this descriptor, and thus the plug-\/in may re-\/use the same descriptor object when creating additional similar components.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Component\+Descriptor} & \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02029_a931fdad618c2e12c1e921dca5b3c6f56}\label{a02029_a931fdad618c2e12c1e921dca5b3c6f56}} 
\index{AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}!AddName@{AddName}}
\index{AddName@{AddName}!AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}}
\doxysubsubsection{\texorpdfstring{AddName()}{AddName()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Descriptor\+::\+Add\+Name (\begin{DoxyParamCaption}\item[{const char $\ast$}]{in\+Plug\+In\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Add a name to the Effect.   

May be called multiple times to add abbreviated Effect names.

\begin{DoxyNote}{Note}
Every Effect must include at least one name variant with 31 or fewer characters, plus a null terminating character
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Plug\+In\+Name} & The name assigned to the plug-\/in.   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02029_a415d749d8a464a56543733c5270a018c}\label{a02029_a415d749d8a464a56543733c5270a018c}} 
\index{AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}!AddCategory@{AddCategory}}
\index{AddCategory@{AddCategory}!AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}}
\doxysubsubsection{\texorpdfstring{AddCategory()}{AddCategory()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Descriptor\+::\+Add\+Category (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{in\+Category }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Add a category to your plug-\/in. See \mbox{\hyperlink{a00443_aef9637518fb1ac0e2f403444c73aba4a}{AAX\+\_\+\+EPlug\+In\+Category}}.   


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Category} & One of the categories for the plug-\/in.   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02029_af2f7f299d6012675960263812e7b31aa}\label{a02029_af2f7f299d6012675960263812e7b31aa}} 
\index{AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}!AddCategoryBypassParameter@{AddCategoryBypassParameter}}
\index{AddCategoryBypassParameter@{AddCategoryBypassParameter}!AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}}
\doxysubsubsection{\texorpdfstring{AddCategoryBypassParameter()}{AddCategoryBypassParameter()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Descriptor\+::\+Add\+Category\+Bypass\+Parameter (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{in\+Category,  }\item[{\mbox{\hyperlink{a00533_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{in\+Param\+ID }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Add a category to your plug-\/in. See \mbox{\hyperlink{a00443_aef9637518fb1ac0e2f403444c73aba4a}{AAX\+\_\+\+EPlug\+In\+Category}}.   


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Category} & One of the categories for the plug-\/in. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Param\+ID} & The parameter ID of the parameter used to bypass the category seciont of the plug-\/in.   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02029_a7f33575a0f17b9e869401658b193b978}\label{a02029_a7f33575a0f17b9e869401658b193b978}} 
\index{AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}!AddProcPtr@{AddProcPtr}}
\index{AddProcPtr@{AddProcPtr}!AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}}
\doxysubsubsection{\texorpdfstring{AddProcPtr()}{AddProcPtr()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Descriptor\+::\+Add\+Proc\+Ptr (\begin{DoxyParamCaption}\item[{void $\ast$}]{in\+Proc\+Ptr,  }\item[{\mbox{\hyperlink{a00767_af0682195d377392ad356fd2b00c36892}{AAX\+\_\+\+CProc\+Ptr\+ID}}}]{in\+Proc\+ID }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Add a process pointer.   


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Proc\+Ptr} & A process pointer. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Proc\+ID} & A process ID.   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02029_a840a5ddf4d0e94d257709aa67cd29b23}\label{a02029_a840a5ddf4d0e94d257709aa67cd29b23}} 
\index{AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}!SetProperties@{SetProperties}}
\index{SetProperties@{SetProperties}!AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}}
\doxysubsubsection{\texorpdfstring{SetProperties()}{SetProperties()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Descriptor\+::\+Set\+Properties (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a01757}{IACFUnknown}} $\ast$}]{in\+Properties }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Set the properties of a new property map.   


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Properties} & Description   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02029_a567d1b726a83de8553275300d9cbb763}\label{a02029_a567d1b726a83de8553275300d9cbb763}} 
\index{AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}!AddResourceInfo@{AddResourceInfo}}
\index{AddResourceInfo@{AddResourceInfo}!AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}}
\doxysubsubsection{\texorpdfstring{AddResourceInfo()}{AddResourceInfo()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Descriptor\+::\+Add\+Resource\+Info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00443_ae2805e88175d975589153a04e42898bb}{AAX\+\_\+\+EResource\+Type}}}]{in\+Resource\+Type,  }\item[{const char $\ast$}]{in\+Info }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Set resource file info.   


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Resource\+Type} & See AAX\+\_\+\+EResource\+Type. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Info} & Definition varies on the resource type.   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02029_afa79bd68910778239c241fd1d81fef09}\label{a02029_afa79bd68910778239c241fd1d81fef09}} 
\index{AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}!AddMeterDescription@{AddMeterDescription}}
\index{AddMeterDescription@{AddMeterDescription}!AAX\_IACFEffectDescriptor@{AAX\_IACFEffectDescriptor}}
\doxysubsubsection{\texorpdfstring{AddMeterDescription()}{AddMeterDescription()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Descriptor\+::\+Add\+Meter\+Description (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00533_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{in\+Meter\+ID,  }\item[{const char $\ast$}]{in\+Meter\+Name,  }\item[{\mbox{\hyperlink{a01757}{IACFUnknown}} $\ast$}]{in\+Properties }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Add name and property map to meter with given ID.   


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Meter\+ID} & The ID of the meter being described. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Meter\+Name} & The name of the meter. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Properties} & The property map containing meter related data such as meter type, orientation, etc.   \\
\hline
\end{DoxyParams}


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