\hypertarget{a02066}{}\doxysection{AAX\+\_\+\+IACFEffect\+Parameters Class Reference}
\label{a02066}\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}


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



Inheritance diagram for AAX\+\_\+\+IACFEffect\+Parameters\+:
% FIG 0


Collaboration diagram for AAX\+\_\+\+IACFEffect\+Parameters\+:
% FIG 1


\doxysubsection{Description}
The interface for an AAX Plug-\/in\textquotesingle{}s data model. 

This is the interface for an instance of a plug-\/in\textquotesingle{}s data model that gets exposed to the host application. The AAX host interacts with your plug-\/in\textquotesingle{}s data model via this interface, which includes methods that store and update of your plug-\/in\textquotesingle{}s internal data. See \mbox{\hyperlink{a00891}{Data model interface}}.

\begin{DoxyNote}{Note}
Your implementation of this interface must inherit from \mbox{\hyperlink{a02266}{AAX\+\_\+\+IEffect\+Parameters}}.
\end{DoxyNote}
\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000031}{Todo}}]Add documentation for expected error state return values\end{DoxyRefDesc}
\doxysubsection*{Public Member Functions}
\begin{Indent}\textbf{ Initialization and uninitialization}\par
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_ad4db3c0ab67f8f41cdd042a915daabb4}{Initialize}} (\mbox{\hyperlink{a01770}{IACFUnknown}} $\ast$i\+Controller)=0
\begin{DoxyCompactList}\small\item\em Main data model initialization. Called when plug-\/in instance is first instantiated. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a711969adc95624fb9ac8a3e3b2c23696}{Uninitialize}} ()=0
\begin{DoxyCompactList}\small\item\em Main data model uninitialization. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ AAX host and plug-\/in event notification}\par
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_aa3eaeb292d2ca84086a5a058171994fd}{Notification\+Received}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} in\+Notification\+Type, const void $\ast$in\+Notification\+Data, uint32\+\_\+t in\+Notification\+Data\+Size)=0
\begin{DoxyCompactList}\small\item\em Notification Hook. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Parameter information}\par
{\em These methods are used by the AAX host to retrieve information about the plug-\/in\textquotesingle{}s data model.

~\newline
 ~\newline
 For information about adding parameters to the plug-\/in and otherwise modifying the plug-\/in\textquotesingle{}s data model, see \mbox{\hyperlink{a01914}{AAX\+\_\+\+CParameter\+Manager}}. For information about parameters, see \mbox{\hyperlink{a02302}{AAX\+\_\+\+IParameter}}. }\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a8af398b1e308849464aee5a6713a3965}{Get\+Number\+Of\+Parameters}} (int32\+\_\+t $\ast$o\+Num\+Controls) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the total number of plug-\/in parameters. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_ab967122337b61064492024f8bf695ed4}{Get\+Master\+Bypass\+Parameter}} (\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$o\+IDString) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the ID of the plug-\/in\textquotesingle{}s Master Bypass parameter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a4e6eeef25a797ea4c6961df45174b169}{Get\+Parameter\+Is\+Automatable}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, \mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}} $\ast$o\+Automatable) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves information about a parameter\textquotesingle{}s automatable status. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a2a8d8d200383204db9bb780a4cc8ef6f}{Get\+Parameter\+Number\+Of\+Steps}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, int32\+\_\+t $\ast$o\+Num\+Steps) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the number of discrete steps for a parameter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a8f8ae4b4346e708ec6de612ef99e5a92}{Get\+Parameter\+Name}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$o\+Name) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the full name for a parameter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a5d556ae1fa4617a6439ef347139d70eb}{Get\+Parameter\+Name\+Of\+Length}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$o\+Name, int32\+\_\+t i\+Name\+Length) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves an abbreviated name for a parameter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a858f07ba021f8c9912bf91735b10314b}{Get\+Parameter\+Default\+Normalized\+Value}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, double $\ast$o\+Value) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves default value of a parameter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a333b83bc6f37b0103ce0de65be02fede}{Set\+Parameter\+Default\+Normalized\+Value}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, double i\+Value)=0
\begin{DoxyCompactList}\small\item\em CALL\+: Sets the default value of a parameter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_ae7f6d803fa9a472a4bad583868e3b951}{Get\+Parameter\+Type}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, \mbox{\hyperlink{a00446_a4cd0f189daa9a60cf36883c56344bb2e}{AAX\+\_\+\+EParameter\+Type}} $\ast$o\+Parameter\+Type) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the type of a parameter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_ac122e1a693296b059dca4350a5ff1dfe}{Get\+Parameter\+Orientation}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, \mbox{\hyperlink{a00446_a52f91d1c14aa5dceedabfb9d2de31bf0}{AAX\+\_\+\+EParameter\+Orientation}} $\ast$o\+Parameter\+Orientation) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the orientation that should be applied to a parameter\textquotesingle{}s controls. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a169b7e9fe64f2d86d20fffc152b5e365}{Get\+Parameter}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, \mbox{\hyperlink{a02302}{AAX\+\_\+\+IParameter}} $\ast$$\ast$o\+Parameter)=0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves an arbitrary setting within a parameter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_aff1ff6b27973200429f057dc003f30a8}{Get\+Parameter\+Index}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, int32\+\_\+t $\ast$o\+Control\+Index) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the index of a parameter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a5387b83e0f684a5bf0e09b24cae257d9}{Get\+Parameter\+IDFrom\+Index}} (int32\+\_\+t i\+Control\+Index, \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$o\+Parameter\+IDString) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the ID of a parameter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a1702de6d62b5b41b6a8b2f510300392b}{Get\+Parameter\+Value\+Info}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, int32\+\_\+t i\+Selector, int32\+\_\+t $\ast$o\+Value) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves a property of a parameter. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Parameter setters and getters}\par
{\em These methods are used by the AAX host and by the plug-\/in\textquotesingle{}s UI to retrieve and modify the values of the plug-\/in\textquotesingle{}s parameters.

\begin{DoxyNote}{Note}
The parameter setters in this section may generate asynchronous requests. 
\end{DoxyNote}
}\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a54bb12c9798e4f9a3a5b5d6f30ace992}{Get\+Parameter\+Value\+From\+String}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, double $\ast$o\+Value, const \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&i\+Value\+String) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Converts a value string to a value. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_add995f2eb5a3967c48dd9f3e21f003aa}{Get\+Parameter\+String\+From\+Value}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, double i\+Value, \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$o\+Value\+String, int32\+\_\+t i\+Max\+Length) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Converts a normalized parameter value into a string representing its corresponding real value. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_aacb54e6522561fe91fe12d0d99734abf}{Get\+Parameter\+Value\+String}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$o\+Value\+String, int32\+\_\+t i\+Max\+Length) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the value string associated with a parameter\textquotesingle{}s current value. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a18e3407bac178a9b0339bd6f95e74a17}{Get\+Parameter\+Normalized\+Value}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, double $\ast$o\+Value\+Ptr) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves a parameter\textquotesingle{}s current value. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a368b0f5a761d1eda4c41b420f153a077}{Set\+Parameter\+Normalized\+Value}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, double i\+Value)=0
\begin{DoxyCompactList}\small\item\em CALL\+: Sets the specified parameter to a new value. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a6e28a427a0d7d0c8df69dd5eb88cff6c}{Set\+Parameter\+Normalized\+Relative}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, double i\+Value)=0
\begin{DoxyCompactList}\small\item\em CALL\+: Sets the specified parameter to a new value relative to its current value. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Automated parameter helpers}\par
{\em These methods are used to lock and unlock automation system \textquotesingle{}resources\textquotesingle{} when updating automatable parameters.

\begin{DoxyNote}{Note}
You should never need to override these methods to extend their behavior beyond what is provided in \mbox{\hyperlink{a01850}{AAX\+\_\+\+CEffect\+Parameters}} and \mbox{\hyperlink{a02302}{AAX\+\_\+\+IParameter}} 
\end{DoxyNote}
}\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_ae82e80cbfd9cb837f8101a85f06856ba}{Touch\+Parameter}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID)=0
\begin{DoxyCompactList}\small\item\em \char`\"{}\+Touches\char`\"{} (locks) a parameter in the automation system to a particular control in preparation for updates \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a2caf1b7b8e2dad62cf96f144479dee60}{Release\+Parameter}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID)=0
\begin{DoxyCompactList}\small\item\em Releases a parameter from a \char`\"{}touched\char`\"{} state. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a93483f44315bdf3adf60bf5bf773fbb8}{Update\+Parameter\+Touch}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, \mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}} i\+Touch\+State)=0
\begin{DoxyCompactList}\small\item\em Sets a \char`\"{}touched\char`\"{} state on a parameter. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Asynchronous parameter update methods}\par
{\em These methods are called by the AAX host when parameter values have been updated. They are called by the host and can be triggered by other plug-\/in modules via calls to \mbox{\hyperlink{a02302}{AAX\+\_\+\+IParameter}}\textquotesingle{}s {\ttfamily Set\+Value} methods, e.\+g. \mbox{\hyperlink{a02302_a1d37b80bc3a9c4e53fc2c1684f47dfb7}{Set\+Value\+With\+Float()}}

These methods are responsible for updating parameter values.

Do not call these methods directly! To ensure proper synchronization and to avoid problematic dependency chains, other methods (e.\+g. \mbox{\hyperlink{a02066_a368b0f5a761d1eda4c41b420f153a077}{Set\+Parameter\+Normalized\+Value()}}) and components (e.\+g. \mbox{\hyperlink{a02262}{AAX\+\_\+\+IEffect\+GUI}}) should always call a {\ttfamily Set\+Value} method on \mbox{\hyperlink{a02302}{AAX\+\_\+\+IParameter}} to update parameter values. The {\ttfamily Set\+Value} method will properly manage automation locks and other system resources. }\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a685858711efb8634ce66c327f2865c71}{Update\+Parameter\+Normalized\+Value}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, double i\+Value, \mbox{\hyperlink{a00446_a30be0398faf20c6b121239eb9399f3f7}{AAX\+\_\+\+EUpdate\+Source}} i\+Source)=0
\begin{DoxyCompactList}\small\item\em Updates a single parameter\textquotesingle{}s state to its current value. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a54403bec090fcc999a93f54c01bca0c9}{Update\+Parameter\+Normalized\+Relative}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+ID, double i\+Value)=0
\begin{DoxyCompactList}\small\item\em Updates a single parameter\textquotesingle{}s state to its current value, as a difference with the parameter\textquotesingle{}s previous value. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a083265b008921b6114ede387711694b7}{Generate\+Coefficients}} ()=0
\begin{DoxyCompactList}\small\item\em Generates and dispatches new coefficient packets. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ State reset handlers}\par
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a6e87e40d42c7431e52ae5ebd4f631964}{Reset\+Field\+Data}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index, void $\ast$o\+Data, uint32\+\_\+t in\+Data\+Size) const =0
\begin{DoxyCompactList}\small\item\em Called by the host to reset a private data field in the plug-\/in\textquotesingle{}s algorithm. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Chunk methods}\par
{\em These methods are used to save and restore collections of plug-\/in state information, known as chunks. Chunks are used by the host when saving or restoring presets and session settings and when providing \char`\"{}compare\char`\"{} functionality for plug-\/ins.

The default implementation of these methods in \mbox{\hyperlink{a01850}{AAX\+\_\+\+CEffect\+Parameters}} supports a single chunk that includes state information for all of the plug-\/in\textquotesingle{}s registered parameters. Override all of these methods to add support for additional chunks in your plug-\/in, for example if your plug-\/in contains any persistent state that is not encapsulated by its set of registered parameters.

\begin{DoxyWarning}{Warning}
Remember that plug-\/in chunk data may be loaded on a different platform from the one where it is saved. All data structures in the chunk must be properly data-\/aligned for compatibility across all platforms that the plug-\/in supports. See \mbox{\hyperlink{a00542_a8fbeac3c5db5ac694e85a021ed74dc9e}{AAX\+\_\+\+ALIGN\+\_\+\+FILE\+\_\+\+ALG}} for notes about common cross-\/platform pitfalls for data structure alignment.
\end{DoxyWarning}
For reference, see also\+: \begin{DoxyItemize}
\item \mbox{\hyperlink{a01830}{AAX\+\_\+\+CChunk\+Data\+Parser}} \item \mbox{\hyperlink{a01782}{AAX\+\_\+\+SPlug\+In\+Chunk}} \end{DoxyItemize}
}\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a37e546c6dbb4d5a16fedb9f465de2599}{Get\+Number\+Of\+Chunks}} (int32\+\_\+t $\ast$o\+Num\+Chunks) const =0
\begin{DoxyCompactList}\small\item\em Retrieves the number of chunks used by this plug-\/in. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a10409113cb781002551b878e4c0edd5a}{Get\+Chunk\+IDFrom\+Index}} (int32\+\_\+t i\+Index, \mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} $\ast$o\+Chunk\+ID) const =0
\begin{DoxyCompactList}\small\item\em Retrieves the ID associated with a chunk index. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_aa986711cd372febcaae803e86ae08f63}{Get\+Chunk\+Size}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} i\+Chunk\+ID, uint32\+\_\+t $\ast$o\+Size) const =0
\begin{DoxyCompactList}\small\item\em Get the size of the data structure that can hold all of a chunk\textquotesingle{}s information. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_ab977041a440a9cd6f3e631c059ee8b99}{Get\+Chunk}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} i\+Chunk\+ID, \mbox{\hyperlink{a01782}{AAX\+\_\+\+SPlug\+In\+Chunk}} $\ast$o\+Chunk) const =0
\begin{DoxyCompactList}\small\item\em Fills a block of data with chunk information representing the plug-\/in\textquotesingle{}s current state. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a2d780ebc594683e24302871b809602e8}{Set\+Chunk}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} i\+Chunk\+ID, const \mbox{\hyperlink{a01782}{AAX\+\_\+\+SPlug\+In\+Chunk}} $\ast$i\+Chunk)=0
\begin{DoxyCompactList}\small\item\em Restores a set of plug-\/in parameters based on chunk information. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a1e86f849e970c9998313fc7d451ccf85}{Compare\+Active\+Chunk}} (const \mbox{\hyperlink{a01782}{AAX\+\_\+\+SPlug\+In\+Chunk}} $\ast$i\+ChunkP, \mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}} $\ast$o\+Is\+Equal) const =0
\begin{DoxyCompactList}\small\item\em Determine if a chunk represents settings that are equivalent to the plug-\/in\textquotesingle{}s current state. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a17b96da201d9a242d3662e87525a7227}{Get\+Number\+Of\+Changes}} (int32\+\_\+t $\ast$o\+Num\+Changes) const =0
\begin{DoxyCompactList}\small\item\em Retrieves the number of parameter changes made since the plug-\/in\textquotesingle{}s creation. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Thread methods}\par
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_ab5b8da9e1a9d778d327ac04f4ab8d139}{Timer\+Wakeup}} ()=0
\begin{DoxyCompactList}\small\item\em Periodic wakeup callback for idle-\/time operations. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Auxiliary UI methods}\par
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a00900_gaa85bda4027342eb644a9c92a17da6d49}{Get\+Curve\+Data}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} i\+Curve\+Type, const float $\ast$i\+Values, uint32\+\_\+t i\+Num\+Values, float $\ast$o\+Values) const =0
\begin{DoxyCompactList}\small\item\em Generate a set of output values based on a set of given input values. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Custom data methods}\par
{\em These functions exist as a proxiable way to move data between different modules (e.\+g. \mbox{\hyperlink{a02266}{AAX\+\_\+\+IEffect\+Parameters}} and \mbox{\hyperlink{a02262}{AAX\+\_\+\+IEffect\+GUI}}.) Using these, the GUI can query any data through \mbox{\hyperlink{a02066_a4728fcad006d921a07489144360f447e}{Get\+Custom\+Data()}} with a plug-\/in defined {\ttfamily type\+ID}, {\ttfamily void$\ast$} and size. This has an advantage over just sharing memory in that this function can work as a remote proxy as we enable those sorts of features later in the platform. Likewise, the GUI can also set arbitrary data on the data model by using the \mbox{\hyperlink{a02066_aa838cad04781853ef2e0b9df22a05170}{Set\+Custom\+Data()}} function with the same idea.

\begin{DoxyNote}{Note}
These are plug-\/in internal only. They are not called from the host right now, or likely ever. 
\end{DoxyNote}
}\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_a4728fcad006d921a07489144360f447e}{Get\+Custom\+Data}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} i\+Data\+Block\+ID, uint32\+\_\+t in\+Data\+Size, void $\ast$o\+Data, uint32\+\_\+t $\ast$o\+Data\+Written) const =0
\begin{DoxyCompactList}\small\item\em An optional interface hook for getting custom data from another module. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_aa838cad04781853ef2e0b9df22a05170}{Set\+Custom\+Data}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} i\+Data\+Block\+ID, uint32\+\_\+t in\+Data\+Size, const void $\ast$i\+Data)=0
\begin{DoxyCompactList}\small\item\em An optional interface hook for setting custom data for use by another module. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ MIDI methods}\par
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02066_af376aef3d3ecdc6287f820b4e01f5c9b}{Do\+MIDITransfers}} ()=0
\begin{DoxyCompactList}\small\item\em MIDI update callback. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\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{a02066_ad4db3c0ab67f8f41cdd042a915daabb4}\label{a02066_ad4db3c0ab67f8f41cdd042a915daabb4}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!Initialize@{Initialize}}
\index{Initialize@{Initialize}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{Initialize()}{Initialize()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Initialize (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a01770}{IACFUnknown}} $\ast$}]{i\+Controller }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Main data model initialization. Called when plug-\/in instance is first instantiated. 

\begin{DoxyNote}{Note}
Most plug-\/ins should override \mbox{\hyperlink{a01850_a2e302fd758d39a6a855023bf825fe148}{AAX\+\_\+\+CEffect\+Parameters\+::\+Effect\+Init()}} rather than directly overriding this method
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Controller} & A versioned reference that resolves to an \mbox{\hyperlink{a02222}{AAX\+\_\+\+IController}} interface \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a245f235300b04f1c8b4c83831d296e22}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a711969adc95624fb9ac8a3e3b2c23696}\label{a02066_a711969adc95624fb9ac8a3e3b2c23696}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!Uninitialize@{Uninitialize}}
\index{Uninitialize@{Uninitialize}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{Uninitialize()}{Uninitialize()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Uninitialize (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Main data model uninitialization. 

\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000035}{Todo}}]Docs\+: When exactly is \mbox{\hyperlink{a02066_a711969adc95624fb9ac8a3e3b2c23696}{AAX\+\_\+\+IACFEffect\+Parameters\+::\+Uninitialize()}} called, and under what conditions?\end{DoxyRefDesc}


Implemented in \mbox{\hyperlink{a01850_acd14ff2175a10759045674e8e14508b1}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_aa3eaeb292d2ca84086a5a058171994fd}\label{a02066_aa3eaeb292d2ca84086a5a058171994fd}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!NotificationReceived@{NotificationReceived}}
\index{NotificationReceived@{NotificationReceived}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{NotificationReceived()}{NotificationReceived()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Notification\+Received (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{in\+Notification\+Type,  }\item[{const void $\ast$}]{in\+Notification\+Data,  }\item[{uint32\+\_\+t}]{in\+Notification\+Data\+Size }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Notification Hook. 

Called from the host to deliver notifications to this object.

Look at the \mbox{\hyperlink{a00446_afab5ea2cfd731fc8f163b6caa685406e}{AAX\+\_\+\+ENotification\+Event}} enumeration to see a description of events you can listen for and the data they come with.


\begin{DoxyItemize}
\item \begin{DoxyNote}{Note}
some notifications are sent only to the plug-\/in GUI while other notifications are sent only to the plug-\/in data model. If you are not seeing an expected notification, try checking the other plug-\/in objects\textquotesingle{} {\ttfamily \mbox{\hyperlink{a02066_aa3eaeb292d2ca84086a5a058171994fd}{Notification\+Received()}}} methods.
\end{DoxyNote}

\item \begin{DoxyNote}{Note}
the host may dispatch notifications synchronously or asynchronously, and calls to this method may occur concurrently on multiple threads.
\end{DoxyNote}
A plug-\/in may also dispatch custom notifications using \mbox{\hyperlink{a02222_a0384f820cecf8cf7671057060bf5ba4f}{AAX\+\_\+\+IController\+::\+Send\+Notification()}}. Custom notifications will be posted back to the plug-\/in\textquotesingle{}s other objects which support a {\ttfamily \mbox{\hyperlink{a02066_aa3eaeb292d2ca84086a5a058171994fd}{Notification\+Received()}}} method (e.\+g. the GUI).
\end{DoxyItemize}


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Notification\+Type} & Type of notification being received. Notifications form the host are one of \mbox{\hyperlink{a00446_afab5ea2cfd731fc8f163b6caa685406e}{AAX\+\_\+\+ENotification\+Event}} \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Notification\+Data} & Block of incoming notification data \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Notification\+Data\+Size} & Size of {\ttfamily in\+Notification\+Data}, in bytes \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_af18b23ec6d4e60e60e27c209c17e573a}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a8af398b1e308849464aee5a6713a3965}\label{a02066_a8af398b1e308849464aee5a6713a3965}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetNumberOfParameters@{GetNumberOfParameters}}
\index{GetNumberOfParameters@{GetNumberOfParameters}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetNumberOfParameters()}{GetNumberOfParameters()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Number\+Of\+Parameters (\begin{DoxyParamCaption}\item[{int32\+\_\+t $\ast$}]{o\+Num\+Controls }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the total number of plug-\/in parameters. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em o\+Num\+Controls} & The number of parameters in the plug-\/in\textquotesingle{}s Parameter Manager \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_ab22ac55f74401eddbe3f270435a74f70}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_ab967122337b61064492024f8bf695ed4}\label{a02066_ab967122337b61064492024f8bf695ed4}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetMasterBypassParameter@{GetMasterBypassParameter}}
\index{GetMasterBypassParameter@{GetMasterBypassParameter}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetMasterBypassParameter()}{GetMasterBypassParameter()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Master\+Bypass\+Parameter (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$}]{o\+IDString }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the ID of the plug-\/in\textquotesingle{}s Master Bypass parameter. 

This is required if you want our master bypass functionality in the host to hook up to your bypass parameters.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em o\+IDString} & The ID of the plug-\/in\textquotesingle{}s Master Bypass control \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_afe1313da2e24225af2f224623dca6b95}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a4e6eeef25a797ea4c6961df45174b169}\label{a02066_a4e6eeef25a797ea4c6961df45174b169}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterIsAutomatable@{GetParameterIsAutomatable}}
\index{GetParameterIsAutomatable@{GetParameterIsAutomatable}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterIsAutomatable()}{GetParameterIsAutomatable()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Is\+Automatable (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{\mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}} $\ast$}]{o\+Automatable }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves information about a parameter\textquotesingle{}s automatable status. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Automatable} & True if the queried parameter is automatable, false if it is not \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a8a0890eacee81afbea6a5548592e1c8f}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a2a8d8d200383204db9bb780a4cc8ef6f}\label{a02066_a2a8d8d200383204db9bb780a4cc8ef6f}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterNumberOfSteps@{GetParameterNumberOfSteps}}
\index{GetParameterNumberOfSteps@{GetParameterNumberOfSteps}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterNumberOfSteps()}{GetParameterNumberOfSteps()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Number\+Of\+Steps (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{int32\+\_\+t $\ast$}]{o\+Num\+Steps }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the number of discrete steps for a parameter. 

\begin{DoxyNote}{Note}
The value returned for {\ttfamily o\+Num\+Steps} MUST be greater than zero. All other values will be considered an error by the host.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Num\+Steps} & The number of steps for this parameter \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a3a142f7b8bd3e09b522445c0b315c759}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a8f8ae4b4346e708ec6de612ef99e5a92}\label{a02066_a8f8ae4b4346e708ec6de612ef99e5a92}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterName@{GetParameterName}}
\index{GetParameterName@{GetParameterName}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterName()}{GetParameterName()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Name (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$}]{o\+Name }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the full name for a parameter. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Name} & Reference to an \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} owned by the host. The plug-\/in must set this string equal to the parameter\textquotesingle{}s full name. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_af618b324cdd013ffa322f798af30ca40}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a5d556ae1fa4617a6439ef347139d70eb}\label{a02066_a5d556ae1fa4617a6439ef347139d70eb}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterNameOfLength@{GetParameterNameOfLength}}
\index{GetParameterNameOfLength@{GetParameterNameOfLength}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterNameOfLength()}{GetParameterNameOfLength()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Name\+Of\+Length (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$}]{o\+Name,  }\item[{int32\+\_\+t}]{i\+Name\+Length }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves an abbreviated name for a parameter. 

In general, lengths of 3 through 8 and 31 should be specifically addressed.

\begin{DoxyRefDesc}{Host Compatibility Notes}
\item[\mbox{\hyperlink{a00879__compatibility_notes000048}{Host Compatibility Notes}}]In most cases, the AAX host will call \mbox{\hyperlink{a02066_a8f8ae4b4346e708ec6de612ef99e5a92}{Get\+Parameter\+Name()}} or \mbox{\hyperlink{a02066_a5d556ae1fa4617a6439ef347139d70eb}{Get\+Parameter\+Name\+Of\+Length()}} to retrieve parameter names for display. However, when Pro Tools is retrieving a plug-\/in name for display on a control surface the XML data stored in the plug-\/in\textquotesingle{}s page tables will be used in preference to values retrieved from these methods.\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Name} & Reference to an \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} owned by the host. The plug-\/in must set this string equal to an abbreviated name for the parameter, using {\ttfamily i\+Name\+Length} characters or fewer. \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Name\+Length} & The maximum number of characters in {\ttfamily o\+Name} \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_af0bc3d6fb8f387f58a073f8902233bd3}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a858f07ba021f8c9912bf91735b10314b}\label{a02066_a858f07ba021f8c9912bf91735b10314b}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterDefaultNormalizedValue@{GetParameterDefaultNormalizedValue}}
\index{GetParameterDefaultNormalizedValue@{GetParameterDefaultNormalizedValue}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterDefaultNormalizedValue()}{GetParameterDefaultNormalizedValue()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Default\+Normalized\+Value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{double $\ast$}]{o\+Value }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves default value of a parameter. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Value} & The parameter\textquotesingle{}s default value \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_ae92a568c56bfff70eb4622c48db85bc0}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a333b83bc6f37b0103ce0de65be02fede}\label{a02066_a333b83bc6f37b0103ce0de65be02fede}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!SetParameterDefaultNormalizedValue@{SetParameterDefaultNormalizedValue}}
\index{SetParameterDefaultNormalizedValue@{SetParameterDefaultNormalizedValue}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{SetParameterDefaultNormalizedValue()}{SetParameterDefaultNormalizedValue()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Set\+Parameter\+Default\+Normalized\+Value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{double}]{i\+Value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Sets the default value of a parameter. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being updated \\
\hline
\mbox{\texttt{ out}}  & {\em i\+Value} & The parameter\textquotesingle{}s new default value\\
\hline
\end{DoxyParams}
\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000036}{Todo}}]THIS IS NOT CALLED FROM HOST. USEFUL FOR INTERNAL USE ONLY?\end{DoxyRefDesc}


Implemented in \mbox{\hyperlink{a01850_aafbafbc1b07c3f41c40b2ff9820557c8}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_ae7f6d803fa9a472a4bad583868e3b951}\label{a02066_ae7f6d803fa9a472a4bad583868e3b951}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterType@{GetParameterType}}
\index{GetParameterType@{GetParameterType}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterType()}{GetParameterType()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Type (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{\mbox{\hyperlink{a00446_a4cd0f189daa9a60cf36883c56344bb2e}{AAX\+\_\+\+EParameter\+Type}} $\ast$}]{o\+Parameter\+Type }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the type of a parameter. 

\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000037}{Todo}}]The concept of parameter type needs more documentation\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Parameter\+Type} & The parameter\textquotesingle{}s type \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a95c40a67ef6cd5e830e46826d1ccf5c4}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_ac122e1a693296b059dca4350a5ff1dfe}\label{a02066_ac122e1a693296b059dca4350a5ff1dfe}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterOrientation@{GetParameterOrientation}}
\index{GetParameterOrientation@{GetParameterOrientation}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterOrientation()}{GetParameterOrientation()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Orientation (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{\mbox{\hyperlink{a00446_a52f91d1c14aa5dceedabfb9d2de31bf0}{AAX\+\_\+\+EParameter\+Orientation}} $\ast$}]{o\+Parameter\+Orientation }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the orientation that should be applied to a parameter\textquotesingle{}s controls. 

\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000038}{Todo}}]update this documentation\end{DoxyRefDesc}


This method allows you to specify the orientation of knob controls that are managed by the host (e.\+g. knobs on an attached control surface.)

Here is an example override of this method that reverses the orientation of a control for a parameter\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{\textcolor{comment}{//\ AAX\_IParameter*\ myBackwardsParameter}}
\DoxyCodeLine{\textcolor{keywordflow}{if}\ (iParameterID\ ==\ myBackwardsParameter-\/>Identifier())}
\DoxyCodeLine{\{}
\DoxyCodeLine{\ \ \ \ \ *oParameterType\ =}
\DoxyCodeLine{\ \ \ \ \ \ \ \mbox{\hyperlink{a00446_aa5ffa1ed828630b6b7a13c049d93ae87a0df7361517b3c7939f67647e873cb4d9}{AAX\_eParameterOrientation\_BottomMinTopMax}}\ |}
\DoxyCodeLine{\ \ \ \ \ \ \ \mbox{\hyperlink{a00446_aa5ffa1ed828630b6b7a13c049d93ae87a4e074c855fdeb439e2623d920173e752}{AAX\_eParameterOrientation\_LeftMinRightMax}}\ |}
\DoxyCodeLine{\ \ \ \ \ \ \ \mbox{\hyperlink{a00446_aa5ffa1ed828630b6b7a13c049d93ae87ab42ad685ac842d36bc7d1717c537c10a}{AAX\_eParameterOrientation\_RotaryWrapMode}}\ |}
\DoxyCodeLine{\ \ \ \ \ \ \ \mbox{\hyperlink{a00446_aa5ffa1ed828630b6b7a13c049d93ae87a9f441bb5192bd7b7162ba588c8f4fea8}{AAX\_eParameterOrientation\_RotaryLeftMinRightMax}};}
\DoxyCodeLine{\ \}}

\end{DoxyCode}


The orientation options are set according to \mbox{\hyperlink{a00446_aa5ffa1ed828630b6b7a13c049d93ae87}{AAX\+\_\+\+EParameter\+Orientation\+Bits}}

\begin{DoxyRefDesc}{Legacy Porting Notes}
\item[\mbox{\hyperlink{a00880__porting_notes000032}{Legacy Porting Notes}}]\mbox{\hyperlink{a02066_ac122e1a693296b059dca4350a5ff1dfe}{AAX\+\_\+\+IEffect\+Parameters\+::\+Get\+Parameter\+Orientation()}} corresponds to the Get\+Control\+Orientation() method in the legacy RTAS/\+TDM SDK.\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Parameter\+Orientation} & The orientation of the parameter \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a8ddd81b155f01497508093d32f5545e7}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a169b7e9fe64f2d86d20fffc152b5e365}\label{a02066_a169b7e9fe64f2d86d20fffc152b5e365}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameter@{GetParameter}}
\index{GetParameter@{GetParameter}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameter()}{GetParameter()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{\mbox{\hyperlink{a02302}{AAX\+\_\+\+IParameter}} $\ast$$\ast$}]{o\+Parameter }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves an arbitrary setting within a parameter. 

This is a convenience function for accessing the richer parameter interface from the plug-\/in\textquotesingle{}s other modules.

\begin{DoxyNote}{Note}
This function must not be called by the host; \mbox{\hyperlink{a02302}{AAX\+\_\+\+IParameter}} is not safe for passing across the binary boundary with the host!
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Parameter} & A pointer to the returned parameter \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a0fc56336535ca545f1844a5497eecc64}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_aff1ff6b27973200429f057dc003f30a8}\label{a02066_aff1ff6b27973200429f057dc003f30a8}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterIndex@{GetParameterIndex}}
\index{GetParameterIndex@{GetParameterIndex}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterIndex()}{GetParameterIndex()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Index (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{int32\+\_\+t $\ast$}]{o\+Control\+Index }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the index of a parameter. 

Although parameters are normally referenced by their AAX\+\_\+\+CParam\+ID, each parameter is also associated with a unique numeric index.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Control\+Index} & The parameter\textquotesingle{}s numeric index \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a78485ad1079cf0da2843fce800afd5a8}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a5387b83e0f684a5bf0e09b24cae257d9}\label{a02066_a5387b83e0f684a5bf0e09b24cae257d9}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterIDFromIndex@{GetParameterIDFromIndex}}
\index{GetParameterIDFromIndex@{GetParameterIDFromIndex}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterIDFromIndex()}{GetParameterIDFromIndex()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+IDFrom\+Index (\begin{DoxyParamCaption}\item[{int32\+\_\+t}]{i\+Control\+Index,  }\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$}]{o\+Parameter\+IDString }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the ID of a parameter. 

This method can be used to convert a parameter\textquotesingle{}s unique numeric index to its AAX\+\_\+\+CParam\+ID


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Control\+Index} & The numeric index of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Parameter\+IDString} & Reference to an \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} owned by the host. The plug-\/in must set this string equal to the parameter\textquotesingle{}s ID. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a569cc13f2937cd68b3a1588c684df606}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a1702de6d62b5b41b6a8b2f510300392b}\label{a02066_a1702de6d62b5b41b6a8b2f510300392b}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterValueInfo@{GetParameterValueInfo}}
\index{GetParameterValueInfo@{GetParameterValueInfo}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterValueInfo()}{GetParameterValueInfo()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Value\+Info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{int32\+\_\+t}]{i\+Selector,  }\item[{int32\+\_\+t $\ast$}]{o\+Value }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves a property of a parameter. 

This is a general purpose query that is specialized based on the value of {\ttfamily i\+Selector}. The currently supported selector values are described by \mbox{\hyperlink{a00446_aa169208a2ce713fa021e20deb2eaf608}{AAX\+\_\+\+EParameter\+Value\+Info\+Selector}} . The meaning of {\ttfamily o\+Value} is dependent upon {\ttfamily i\+Selector} .


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Selector} & The selector of the parameter value to retrieve. See \mbox{\hyperlink{a00446_aa169208a2ce713fa021e20deb2eaf608}{AAX\+\_\+\+EParameter\+Value\+Info\+Selector}} \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Value} & The value of the specified parameter \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a0d3436cb88b4a86fe82a663221a9cfef}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a54bb12c9798e4f9a3a5b5d6f30ace992}\label{a02066_a54bb12c9798e4f9a3a5b5d6f30ace992}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterValueFromString@{GetParameterValueFromString}}
\index{GetParameterValueFromString@{GetParameterValueFromString}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterValueFromString()}{GetParameterValueFromString()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Value\+From\+String (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{double $\ast$}]{o\+Value,  }\item[{const \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&}]{i\+Value\+String }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Converts a value string to a value. 

This method uses the queried parameter\textquotesingle{}s display delegate and taper to convert a {\ttfamily char$\ast$} string into its corresponding value. The formatting of value\+String must be supported by the parameter\textquotesingle{}s display delegate in order for this call to succeed.

\begin{DoxyRefDesc}{Legacy Porting Notes}
\item[\mbox{\hyperlink{a00880__porting_notes000033}{Legacy Porting Notes}}]This method corresponds to CProcess\+::\+Map\+Control\+String\+To\+Val() in the RTAS/\+TDM SDK\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Value} & The value associated with value\+String \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Value\+String} & The formatted value string that will be converted into a value \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_af52682d9ba47701be0e803d19eb057a7}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_add995f2eb5a3967c48dd9f3e21f003aa}\label{a02066_add995f2eb5a3967c48dd9f3e21f003aa}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterStringFromValue@{GetParameterStringFromValue}}
\index{GetParameterStringFromValue@{GetParameterStringFromValue}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterStringFromValue()}{GetParameterStringFromValue()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+String\+From\+Value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{double}]{i\+Value,  }\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$}]{o\+Value\+String,  }\item[{int32\+\_\+t}]{i\+Max\+Length }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Converts a normalized parameter value into a string representing its corresponding real value. 

This method uses the queried parameter\textquotesingle{}s display delegate and taper to convert a normalized value into the corresponding {\ttfamily char$\ast$} value string for its real value.

\begin{DoxyRefDesc}{Legacy Porting Notes}
\item[\mbox{\hyperlink{a00880__porting_notes000034}{Legacy Porting Notes}}]This method corresponds to CProcess\+::\+Map\+Control\+Val\+To\+String() in the RTAS/\+TDM SDK\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Value} & The normalized value that will be converted to a formatted value\+String \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Value\+String} & The formatted value string associated with value \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Max\+Length} & The maximum length of value\+String \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a4d92debb4785a84356960ac8c633bf12}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_aacb54e6522561fe91fe12d0d99734abf}\label{a02066_aacb54e6522561fe91fe12d0d99734abf}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterValueString@{GetParameterValueString}}
\index{GetParameterValueString@{GetParameterValueString}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterValueString()}{GetParameterValueString()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Value\+String (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$}]{o\+Value\+String,  }\item[{int32\+\_\+t}]{i\+Max\+Length }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the value string associated with a parameter\textquotesingle{}s current value. 

This method uses the queried parameter\textquotesingle{}s display delegate and taper to convert its current value into a corresponding {\ttfamily char$\ast$} value string.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Value\+String} & The formatted value string associated with the parameter\textquotesingle{}s current value \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Max\+Length} & The maximum length of value\+String \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a5ca62ebda52ddd423450eaa77f1d6968}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a18e3407bac178a9b0339bd6f95e74a17}\label{a02066_a18e3407bac178a9b0339bd6f95e74a17}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetParameterNormalizedValue@{GetParameterNormalizedValue}}
\index{GetParameterNormalizedValue@{GetParameterNormalizedValue}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetParameterNormalizedValue()}{GetParameterNormalizedValue()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Parameter\+Normalized\+Value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{double $\ast$}]{o\+Value\+Ptr }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves a parameter\textquotesingle{}s current value. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Value\+Ptr} & The parameter\textquotesingle{}s current value \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_ae2892335e4613cfd427fc636b483fceb}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a368b0f5a761d1eda4c41b420f153a077}\label{a02066_a368b0f5a761d1eda4c41b420f153a077}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!SetParameterNormalizedValue@{SetParameterNormalizedValue}}
\index{SetParameterNormalizedValue@{SetParameterNormalizedValue}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{SetParameterNormalizedValue()}{SetParameterNormalizedValue()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Set\+Parameter\+Normalized\+Value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{double}]{i\+Value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Sets the specified parameter to a new value. 

\mbox{\hyperlink{a02066_a368b0f5a761d1eda4c41b420f153a077}{Set\+Parameter\+Normalized\+Value()}} is responsible for initiating any process that is required in order to update all of the parameter\textquotesingle{}s controls (e.\+g. in the plug-\/in\textquotesingle{}s GUI, on control surfaces, in automation lanes, etc.) In most cases, the parameter manager will handle this initiation step.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being set \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Value} & The value to which the parameter should be set \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a8eabaa279c51e74b30d3d2ffa5c865cb}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a6e28a427a0d7d0c8df69dd5eb88cff6c}\label{a02066_a6e28a427a0d7d0c8df69dd5eb88cff6c}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!SetParameterNormalizedRelative@{SetParameterNormalizedRelative}}
\index{SetParameterNormalizedRelative@{SetParameterNormalizedRelative}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{SetParameterNormalizedRelative()}{SetParameterNormalizedRelative()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Set\+Parameter\+Normalized\+Relative (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{double}]{i\+Value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Sets the specified parameter to a new value relative to its current value. 

This method is used in cases when a relative control value is more convenient, for example when updating a GUI control using a mouse wheel or the arrow keys. Note that the host may apply the parameter\textquotesingle{}s step size prior to calling \mbox{\hyperlink{a02066_a6e28a427a0d7d0c8df69dd5eb88cff6c}{Set\+Parameter\+Normalized\+Relative()}} in order to determine the correct value for a\+Value.

\mbox{\hyperlink{a02066_a6e28a427a0d7d0c8df69dd5eb88cff6c}{Set\+Parameter\+Normalized\+Relative()}} can be used to incorporate \char`\"{}wrapping\char`\"{} behavior in a parameter\textquotesingle{}s controls, if desired. If this behavior is not desired, then this method must properly account for overflow of the parameter\textquotesingle{}s normalized value.

\mbox{\hyperlink{a02066_a6e28a427a0d7d0c8df69dd5eb88cff6c}{Set\+Parameter\+Normalized\+Relative()}} is responsible for initiating any process that is required in order to update all of the parameter\textquotesingle{}s controls (e.\+g. in the plug-\/in\textquotesingle{}s GUI, on control surfaces, in automation lanes, etc.) In most cases, the parameter manager will handle this initiation step.

See also \mbox{\hyperlink{a02066_a54403bec090fcc999a93f54c01bca0c9}{Update\+Parameter\+Normalized\+Relative()}}.

\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000039}{Todo}}]REMOVE THIS METHOD (?)\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being queried \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Value} & The change in value that should be applied to the parameter\\
\hline
\end{DoxyParams}
\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000040}{Todo}}]NOT CURRENTLY CALLED FROM THE HOST. USEFUL FOR INTERNAL USE ONLY?\end{DoxyRefDesc}


Implemented in \mbox{\hyperlink{a01850_a2191024666f779ea95e89e03fc76a7a8}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_ae82e80cbfd9cb837f8101a85f06856ba}\label{a02066_ae82e80cbfd9cb837f8101a85f06856ba}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!TouchParameter@{TouchParameter}}
\index{TouchParameter@{TouchParameter}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{TouchParameter()}{TouchParameter()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Touch\+Parameter (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



\char`\"{}\+Touches\char`\"{} (locks) a parameter in the automation system to a particular control in preparation for updates 

This method is called by the Parameter Manager to prime a parameter for receiving new automation data. When an automatable parameter is touched by a control, it will reject input from other controls until it is released.

\begin{DoxyNote}{Note}
You should never need to override this method when using \mbox{\hyperlink{a01850}{AAX\+\_\+\+CEffect\+Parameters}}.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The parameter that is being touched \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a0c7e32833e98facec61b73ac25049b13}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a2caf1b7b8e2dad62cf96f144479dee60}\label{a02066_a2caf1b7b8e2dad62cf96f144479dee60}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!ReleaseParameter@{ReleaseParameter}}
\index{ReleaseParameter@{ReleaseParameter}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{ReleaseParameter()}{ReleaseParameter()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Release\+Parameter (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Releases a parameter from a \char`\"{}touched\char`\"{} state. 

This method is called by the Parameter Manager to release a parameter so that any control may send updates to the parameter.

\begin{DoxyNote}{Note}
You should never need to override this method when using \mbox{\hyperlink{a01850}{AAX\+\_\+\+CEffect\+Parameters}}.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The parameter that is being released \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a39c2085d444916000acec5da3797ca37}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a93483f44315bdf3adf60bf5bf773fbb8}\label{a02066_a93483f44315bdf3adf60bf5bf773fbb8}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!UpdateParameterTouch@{UpdateParameterTouch}}
\index{UpdateParameterTouch@{UpdateParameterTouch}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{UpdateParameterTouch()}{UpdateParameterTouch()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Update\+Parameter\+Touch (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{\mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}}}]{i\+Touch\+State }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets a \char`\"{}touched\char`\"{} state on a parameter. 

\begin{DoxyNote}{Note}
This method should be overriden when dealing with linked parameters. Do NOT use this method to keep track of touch states. Use the \mbox{\hyperlink{a02006}{automation delegate}} for that.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The parameter that is changing touch states. \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Touch\+State} & The touch state of the parameter. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a035778f6cccf8cf96a11b3a028efed6e}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a685858711efb8634ce66c327f2865c71}\label{a02066_a685858711efb8634ce66c327f2865c71}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!UpdateParameterNormalizedValue@{UpdateParameterNormalizedValue}}
\index{UpdateParameterNormalizedValue@{UpdateParameterNormalizedValue}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{UpdateParameterNormalizedValue()}{UpdateParameterNormalizedValue()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Update\+Parameter\+Normalized\+Value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{double}]{i\+Value,  }\item[{\mbox{\hyperlink{a00446_a30be0398faf20c6b121239eb9399f3f7}{AAX\+\_\+\+EUpdate\+Source}}}]{i\+Source }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Updates a single parameter\textquotesingle{}s state to its current value. 

\begin{DoxyNote}{Note}
Do {\itshape not} call this method from the plug-\/in. This method should be called by the host only. To set parameter values from within the plug-\/in, use the \mbox{\hyperlink{a02302}{AAX\+\_\+\+IParameter}} interface.
\end{DoxyNote}
\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000041}{Todo}}]FLAGGED FOR CONSIDERATION OF REVISION\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being updated \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Value} & The parameter\textquotesingle{}s current value, to which its internal state must be updated \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Source} & The source of the update \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_aeff79c1e5cc6b65c7ed21d9912f87caf}{AAX\+\_\+\+CEffect\+Parameters}}, and \mbox{\hyperlink{a02462_a9ef4fd6fa467008fcea4455d19c08009}{AAX\+\_\+\+CMonolithic\+Parameters}}.

\mbox{\Hypertarget{a02066_a54403bec090fcc999a93f54c01bca0c9}\label{a02066_a54403bec090fcc999a93f54c01bca0c9}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!UpdateParameterNormalizedRelative@{UpdateParameterNormalizedRelative}}
\index{UpdateParameterNormalizedRelative@{UpdateParameterNormalizedRelative}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{UpdateParameterNormalizedRelative()}{UpdateParameterNormalizedRelative()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Update\+Parameter\+Normalized\+Relative (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}}}]{i\+Parameter\+ID,  }\item[{double}]{i\+Value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Updates a single parameter\textquotesingle{}s state to its current value, as a difference with the parameter\textquotesingle{}s previous value. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{a00881__deprecated000014}{Deprecated}}]This is not called from the host. It {\itshape may} still be useful for internal calls within the plug-\/in, though it should only ever be used to update non-\/automatable parameters. Automatable parameters should always be updated through the \mbox{\hyperlink{a02302}{AAX\+\_\+\+IParameter}} interface, which will ensure proper coordination with other automation clients.\end{DoxyRefDesc}


\mbox{\hyperlink{a02066_a54403bec090fcc999a93f54c01bca0c9}{Update\+Parameter\+Normalized\+Relative()}} can be used to incorporate \char`\"{}wraparound\char`\"{} behavior in a parameter\textquotesingle{}s controls, if desired. If this behavior is not desired, then this method must properly account for overflow of the parameter\textquotesingle{}s normalized value.

\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02066_a6e28a427a0d7d0c8df69dd5eb88cff6c}{Set\+Parameter\+Normalized\+Relative()}}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+ID} & The ID of the parameter that is being updated \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Value} & The difference between the parameter\textquotesingle{}s current value and its previous value (normalized). The parameter\textquotesingle{}s state must be updated to reflect this difference. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_aa2e14fdf26352f16f3b0c437bc0894cb}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a083265b008921b6114ede387711694b7}\label{a02066_a083265b008921b6114ede387711694b7}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GenerateCoefficients@{GenerateCoefficients}}
\index{GenerateCoefficients@{GenerateCoefficients}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GenerateCoefficients()}{GenerateCoefficients()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Generate\+Coefficients (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Generates and dispatches new coefficient packets. 

This method is responsible for updating the coefficient packets associated with all parameters whose states have changed since the last call to \mbox{\hyperlink{a02066_a083265b008921b6114ede387711694b7}{Generate\+Coefficients()}}. The host may call this method once for every parameter update, or it may \char`\"{}batch\char`\"{} parameter updates such that changes for several parameters are all handled by a single call to \mbox{\hyperlink{a02066_a083265b008921b6114ede387711694b7}{Generate\+Coefficients()}}.

For more information on tracking parameters\textquotesingle{} statuses using the \mbox{\hyperlink{a01898}{AAX\+\_\+\+CPacket\+Dispatcher}}, helper class, see \mbox{\hyperlink{a01898_a6d4254a842eeee46a227ec761619efb5}{AAX\+\_\+\+CPacket\+Dispatcher\+::\+Set\+Dirty()}}.

\begin{DoxyNote}{Note}
Do {\itshape not} call this method from the plug-\/in. This method should be called by the host only. To set parameter values from within the plug-\/in, use the \mbox{\hyperlink{a02302}{AAX\+\_\+\+IParameter}} interface. 
\end{DoxyNote}


Implemented in \mbox{\hyperlink{a02462_a626cb2aaa68c64238298acfd6db448f5}{AAX\+\_\+\+CMonolithic\+Parameters}}, and \mbox{\hyperlink{a01850_a2ae4c7e4ed12f2763934da50aa5730f3}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a6e87e40d42c7431e52ae5ebd4f631964}\label{a02066_a6e87e40d42c7431e52ae5ebd4f631964}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!ResetFieldData@{ResetFieldData}}
\index{ResetFieldData@{ResetFieldData}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{ResetFieldData()}{ResetFieldData()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Reset\+Field\+Data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index,  }\item[{void $\ast$}]{o\+Data,  }\item[{uint32\+\_\+t}]{in\+Data\+Size }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Called by the host to reset a private data field in the plug-\/in\textquotesingle{}s algorithm. 

This method is called sequentially for all private data fields on Effect initialization and during any \char`\"{}reset\char`\"{} event, such as priming for a non-\/real-\/time render. This method is called before the algorithm\textquotesingle{}s optional initialization callback, and the initialized private data will be available within that callback via its context block.

\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a00890_alg_initialization}{Algorithm initialization}}.
\end{DoxySeeAlso}
\begin{DoxyWarning}{Warning}
Any data structures that will be passed between platforms (for example, sent to a TI DSP in an AAX DSP plug-\/in) must be properly data-\/aligned for compatibility across both platforms. See \mbox{\hyperlink{a00542_a8fbeac3c5db5ac694e85a021ed74dc9e}{AAX\+\_\+\+ALIGN\+\_\+\+FILE\+\_\+\+ALG}} for more information about guaranteeing cross-\/platform compatibility of data structures used for algorithm processing.
\end{DoxyWarning}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & The index of the field that is being initialized \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Data} & The pre-\/allocated block of data that should be initialized \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Data\+Size} & The size of the data block, in bytes \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02462_a43db72446afba852f68d19d92c2aa05b}{AAX\+\_\+\+CMonolithic\+Parameters}}, and \mbox{\hyperlink{a01850_a0dd675680a657de7f9d45d65d4b3bcfb}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a37e546c6dbb4d5a16fedb9f465de2599}\label{a02066_a37e546c6dbb4d5a16fedb9f465de2599}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetNumberOfChunks@{GetNumberOfChunks}}
\index{GetNumberOfChunks@{GetNumberOfChunks}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetNumberOfChunks()}{GetNumberOfChunks()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Number\+Of\+Chunks (\begin{DoxyParamCaption}\item[{int32\+\_\+t $\ast$}]{o\+Num\+Chunks }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Retrieves the number of chunks used by this plug-\/in. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em o\+Num\+Chunks} & The number of distinct chunks used by this plug-\/in \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a1b2e04986362ca076b862ceae18bbab7}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a10409113cb781002551b878e4c0edd5a}\label{a02066_a10409113cb781002551b878e4c0edd5a}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetChunkIDFromIndex@{GetChunkIDFromIndex}}
\index{GetChunkIDFromIndex@{GetChunkIDFromIndex}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetChunkIDFromIndex()}{GetChunkIDFromIndex()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Chunk\+IDFrom\+Index (\begin{DoxyParamCaption}\item[{int32\+\_\+t}]{i\+Index,  }\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} $\ast$}]{o\+Chunk\+ID }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Retrieves the ID associated with a chunk index. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Index} & Index of the queried chunk \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Chunk\+ID} & ID of the queried chunk \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a493471529cb63af2e6b069f6c6a35d6f}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_aa986711cd372febcaae803e86ae08f63}\label{a02066_aa986711cd372febcaae803e86ae08f63}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetChunkSize@{GetChunkSize}}
\index{GetChunkSize@{GetChunkSize}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetChunkSize()}{GetChunkSize()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Chunk\+Size (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{i\+Chunk\+ID,  }\item[{uint32\+\_\+t $\ast$}]{o\+Size }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Get the size of the data structure that can hold all of a chunk\textquotesingle{}s information. 

If {\itshape chunk\+ID} is one of the plug-\/in\textquotesingle{}s custom chunks, initialize {\itshape $\ast$size} to the size of the chunk\textquotesingle{}s data in bytes.

This method is invoked every time a chunk is saved, therefore it is possible to have dynamically sized chunks. However, note that each call to \mbox{\hyperlink{a02066_aa986711cd372febcaae803e86ae08f63}{Get\+Chunk\+Size()}} will correspond to a following call to \mbox{\hyperlink{a02066_ab977041a440a9cd6f3e631c059ee8b99}{Get\+Chunk()}}. The chunk provided in \mbox{\hyperlink{a02066_ab977041a440a9cd6f3e631c059ee8b99}{Get\+Chunk()}} {\itshape must} have the same size as the {\itshape size} provided by \mbox{\hyperlink{a02066_aa986711cd372febcaae803e86ae08f63}{Get\+Chunk\+Size()}}.

\begin{DoxyRefDesc}{Legacy Porting Notes}
\item[\mbox{\hyperlink{a00880__porting_notes000035}{Legacy Porting Notes}}]In \mbox{\hyperlink{a00948}{AAX}}, the value provided by \mbox{\hyperlink{a02066_aa986711cd372febcaae803e86ae08f63}{Get\+Chunk\+Size()}} should {\itshape NOT} include the size of the chunk header. The value should {\itshape ONLY} reflect the size of the chunk\textquotesingle{}s data.\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Chunk\+ID} & ID of the queried chunk \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Size} & The chunk\textquotesingle{}s size in bytes \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_aade2d4ba2fcb8c302917caf4bfb0f8cf}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_ab977041a440a9cd6f3e631c059ee8b99}\label{a02066_ab977041a440a9cd6f3e631c059ee8b99}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetChunk@{GetChunk}}
\index{GetChunk@{GetChunk}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetChunk()}{GetChunk()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Chunk (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{i\+Chunk\+ID,  }\item[{\mbox{\hyperlink{a01782}{AAX\+\_\+\+SPlug\+In\+Chunk}} $\ast$}]{o\+Chunk }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Fills a block of data with chunk information representing the plug-\/in\textquotesingle{}s current state. 

By calling this method, the host is requesting information about the current state of the plug-\/in. The following chunk fields should be explicitly populated in this method. Other fields will be populated by the host.

\begin{DoxyItemize}
\item \mbox{\hyperlink{a01782_abc76d66fffa4a59ee5cfdbdd992c532c}{AAX\+\_\+\+SPlug\+In\+Chunk\+::f\+Data}} \item \mbox{\hyperlink{a01782_ac114fd94e7b12c235f9c18bcbbc46f06}{AAX\+\_\+\+SPlug\+In\+Chunk\+::f\+Version}} \item \mbox{\hyperlink{a01782_a1b07e29358b5549739f674e04653a6bc}{AAX\+\_\+\+SPlug\+In\+Chunk\+::f\+Name}} (Optional) \item \mbox{\hyperlink{a01782_ac08f37f1ed50eac8ac3ca4bf5494c84d}{AAX\+\_\+\+SPlug\+In\+Chunk\+::f\+Size}} (Data size only)\end{DoxyItemize}
\begin{DoxyWarning}{Warning}
Remember that this chunk data may be loaded on a different platform from the one where it is saved. All data structures in the chunk must be properly data-\/aligned for compatibility across all platforms that the plug-\/in supports. See \mbox{\hyperlink{a00542_a8fbeac3c5db5ac694e85a021ed74dc9e}{AAX\+\_\+\+ALIGN\+\_\+\+FILE\+\_\+\+ALG}} for notes about common cross-\/platform pitfalls for data structure alignment.
\end{DoxyWarning}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Chunk\+ID} & ID of the chunk that should be provided \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Chunk} & A preallocated block of memory that should be populated with the chunk\textquotesingle{}s data. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_aeddfa6e0b92f9373836ae41491114c4d}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a2d780ebc594683e24302871b809602e8}\label{a02066_a2d780ebc594683e24302871b809602e8}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!SetChunk@{SetChunk}}
\index{SetChunk@{SetChunk}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{SetChunk()}{SetChunk()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Set\+Chunk (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{i\+Chunk\+ID,  }\item[{const \mbox{\hyperlink{a01782}{AAX\+\_\+\+SPlug\+In\+Chunk}} $\ast$}]{i\+Chunk }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Restores a set of plug-\/in parameters based on chunk information. 

By calling this method, the host is attempting to update the plug-\/in\textquotesingle{}s current state to match the data stored in a chunk. The plug-\/in should initialize itself to this new state by calling \mbox{\hyperlink{a02066_a368b0f5a761d1eda4c41b420f153a077}{Set\+Parameter\+Normalized\+Value()}} for each of the relevant parameters.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Chunk\+ID} & ID of the chunk that is being set \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Chunk} & The chunk \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a9908dd1d95995027bf6073c08f38b468}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a1e86f849e970c9998313fc7d451ccf85}\label{a02066_a1e86f849e970c9998313fc7d451ccf85}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!CompareActiveChunk@{CompareActiveChunk}}
\index{CompareActiveChunk@{CompareActiveChunk}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{CompareActiveChunk()}{CompareActiveChunk()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Compare\+Active\+Chunk (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{a01782}{AAX\+\_\+\+SPlug\+In\+Chunk}} $\ast$}]{i\+ChunkP,  }\item[{\mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}} $\ast$}]{o\+Is\+Equal }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Determine if a chunk represents settings that are equivalent to the plug-\/in\textquotesingle{}s current state. 

\begin{DoxyRefDesc}{Host Compatibility Notes}
\item[\mbox{\hyperlink{a00879__compatibility_notes000049}{Host Compatibility Notes}}]In Pro Tools, this method will only be called if a prior call to \mbox{\hyperlink{a02066_a17b96da201d9a242d3662e87525a7227}{Get\+Number\+Of\+Changes()}} has indicated that the plug-\/in\textquotesingle{}s state has changed. If the plug-\/in\textquotesingle{}s current settings are different from the settings in {\ttfamily a\+ChunkP} then the plug-\/in\textquotesingle{}s Compare Light will be illuminated in the plug-\/in header, allowing users to toggle between the plug-\/in\textquotesingle{}s custom state and its saved state.\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+ChunkP} & The chunk that is to be tested \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Is\+Equal} & True if the chunk represents equivalent settings when compared with the plug-\/in\textquotesingle{}s current state. False if the chunk represents non-\/equivalent settings \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a514644d855be6f58043ec165f6ce8ddb}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a17b96da201d9a242d3662e87525a7227}\label{a02066_a17b96da201d9a242d3662e87525a7227}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetNumberOfChanges@{GetNumberOfChanges}}
\index{GetNumberOfChanges@{GetNumberOfChanges}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetNumberOfChanges()}{GetNumberOfChanges()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Number\+Of\+Changes (\begin{DoxyParamCaption}\item[{int32\+\_\+t $\ast$}]{o\+Num\+Changes }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Retrieves the number of parameter changes made since the plug-\/in\textquotesingle{}s creation. 

This method is polled regularly by the host, and can additionally be triggered by some events such as mouse clicks. When the number provided by this method changes, the host subsequently calls \mbox{\hyperlink{a02066_a1e86f849e970c9998313fc7d451ccf85}{Compare\+Active\+Chunk()}} to determine if the plug-\/in\textquotesingle{}s Compare light should be activated.

The value provided by this method should increment with each call to \mbox{\hyperlink{a02066_a685858711efb8634ce66c327f2865c71}{Update\+Parameter\+Normalized\+Value()}}


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em o\+Num\+Changes} & Must be set to indicate the number of parameter changes that have occurred since plug-\/in initialization. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a9c6e26d6b3e028fcb048e01caa155f65}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_ab5b8da9e1a9d778d327ac04f4ab8d139}\label{a02066_ab5b8da9e1a9d778d327ac04f4ab8d139}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!TimerWakeup@{TimerWakeup}}
\index{TimerWakeup@{TimerWakeup}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{TimerWakeup()}{TimerWakeup()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Timer\+Wakeup (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Periodic wakeup callback for idle-\/time operations. 

This method is called from the host using a non-\/main thread. In general, it should be driven at approximately one call per 30 ms. However, the wakeup is not guaranteed to be called at any regular interval -\/ for example, it could be held off by a high real-\/time processing load -\/ and there is no host contract regarding maximum latency between wakeup calls.

This wakeup thread runs continuously and cannot be armed/disarmed or by the plug-\/in. 

Implemented in \mbox{\hyperlink{a02462_ac3f92841efe2d864ffefce94b7ae27b4}{AAX\+\_\+\+CMonolithic\+Parameters}}, and \mbox{\hyperlink{a01850_a4e1dc0e4b966fe80041d67814d13e03d}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_a4728fcad006d921a07489144360f447e}\label{a02066_a4728fcad006d921a07489144360f447e}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!GetCustomData@{GetCustomData}}
\index{GetCustomData@{GetCustomData}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{GetCustomData()}{GetCustomData()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Get\+Custom\+Data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{i\+Data\+Block\+ID,  }\item[{uint32\+\_\+t}]{in\+Data\+Size,  }\item[{void $\ast$}]{o\+Data,  }\item[{uint32\+\_\+t $\ast$}]{o\+Data\+Written }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



An optional interface hook for getting custom data from another module. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Data\+Block\+ID} & Identifier for the requested block of custom data \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Data\+Size} & Size of provided buffer, in bytes \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Data} & Pointer to an allocated buffer. Data will be written here. \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Data\+Written} & The number of bytes actually written \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_afc82be9a9444bc8bc4a82e8ea370d88e}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_aa838cad04781853ef2e0b9df22a05170}\label{a02066_aa838cad04781853ef2e0b9df22a05170}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!SetCustomData@{SetCustomData}}
\index{SetCustomData@{SetCustomData}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{SetCustomData()}{SetCustomData()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Set\+Custom\+Data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{i\+Data\+Block\+ID,  }\item[{uint32\+\_\+t}]{in\+Data\+Size,  }\item[{const void $\ast$}]{i\+Data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



An optional interface hook for setting custom data for use by another module. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Data\+Block\+ID} & Identifier for the provided block of custom data \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Data\+Size} & Size of provided buffer, in bytes \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Data} & Pointer to the data buffer \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a01850_a2905b5ec2ef715cd9000c8f1902e13d3}{AAX\+\_\+\+CEffect\+Parameters}}.

\mbox{\Hypertarget{a02066_af376aef3d3ecdc6287f820b4e01f5c9b}\label{a02066_af376aef3d3ecdc6287f820b4e01f5c9b}} 
\index{AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}!DoMIDITransfers@{DoMIDITransfers}}
\index{DoMIDITransfers@{DoMIDITransfers}!AAX\_IACFEffectParameters@{AAX\_IACFEffectParameters}}
\doxysubsubsection{\texorpdfstring{DoMIDITransfers()}{DoMIDITransfers()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFEffect\+Parameters\+::\+Do\+MIDITransfers (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



MIDI update callback. 

Call \mbox{\hyperlink{a02222_a2896ba3a1ed86ce2813b1736d316d275}{AAX\+\_\+\+IController\+::\+Get\+Next\+MIDIPacket()}} from within this method to retrieve and process MIDI packets directly within the Effect\textquotesingle{}s data model. MIDI data will also be delivered to the Effect algorithm.

This method is called regularly by the host, similarly to \mbox{\hyperlink{a02066_ab5b8da9e1a9d778d327ac04f4ab8d139}{AAX\+\_\+\+IEffect\+Parameters\+::\+Timer\+Wakeup()}} 

Implemented in \mbox{\hyperlink{a01850_ae1076f7e181a6f66f0078bf31beb2cf1}{AAX\+\_\+\+CEffect\+Parameters}}.



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