\hypertarget{a02222}{}\doxysection{AAX\+\_\+\+IController Class Reference}
\label{a02222}\index{AAX\_IController@{AAX\_IController}}


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



Inheritance diagram for AAX\+\_\+\+IController\+:
% FIG 0


\doxysubsection{Description}
Interface for the AAX host\textquotesingle{}s view of a single instance of an effect. Used by both clients of the AAX host and by effect components. 

\begin{DoxyRefDesc}{\+:\+Implemented by the AAX Host}
\item[\mbox{\hyperlink{a00884__aax_host_implementation000004}{\+:\+Implemented by the AAX Host}}]\end{DoxyRefDesc}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a02222_aa8dee55f260a0f92f29b95f9d7acc9dd}{$\sim$\+AAX\+\_\+\+IController}} (void)
\end{DoxyCompactItemize}
\begin{Indent}\textbf{ Host information getters}\par
{\em Call these methods to retrieve environment and run-\/time information from the AAX host. }\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_ab36371e7f7c47f30882684481285f5eb}{Get\+Effect\+ID}} (\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$out\+Effect\+ID) const =0
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_afa1f9f64eeeab9570e5599f466fa699e}{Get\+Sample\+Rate}} (\mbox{\hyperlink{a00542_a3d9eea08f47e0b0a23432e15baa4e885}{AAX\+\_\+\+CSample\+Rate}} $\ast$out\+Sample\+Rate) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Returns the current literal sample rate. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_ab024489b47d3d5d2bcd52c9859aba663}{Get\+Input\+Stem\+Format}} (\mbox{\hyperlink{a00446_ad8af5ef008b2bd478add9a0acb0a1d85}{AAX\+\_\+\+EStem\+Format}} $\ast$out\+Stem\+Format) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Returns the plug-\/in\textquotesingle{}s input stem format. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_aabe72e915df571776d4aa1c36ef8d6f2}{Get\+Output\+Stem\+Format}} (\mbox{\hyperlink{a00446_ad8af5ef008b2bd478add9a0acb0a1d85}{AAX\+\_\+\+EStem\+Format}} $\ast$out\+Stem\+Format) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Returns the plug-\/in\textquotesingle{}s output stem format. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_ad50aa6fd54e39623a58debd63d9551e1}{Get\+Signal\+Latency}} (int32\+\_\+t $\ast$out\+Samples) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Returns the most recent signal (algorithmic) latency that has been published by the plug-\/in. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_a26e009667f9cd6c3cccd45b862108bf4}{Get\+Cycle\+Count}} (\mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0d}{AAX\+\_\+\+EProperty}} in\+Which\+Cycle\+Count, \mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} $\ast$out\+Num\+Cycles) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: returns the plug-\/in\textquotesingle{}s current real-\/time DSP cycle count. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_afbc2973d755b6c3ae82b6c8461e9fdee}{Get\+TODLocation}} (\mbox{\hyperlink{a00542_a46542a1dcccdcc3b4260a9926edf8a2a}{AAX\+\_\+\+CTime\+Of\+Day}} $\ast$out\+TODLocation) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Returns the current Time Of Day (TOD) of the system. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Host information setters}\par
{\em Call these methods to set dynamic plug-\/in run-\/time information on the AAX host. }\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_af2c648879419d94971c1308d8698601f}{Set\+Signal\+Latency}} (int32\+\_\+t in\+Num\+Samples)=0
\begin{DoxyCompactList}\small\item\em CALL\+: Submits a request to change the delay compensation value that the host uses to account for the plug-\/in\textquotesingle{}s signal (algorithmic) latency. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_a1a654f682357d48bafd506cbbea2ae25}{Set\+Cycle\+Count}} (\mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0d}{AAX\+\_\+\+EProperty}} $\ast$in\+Which\+Cycle\+Counts, \mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} $\ast$i\+Values, int32\+\_\+t num\+Values)=0
\begin{DoxyCompactList}\small\item\em CALL\+: Indicates a change in the plug-\/in\textquotesingle{}s real-\/time DSP cycle count. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Posting methods}\par
{\em Call these methods to post new plug-\/in information to the host\textquotesingle{}s data management system. }\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_ae5dd2b5925dbc181513bca1c4ac5e716}{Post\+Packet}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} in\+Field\+Index, const void $\ast$in\+PayloadP, uint32\+\_\+t in\+Payload\+Size)=0
\begin{DoxyCompactList}\small\item\em CALL\+: Posts a data packet to the host for routing between plug-\/in components. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Notification methods}\par
{\em Call these methods to send events among plug-\/in components }\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_a0384f820cecf8cf7671057060bf5ba4f}{Send\+Notification}} (\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 CALL\+: Dispatch a notification. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_ad98d549cc7bec4039ce174438d46d5db}{Send\+Notification}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} in\+Notification\+Type)=0
\begin{DoxyCompactList}\small\item\em CALL\+: Sends an event to the GUI (no payload) \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ Metering methods}\par
{\em Methods to access the plug-\/in\textquotesingle{}s host-\/managed metering information.

\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a00902}{Plug-\/in meters}} 
\end{DoxySeeAlso}
}\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_a13de9cc4bb7fb3848fbe12622c033135}{Get\+Current\+Meter\+Value}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} in\+Meter\+ID, float $\ast$out\+Meter\+Value) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the current value of a host-\/managed plug-\/in meter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_a85db3824256005c97689925750103765}{Get\+Meter\+Peak\+Value}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} in\+Meter\+ID, float $\ast$out\+Meter\+Peak\+Value) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the currently held peak value of a host-\/managed plug-\/in meter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_aa8fe057d2f53109e75662da0a492fa34}{Clear\+Meter\+Peak\+Value}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} in\+Meter\+ID) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Clears the peak value from a host-\/managed plug-\/in meter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_a3ad8e35bb6b51be934696c39a45157e7}{Get\+Meter\+Count}} (uint32\+\_\+t $\ast$out\+Meter\+Count) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the number of host-\/managed meters registered by a plug-\/in. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_a1f07fa44cd8b3c4fddee9c0b78d35bbd}{Get\+Meter\+Clipped}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} in\+Meter\+ID, \mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}} $\ast$out\+Clipped) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves the clipped flag from a host-\/managed plug-\/in meter. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_a2c989b51cd74e0ce0319baf6d1c82465}{Clear\+Meter\+Clipped}} (\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}} in\+Meter\+ID) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Clears the clipped flag from a host-\/managed plug-\/in meter. \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}\textbf{ MIDI methods}\par
{\em Methods to access the plug-\/in\textquotesingle{}s host-\/managed MIDI information. }\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_a2896ba3a1ed86ce2813b1736d316d275}{Get\+Next\+MIDIPacket}} (\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} $\ast$out\+Port, \mbox{\hyperlink{a01790}{AAX\+\_\+\+CMidi\+Packet}} $\ast$out\+Packet)=0
\begin{DoxyCompactList}\small\item\em CALL\+: Retrieves MIDI packets for described MIDI nodes. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a00901_ga47b471c438fcad0798964b860d74609e}{Get\+Hybrid\+Signal\+Latency}} (int32\+\_\+t $\ast$out\+Samples) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Returns the latency between the algorithm normal input samples and the inputs returning from the hyrbid component. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_af9ab9b228023e116f89249a56c27a20f}{Get\+Current\+Automation\+Timestamp}} (\mbox{\hyperlink{a00542_ac09cd6857748cc296ac0f8bcc20dc74b}{AAX\+\_\+\+CTransport\+Counter}} $\ast$out\+Timestamp) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Returns the current automation timestamp if called during the \mbox{\hyperlink{a02066_a083265b008921b6114ede387711694b7}{Generate\+Coefficients()}} call AND the generation of coefficients is being triggered by an automation point instead of immediate changes. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_ad2a002a133491b2ed572054588641e78}{Get\+Host\+Name}} (\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$out\+Host\+Name\+String) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Returns name of the host application this plug-\/in instance is being loaded by. This string also typically includes version information. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_a8326b2acec2d9c9039853adafd9b2bef}{Get\+Plug\+In\+Target\+Platform}} (\mbox{\hyperlink{a00542_a8f2cefa455217fa9f3ce190fe5fd8033}{AAX\+\_\+\+CTarget\+Platform}} $\ast$out\+Target\+Platform) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Returns execution platform type, native or TI. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02222_af6d44bc336c3c2e4cca1a1684b556db3}{Get\+Is\+Audio\+Suite}} (\mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}} $\ast$out\+Is\+Audio\+Suite) const =0
\begin{DoxyCompactList}\small\item\em CALL\+: Returns true for Audio\+Suite instances. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a02294}{AAX\+\_\+\+IPage\+Table}} $\ast$ \mbox{\hyperlink{a02222_adfa3039472002a1df22d11607529ccf2}{Create\+Table\+Copy\+For\+Effect}} (\mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} in\+Manufacturer\+ID, \mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} in\+Product\+ID, \mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} in\+Plug\+In\+ID, uint32\+\_\+t in\+Table\+Type, int32\+\_\+t in\+Table\+Page\+Size) const =0
\begin{DoxyCompactList}\small\item\em Copy the current page table data for a particular plug-\/in type. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a02294}{AAX\+\_\+\+IPage\+Table}} $\ast$ \mbox{\hyperlink{a02222_a1ff3a32980181232312409794b206ef7}{Create\+Table\+Copy\+For\+Layout}} (const char $\ast$in\+Effect\+ID, const char $\ast$in\+Layout\+Name, uint32\+\_\+t in\+Table\+Type, int32\+\_\+t in\+Table\+Page\+Size) const =0
\begin{DoxyCompactList}\small\item\em Copy the current page table data for a particular plug-\/in effect and page table layout. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a02294}{AAX\+\_\+\+IPage\+Table}} $\ast$ \mbox{\hyperlink{a02222_a83404c4126395a0f449bd015fda38273}{Create\+Table\+Copy\+For\+Effect\+From\+File}} (const char $\ast$in\+Page\+Table\+File\+Path, \mbox{\hyperlink{a00446_a8152e57310850693e4e7f00fc4922d74}{AAX\+\_\+\+EText\+Encoding}} in\+File\+Path\+Encoding, \mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} in\+Manufacturer\+ID, \mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} in\+Product\+ID, \mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} in\+Plug\+In\+ID, uint32\+\_\+t in\+Table\+Type, int32\+\_\+t in\+Table\+Page\+Size) const =0
\begin{DoxyCompactList}\small\item\em Copy the current page table data for a particular plug-\/in type.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a02294}{AAX\+\_\+\+IPage\+Table}} $\ast$ \mbox{\hyperlink{a02222_a63513a230f629cbc912283c9281b196b}{Create\+Table\+Copy\+For\+Layout\+From\+File}} (const char $\ast$in\+Page\+Table\+File\+Path, \mbox{\hyperlink{a00446_a8152e57310850693e4e7f00fc4922d74}{AAX\+\_\+\+EText\+Encoding}} in\+File\+Path\+Encoding, const char $\ast$in\+Layout\+Name, uint32\+\_\+t in\+Table\+Type, int32\+\_\+t in\+Table\+Page\+Size) const =0
\begin{DoxyCompactList}\small\item\em Copy the current page table data for a particular plug-\/in effect and page table layout.   \end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}


\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{a02222_aa8dee55f260a0f92f29b95f9d7acc9dd}\label{a02222_aa8dee55f260a0f92f29b95f9d7acc9dd}} 
\index{AAX\_IController@{AAX\_IController}!````~AAX\_IController@{$\sim$AAX\_IController}}
\index{````~AAX\_IController@{$\sim$AAX\_IController}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{$\sim$AAX\_IController()}{~AAX\_IController()}}
{\footnotesize\ttfamily virtual AAX\+\_\+\+IController\+::$\sim$\+AAX\+\_\+\+IController (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{a02222_ab36371e7f7c47f30882684481285f5eb}\label{a02222_ab36371e7f7c47f30882684481285f5eb}} 
\index{AAX\_IController@{AAX\_IController}!GetEffectID@{GetEffectID}}
\index{GetEffectID@{GetEffectID}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetEffectID()}{GetEffectID()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Effect\+ID (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$}]{out\+Effect\+ID }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Implemented in \mbox{\hyperlink{a02378_ae1c1956d5ddd00afa59bd914a44b24da}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_afa1f9f64eeeab9570e5599f466fa699e}\label{a02222_afa1f9f64eeeab9570e5599f466fa699e}} 
\index{AAX\_IController@{AAX\_IController}!GetSampleRate@{GetSampleRate}}
\index{GetSampleRate@{GetSampleRate}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetSampleRate()}{GetSampleRate()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Sample\+Rate (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a3d9eea08f47e0b0a23432e15baa4e885}{AAX\+\_\+\+CSample\+Rate}} $\ast$}]{out\+Sample\+Rate }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Returns the current literal sample rate. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+Sample\+Rate} & The current sample rate \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a05b912d5178b1420b014da3b8e98e7cd}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_ab024489b47d3d5d2bcd52c9859aba663}\label{a02222_ab024489b47d3d5d2bcd52c9859aba663}} 
\index{AAX\_IController@{AAX\_IController}!GetInputStemFormat@{GetInputStemFormat}}
\index{GetInputStemFormat@{GetInputStemFormat}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetInputStemFormat()}{GetInputStemFormat()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Input\+Stem\+Format (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00446_ad8af5ef008b2bd478add9a0acb0a1d85}{AAX\+\_\+\+EStem\+Format}} $\ast$}]{out\+Stem\+Format }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Returns the plug-\/in\textquotesingle{}s input stem format. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+Stem\+Format} & The current input stem format \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a58e102ae406dd0fbf022d4364e6e24d0}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_aabe72e915df571776d4aa1c36ef8d6f2}\label{a02222_aabe72e915df571776d4aa1c36ef8d6f2}} 
\index{AAX\_IController@{AAX\_IController}!GetOutputStemFormat@{GetOutputStemFormat}}
\index{GetOutputStemFormat@{GetOutputStemFormat}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetOutputStemFormat()}{GetOutputStemFormat()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Output\+Stem\+Format (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00446_ad8af5ef008b2bd478add9a0acb0a1d85}{AAX\+\_\+\+EStem\+Format}} $\ast$}]{out\+Stem\+Format }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Returns the plug-\/in\textquotesingle{}s output stem format. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+Stem\+Format} & The current output stem format \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a01a96e488251716cfc236551b9f9a2fb}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_ad50aa6fd54e39623a58debd63d9551e1}\label{a02222_ad50aa6fd54e39623a58debd63d9551e1}} 
\index{AAX\_IController@{AAX\_IController}!GetSignalLatency@{GetSignalLatency}}
\index{GetSignalLatency@{GetSignalLatency}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetSignalLatency()}{GetSignalLatency()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Signal\+Latency (\begin{DoxyParamCaption}\item[{int32\+\_\+t $\ast$}]{out\+Samples }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Returns the most recent signal (algorithmic) latency that has been published by the plug-\/in. 

This method provides the most recently published signal latency. The host may not have updated its delay compensation to match this signal latency yet, so plug-\/ins that dynamically change their latency using \mbox{\hyperlink{a02222_af2c648879419d94971c1308d8698601f}{Set\+Signal\+Latency()}} should always wait for an \mbox{\hyperlink{a00446_afab5ea2cfd731fc8f163b6caa685406ea06ab4b075ecb523d0dde3ec19b76a756}{AAX\+\_\+e\+Notification\+Event\+\_\+\+Signal\+Latency\+Changed}} notification before updating its algorithm to incur this latency.

\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02222_af2c648879419d94971c1308d8698601f}{Set\+Signal\+Latency()}}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+Samples} & The number of samples of signal delay published by the plug-\/in \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_ab73ab5f51350ae61a73542231948c81c}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a26e009667f9cd6c3cccd45b862108bf4}\label{a02222_a26e009667f9cd6c3cccd45b862108bf4}} 
\index{AAX\_IController@{AAX\_IController}!GetCycleCount@{GetCycleCount}}
\index{GetCycleCount@{GetCycleCount}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetCycleCount()}{GetCycleCount()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Cycle\+Count (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0d}{AAX\+\_\+\+EProperty}}}]{in\+Which\+Cycle\+Count,  }\item[{\mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} $\ast$}]{out\+Num\+Cycles }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: returns the plug-\/in\textquotesingle{}s current real-\/time DSP cycle count. 

This method provides the number of cycles that the AAX host expects the DSP plug-\/in to consume. The host uses this value when allocating DSP resources for the plug-\/in.

\begin{DoxyNote}{Note}
A plug-\/in should never apply a DSP algorithm with more demanding resource requirements than what is currently accounted for by the host. To set a higher cycle count value, a plug-\/in must call \mbox{\hyperlink{a02222_a1a654f682357d48bafd506cbbea2ae25}{AAX\+\_\+\+IController\+::\+Set\+Cycle\+Count()}}, then poll \mbox{\hyperlink{a02222_a26e009667f9cd6c3cccd45b862108bf4}{AAX\+\_\+\+IController\+::\+Get\+Cycle\+Count()}} until the new value has been applied. Once the host has recognized the new cycle count value, the plug-\/in may apply the more demanding algorithm.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Which\+Cycle\+Count} & Selector for the requested cycle count metric. One of\+: \begin{DoxyItemize}
\item \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da3e5b289333ba49f5a33de40d89fa4ade}{AAX\+\_\+e\+Property\+\_\+\+TI\+\_\+\+Shared\+Cycle\+Count}} \item \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da5d8e5be9f3698a9c67a578c29da66405}{AAX\+\_\+e\+Property\+\_\+\+TI\+\_\+\+Instance\+Cycle\+Count}} \item \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da5b85e213113b7f0f7ee4bac4f5eaa59d}{AAX\+\_\+e\+Property\+\_\+\+TI\+\_\+\+Max\+Instances\+Per\+Chip}} \end{DoxyItemize}
\\
\hline
\mbox{\texttt{ in}}  & {\em out\+Num\+Cycles} & The current value of the selected cycle count metric\\
\hline
\end{DoxyParams}
\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000046}{Todo}}]PLACEHOLDER -\/ NOT CURRENTLY IMPLEMENTED IN HOST \end{DoxyRefDesc}


Implemented in \mbox{\hyperlink{a02378_aa3a0f0060f70e8167634daf6beadeae5}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_afbc2973d755b6c3ae82b6c8461e9fdee}\label{a02222_afbc2973d755b6c3ae82b6c8461e9fdee}} 
\index{AAX\_IController@{AAX\_IController}!GetTODLocation@{GetTODLocation}}
\index{GetTODLocation@{GetTODLocation}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetTODLocation()}{GetTODLocation()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+TODLocation (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a46542a1dcccdcc3b4260a9926edf8a2a}{AAX\+\_\+\+CTime\+Of\+Day}} $\ast$}]{out\+TODLocation }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Returns the current Time Of Day (TOD) of the system. 

This method provides a plug-\/in the TOD (in samples) of the current system. TOD is the number of samples that the playhead has traversed since the beginning of playback.

\begin{DoxyNote}{Note}
The TOD value is the immediate value of the audio engine playhead. This value is incremented within the audio engine\textquotesingle{}s real-\/time rendering context; it is not synchronized with non-\/real-\/time calls to plug-\/in interface methods.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+TODLocation} & The current Time Of Day as set by the host \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a9ae44bc7589edb872e8194099b575afd}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_af2c648879419d94971c1308d8698601f}\label{a02222_af2c648879419d94971c1308d8698601f}} 
\index{AAX\_IController@{AAX\_IController}!SetSignalLatency@{SetSignalLatency}}
\index{SetSignalLatency@{SetSignalLatency}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{SetSignalLatency()}{SetSignalLatency()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Set\+Signal\+Latency (\begin{DoxyParamCaption}\item[{int32\+\_\+t}]{in\+Num\+Samples }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Submits a request to change the delay compensation value that the host uses to account for the plug-\/in\textquotesingle{}s signal (algorithmic) latency. 

This method is used to request a change in the number of samples that the AAX host expects the plug-\/in to delay a signal.

The host is not guaranteed to immediately apply the new latency value. A plug-\/in should avoid incurring an actual algorithmic latency that is different than the latency accounted for by the host.

To set a new latency value, a plug-\/in must call \mbox{\hyperlink{a02222_af2c648879419d94971c1308d8698601f}{AAX\+\_\+\+IController\+::\+Set\+Signal\+Latency()}}, then wait for an \mbox{\hyperlink{a00446_afab5ea2cfd731fc8f163b6caa685406ea06ab4b075ecb523d0dde3ec19b76a756}{AAX\+\_\+e\+Notification\+Event\+\_\+\+Signal\+Latency\+Changed}} notification. Once this notification has been received, \mbox{\hyperlink{a02222_ad50aa6fd54e39623a58debd63d9551e1}{AAX\+\_\+\+IController\+::\+Get\+Signal\+Latency()}} will reflect the updated latency value and the plug-\/in should immediately apply any relevant algorithmic changes that alter its latency to this new value.

\begin{DoxyWarning}{Warning}
Parameters which affect the latency of a plug-\/in should not be made available for control through automation. This will result in audible glitches when delay compensation is adjusted while playing back automation for these parameters.
\end{DoxyWarning}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Num\+Samples} & The number of samples of signal delay that the plug-\/in requests to incur \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a6b4b924c94871b76a3bfdc7697384722}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a1a654f682357d48bafd506cbbea2ae25}\label{a02222_a1a654f682357d48bafd506cbbea2ae25}} 
\index{AAX\_IController@{AAX\_IController}!SetCycleCount@{SetCycleCount}}
\index{SetCycleCount@{SetCycleCount}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{SetCycleCount()}{SetCycleCount()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Set\+Cycle\+Count (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0d}{AAX\+\_\+\+EProperty}} $\ast$}]{in\+Which\+Cycle\+Counts,  }\item[{\mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} $\ast$}]{i\+Values,  }\item[{int32\+\_\+t}]{num\+Values }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Indicates a change in the plug-\/in\textquotesingle{}s real-\/time DSP cycle count. 

This method is used to request a change in the number of cycles that the AAX host expects the DSP plug-\/in to consume.

\begin{DoxyNote}{Note}
A plug-\/in should never apply a DSP algorithm with more demanding resource requirements than what is currently accounted for by the host. To set a higher cycle count value, a plug-\/in must call \mbox{\hyperlink{a02222_a1a654f682357d48bafd506cbbea2ae25}{AAX\+\_\+\+IController\+::\+Set\+Cycle\+Count()}}, then poll \mbox{\hyperlink{a02222_a26e009667f9cd6c3cccd45b862108bf4}{AAX\+\_\+\+IController\+::\+Get\+Cycle\+Count()}} until the new value has been applied. Once the host has recognized the new cycle count value, the plug-\/in may apply the more demanding algorithm.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Which\+Cycle\+Counts} & Array of selectors indicating the specific cycle count metrics that should be set. Each selector must be one of\+: \begin{DoxyItemize}
\item \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da3e5b289333ba49f5a33de40d89fa4ade}{AAX\+\_\+e\+Property\+\_\+\+TI\+\_\+\+Shared\+Cycle\+Count}} \item \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da5d8e5be9f3698a9c67a578c29da66405}{AAX\+\_\+e\+Property\+\_\+\+TI\+\_\+\+Instance\+Cycle\+Count}} \item \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da5b85e213113b7f0f7ee4bac4f5eaa59d}{AAX\+\_\+e\+Property\+\_\+\+TI\+\_\+\+Max\+Instances\+Per\+Chip}} \end{DoxyItemize}
\\
\hline
\mbox{\texttt{ in}}  & {\em i\+Values} & An array of values requested, one for each of the selected cycle count metrics. \\
\hline
\mbox{\texttt{ in}}  & {\em num\+Values} & The size of {\ttfamily i\+Values} \\
\hline
\end{DoxyParams}
\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{a00878__todo000047}{Todo}}]PLACEHOLDER -\/ NOT CURRENTLY IMPLEMENTED IN HOST \end{DoxyRefDesc}


Implemented in \mbox{\hyperlink{a02378_ab0cd458b66e319fd14c2f1a17c7b678f}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_ae5dd2b5925dbc181513bca1c4ac5e716}\label{a02222_ae5dd2b5925dbc181513bca1c4ac5e716}} 
\index{AAX\_IController@{AAX\_IController}!PostPacket@{PostPacket}}
\index{PostPacket@{PostPacket}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{PostPacket()}{PostPacket()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Post\+Packet (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}}}]{in\+Field\+Index,  }\item[{const void $\ast$}]{in\+PayloadP,  }\item[{uint32\+\_\+t}]{in\+Payload\+Size }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Posts a data packet to the host for routing between plug-\/in components. 

The posted packet is identified with a \mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} packet index value, which is equivalent to the target data port\textquotesingle{}s identifier. The packet\textquotesingle{}s payload must have the expected size for the given packet index / data port, as defined when the port is created in \mbox{\hyperlink{a00889}{Describe}}. See \mbox{\hyperlink{a02214_a230293b9f6bb413626cd487ca501df75}{AAX\+\_\+\+IComponent\+Descriptor\+::\+Add\+Data\+In\+Port()}}.

\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{DoxyNote}{Note}
All calls to this method should be made within the scope of \mbox{\hyperlink{a02066_a083265b008921b6114ede387711694b7}{AAX\+\_\+\+IEffect\+Parameters\+::\+Generate\+Coefficients()}}. Calls from outside this method may result in packets not being delivered. See \mbox{\hyperlink{a00942_PT-206161}{PT-\/206161}}
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Field\+Index} & The packet\textquotesingle{}s destination port \\
\hline
\mbox{\texttt{ in}}  & {\em in\+PayloadP} & A pointer to the packet\textquotesingle{}s payload data \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Payload\+Size} & The size, in bytes, of the payload data \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a30fc3c2b59094709ff2f143aac3c2239}{AAX\+\_\+\+VController}}.



Referenced by \mbox{\hyperlink{a02462_a626cb2aaa68c64238298acfd6db448f5}{AAX\+\_\+\+CMonolithic\+Parameters\+::\+Generate\+Coefficients()}}.

Here is the caller graph for this function\+:
% FIG 1
\mbox{\Hypertarget{a02222_a0384f820cecf8cf7671057060bf5ba4f}\label{a02222_a0384f820cecf8cf7671057060bf5ba4f}} 
\index{AAX\_IController@{AAX\_IController}!SendNotification@{SendNotification}}
\index{SendNotification@{SendNotification}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{SendNotification()}{SendNotification()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Send\+Notification (\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]}}



CALL\+: Dispatch a notification. 

The notification is handled by the host and may be delivered back to other plug-\/in components such as the GUI or data model (via \mbox{\hyperlink{a02062_a11a15162cb3c7019d1fabf2994fba6c6}{AAX\+\_\+\+IEffect\+GUI\+::\+Notification\+Received()}} or \mbox{\hyperlink{a02066_aa3eaeb292d2ca84086a5a058171994fd}{AAX\+\_\+\+IEffect\+Parameters\+::\+Notification\+Received()}}, respectively) depending on the notification type.

The host may choose to dispatch the posted notification either synchronously or asynchronously.

See the \mbox{\hyperlink{a00446_afab5ea2cfd731fc8f163b6caa685406e}{AAX\+\_\+\+ENotification\+Event}} documentation for more information.

This method is supported by AAX V2 Hosts only. Check the return code on the return of this function. If the error is \mbox{\hyperlink{a00539_a5f8c7439f3a706c4f8315a9609811937a3b76994b32b97fcd56b19ef8032245df}{AAX\+\_\+\+ERROR\+\_\+\+UNIMPLEMENTED}}, your plug-\/in is being loaded into a host that doesn\textquotesingle{}t support this feature.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Notification\+Type} & Type of notification to send \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Notification\+Data} & Block of 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{a02378_aea3105179d5ecba7bb73f5ca1c1cde3e}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_ad98d549cc7bec4039ce174438d46d5db}\label{a02222_ad98d549cc7bec4039ce174438d46d5db}} 
\index{AAX\_IController@{AAX\_IController}!SendNotification@{SendNotification}}
\index{SendNotification@{SendNotification}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{SendNotification()}{SendNotification()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Send\+Notification (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{in\+Notification\+Type }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Sends an event to the GUI (no payload) 

This version of the notification method is a convenience for notifications which do not take any payload data. Internally, it simply calls \mbox{\hyperlink{a02222_a0384f820cecf8cf7671057060bf5ba4f}{AAX\+\_\+\+IController\+::\+Send\+Notification(\+AAX\+\_\+\+CType\+ID, const void$\ast$, uint32\+\_\+t)}} with a null payload.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Notification\+Type} & Type of notification to send \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_adec6441f066dd304f04f9ee4d3b041b4}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a13de9cc4bb7fb3848fbe12622c033135}\label{a02222_a13de9cc4bb7fb3848fbe12622c033135}} 
\index{AAX\_IController@{AAX\_IController}!GetCurrentMeterValue@{GetCurrentMeterValue}}
\index{GetCurrentMeterValue@{GetCurrentMeterValue}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetCurrentMeterValue()}{GetCurrentMeterValue()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Current\+Meter\+Value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{in\+Meter\+ID,  }\item[{float $\ast$}]{out\+Meter\+Value }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the current value of a host-\/managed plug-\/in meter. 


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


Implemented in \mbox{\hyperlink{a02378_adc873027ab5a8431a96a39497a1f0f0f}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a85db3824256005c97689925750103765}\label{a02222_a85db3824256005c97689925750103765}} 
\index{AAX\_IController@{AAX\_IController}!GetMeterPeakValue@{GetMeterPeakValue}}
\index{GetMeterPeakValue@{GetMeterPeakValue}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetMeterPeakValue()}{GetMeterPeakValue()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Meter\+Peak\+Value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{in\+Meter\+ID,  }\item[{float $\ast$}]{out\+Meter\+Peak\+Value }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the currently held peak value of a host-\/managed plug-\/in meter. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Meter\+ID} & ID of the meter that is being queried \\
\hline
\mbox{\texttt{ out}}  & {\em out\+Meter\+Peak\+Value} & The queried meter\textquotesingle{}s currently held peak value \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_ab6fb05f502b042b29f8aeaee28f185d1}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_aa8fe057d2f53109e75662da0a492fa34}\label{a02222_aa8fe057d2f53109e75662da0a492fa34}} 
\index{AAX\_IController@{AAX\_IController}!ClearMeterPeakValue@{ClearMeterPeakValue}}
\index{ClearMeterPeakValue@{ClearMeterPeakValue}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{ClearMeterPeakValue()}{ClearMeterPeakValue()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Clear\+Meter\+Peak\+Value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{in\+Meter\+ID }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Clears the peak value from a host-\/managed plug-\/in meter. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Meter\+ID} & ID of the meter that is being cleared \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a831e8acd4da78cccfd821892c82c9b96}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a3ad8e35bb6b51be934696c39a45157e7}\label{a02222_a3ad8e35bb6b51be934696c39a45157e7}} 
\index{AAX\_IController@{AAX\_IController}!GetMeterCount@{GetMeterCount}}
\index{GetMeterCount@{GetMeterCount}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetMeterCount()}{GetMeterCount()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Meter\+Count (\begin{DoxyParamCaption}\item[{uint32\+\_\+t $\ast$}]{out\+Meter\+Count }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the number of host-\/managed meters registered by a plug-\/in. 

See \mbox{\hyperlink{a02214_a5e4a61afa3d6510891e16d7179bdaa64}{AAX\+\_\+\+IComponent\+Descriptor\+::\+Add\+Meters()}}.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+Meter\+Count} & The number of registered plug-\/in meters. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_ac80621fb72de960d43f425d388928c3f}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a1f07fa44cd8b3c4fddee9c0b78d35bbd}\label{a02222_a1f07fa44cd8b3c4fddee9c0b78d35bbd}} 
\index{AAX\_IController@{AAX\_IController}!GetMeterClipped@{GetMeterClipped}}
\index{GetMeterClipped@{GetMeterClipped}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetMeterClipped()}{GetMeterClipped()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Meter\+Clipped (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{in\+Meter\+ID,  }\item[{\mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}} $\ast$}]{out\+Clipped }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves the clipped flag from a host-\/managed plug-\/in meter. 

See \mbox{\hyperlink{a02214_a5e4a61afa3d6510891e16d7179bdaa64}{AAX\+\_\+\+IComponent\+Descriptor\+::\+Add\+Meters()}}.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Meter\+ID} & ID of the meter that is being queried. \\
\hline
\mbox{\texttt{ out}}  & {\em out\+Clipped} & The queried meter\textquotesingle{}s clipped flag. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a2bad61c587f08fc3f99ac297934ad4f9}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a2c989b51cd74e0ce0319baf6d1c82465}\label{a02222_a2c989b51cd74e0ce0319baf6d1c82465}} 
\index{AAX\_IController@{AAX\_IController}!ClearMeterClipped@{ClearMeterClipped}}
\index{ClearMeterClipped@{ClearMeterClipped}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{ClearMeterClipped()}{ClearMeterClipped()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Clear\+Meter\+Clipped (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\+\_\+\+CType\+ID}}}]{in\+Meter\+ID }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Clears the clipped flag from a host-\/managed plug-\/in meter. 

See \mbox{\hyperlink{a02214_a5e4a61afa3d6510891e16d7179bdaa64}{AAX\+\_\+\+IComponent\+Descriptor\+::\+Add\+Meters()}}.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Meter\+ID} & ID of the meter that is being cleared. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_ae09f0c6554d9cce7b9a4ee5b01aa9d70}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a2896ba3a1ed86ce2813b1736d316d275}\label{a02222_a2896ba3a1ed86ce2813b1736d316d275}} 
\index{AAX\_IController@{AAX\_IController}!GetNextMIDIPacket@{GetNextMIDIPacket}}
\index{GetNextMIDIPacket@{GetNextMIDIPacket}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetNextMIDIPacket()}{GetNextMIDIPacket()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Next\+MIDIPacket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ae807f8986143820cfb5d6da32165c9c7}{AAX\+\_\+\+CField\+Index}} $\ast$}]{out\+Port,  }\item[{\mbox{\hyperlink{a01790}{AAX\+\_\+\+CMidi\+Packet}} $\ast$}]{out\+Packet }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Retrieves MIDI packets for described MIDI nodes. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+Port} & port ID of the MIDI node that has unhandled packet \\
\hline
\mbox{\texttt{ out}}  & {\em out\+Packet} & The MIDI packet \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a4e47302a86a1494ff21d44a024ae0086}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_af9ab9b228023e116f89249a56c27a20f}\label{a02222_af9ab9b228023e116f89249a56c27a20f}} 
\index{AAX\_IController@{AAX\_IController}!GetCurrentAutomationTimestamp@{GetCurrentAutomationTimestamp}}
\index{GetCurrentAutomationTimestamp@{GetCurrentAutomationTimestamp}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetCurrentAutomationTimestamp()}{GetCurrentAutomationTimestamp()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Current\+Automation\+Timestamp (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ac09cd6857748cc296ac0f8bcc20dc74b}{AAX\+\_\+\+CTransport\+Counter}} $\ast$}]{out\+Timestamp }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Returns the current automation timestamp if called during the \mbox{\hyperlink{a02066_a083265b008921b6114ede387711694b7}{Generate\+Coefficients()}} call AND the generation of coefficients is being triggered by an automation point instead of immediate changes. 

\begin{DoxyNote}{Note}
This function will return 0 if called from outside of \mbox{\hyperlink{a02066_a083265b008921b6114ede387711694b7}{Generate\+Coefficients()}} or if the \mbox{\hyperlink{a02066_a083265b008921b6114ede387711694b7}{Generate\+Coefficients()}} call was initiated due to a non-\/automated change. In those cases, you can get your sample offset from the transport start using \mbox{\hyperlink{a02222_afbc2973d755b6c3ae82b6c8461e9fdee}{Get\+TODLocation()}}.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+Timestamp} & The current coefficient timestamp. Sample count from transport start. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_affb116c9d90b03aa974ad238d4690e22}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_ad2a002a133491b2ed572054588641e78}\label{a02222_ad2a002a133491b2ed572054588641e78}} 
\index{AAX\_IController@{AAX\_IController}!GetHostName@{GetHostName}}
\index{GetHostName@{GetHostName}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetHostName()}{GetHostName()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Host\+Name (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$}]{out\+Host\+Name\+String }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Returns name of the host application this plug-\/in instance is being loaded by. This string also typically includes version information. 

\begin{DoxyRefDesc}{Host Compatibility Notes}
\item[\mbox{\hyperlink{a00879__compatibility_notes000055}{Host Compatibility Notes}}]Pro Tools versions from Pro Tools 11.\+0 to Pro Tools 12.\+3.\+1 will return a generic version string to this call. This issue is resolved beginning in Pro Tools 12.\+4.\end{DoxyRefDesc}



\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+Host\+Name\+String} & The name of the current host application. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a085af48887bdd2eeb8d498b23ad236f9}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a8326b2acec2d9c9039853adafd9b2bef}\label{a02222_a8326b2acec2d9c9039853adafd9b2bef}} 
\index{AAX\_IController@{AAX\_IController}!GetPlugInTargetPlatform@{GetPlugInTargetPlatform}}
\index{GetPlugInTargetPlatform@{GetPlugInTargetPlatform}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetPlugInTargetPlatform()}{GetPlugInTargetPlatform()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Plug\+In\+Target\+Platform (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_a8f2cefa455217fa9f3ce190fe5fd8033}{AAX\+\_\+\+CTarget\+Platform}} $\ast$}]{out\+Target\+Platform }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Returns execution platform type, native or TI. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+Target\+Platform} & The type of the current execution platform as one of \mbox{\hyperlink{a00446_a19e8cc27f59bb9bb4039b00fadb3cb83}{AAX\+\_\+\+ETarget\+Platform}}. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_abb34f17e64d4e50ac8cabf8f47639994}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_af6d44bc336c3c2e4cca1a1684b556db3}\label{a02222_af6d44bc336c3c2e4cca1a1684b556db3}} 
\index{AAX\_IController@{AAX\_IController}!GetIsAudioSuite@{GetIsAudioSuite}}
\index{GetIsAudioSuite@{GetIsAudioSuite}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{GetIsAudioSuite()}{GetIsAudioSuite()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IController\+::\+Get\+Is\+Audio\+Suite (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}} $\ast$}]{out\+Is\+Audio\+Suite }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



CALL\+: Returns true for Audio\+Suite instances. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em out\+Is\+Audio\+Suite} & The boolean flag which indicate true for Audio\+Suite instances. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a3d3bd957f2b2f863333deadf5b8e6c6c}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_adfa3039472002a1df22d11607529ccf2}\label{a02222_adfa3039472002a1df22d11607529ccf2}} 
\index{AAX\_IController@{AAX\_IController}!CreateTableCopyForEffect@{CreateTableCopyForEffect}}
\index{CreateTableCopyForEffect@{CreateTableCopyForEffect}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{CreateTableCopyForEffect()}{CreateTableCopyForEffect()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a02294}{AAX\+\_\+\+IPage\+Table}} $\ast$ AAX\+\_\+\+IController\+::\+Create\+Table\+Copy\+For\+Effect (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}}}]{in\+Manufacturer\+ID,  }\item[{\mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}}}]{in\+Product\+ID,  }\item[{\mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}}}]{in\+Plug\+In\+ID,  }\item[{uint32\+\_\+t}]{in\+Table\+Type,  }\item[{int32\+\_\+t}]{in\+Table\+Page\+Size }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Copy the current page table data for a particular plug-\/in type. 

The host may restrict plug-\/ins to only copying page table data from certain plug-\/in types, such as plug-\/ins from the same manufacturer or plug-\/in types within the same effect.

See \mbox{\hyperlink{a00929}{Page Table Guide}} for more information about page tables.

\begin{DoxyReturn}{Returns}
A new page table object to which the requested page table data has been copied. Ownership of this object passes to the caller.

a null pointer if the requested plug-\/in type is unknown, if {\ttfamily in\+Table\+Type} is unknown or if {\ttfamily in\+Table\+Page\+Size} is not a supported size for the given table type.
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Manufacturer\+ID} & \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da996465cca29a2a15291d1c788ac5728c}{Manufacturer ID}} of the desired plug-\/in type \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Product\+ID} & \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da3a41fcdff5af1a4fd19dcbca7b1ba6f3}{Product ID}} of the desired plug-\/in type \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Plug\+In\+ID} & Type ID of the desired plug-\/in type (\mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da89ca3dd6e96895cda14976c1b1ceb826}{AAX\+\_\+e\+Property\+\_\+\+Plug\+In\+ID\+\_\+\+Native}}, \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da75f174df4efbeca86eaada126c1d9214}{AAX\+\_\+e\+Property\+\_\+\+Plug\+In\+ID\+\_\+\+TI}}) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Type} & Four-\/char type identifier for the requested table type (e.\+g. {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}}, {\ttfamily \textquotesingle{}Av81\textquotesingle{}}, etc.) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Page\+Size} & Page size for the requested table. Some tables support multiple page sizes. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a19d0806fde78eab0f47deb4ad192ffca}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a1ff3a32980181232312409794b206ef7}\label{a02222_a1ff3a32980181232312409794b206ef7}} 
\index{AAX\_IController@{AAX\_IController}!CreateTableCopyForLayout@{CreateTableCopyForLayout}}
\index{CreateTableCopyForLayout@{CreateTableCopyForLayout}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{CreateTableCopyForLayout()}{CreateTableCopyForLayout()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a02294}{AAX\+\_\+\+IPage\+Table}} $\ast$ AAX\+\_\+\+IController\+::\+Create\+Table\+Copy\+For\+Layout (\begin{DoxyParamCaption}\item[{const char $\ast$}]{in\+Effect\+ID,  }\item[{const char $\ast$}]{in\+Layout\+Name,  }\item[{uint32\+\_\+t}]{in\+Table\+Type,  }\item[{int32\+\_\+t}]{in\+Table\+Page\+Size }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Copy the current page table data for a particular plug-\/in effect and page table layout. 

The host may restrict plug-\/ins to only copying page table data from certain effects, such as effects registered within the current \mbox{\hyperlink{a00948}{AAX}} plug-\/in bundle.

See \mbox{\hyperlink{a00929}{Page Table Guide}} for more information about page tables.

\begin{DoxyReturn}{Returns}
A new page table object to which the requested page table data has been copied. Ownership of this object passes to the caller.

a null pointer if the requested effect ID is unknown or if {\ttfamily in\+Layout\+Name} is not a valid layout name for the page tables registered for the effect.
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Effect\+ID} & Effect ID for the desired effect. See \mbox{\hyperlink{a02210_a5ff114b8c4da2081515186f2faf65c8c}{AAX\+\_\+\+ICollection\+::\+Add\+Effect()}} \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Layout\+Name} & Page table layout name (\char`\"{}name\char`\"{} attribute of the {\ttfamily PTLayout} XML tag) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Type} & Four-\/char type identifier for the requested table type (e.\+g. {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}}, {\ttfamily \textquotesingle{}Av81\textquotesingle{}}, etc.) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Page\+Size} & Page size for the requested table. Some tables support multiple page sizes. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a0ca0b4cdbf32ee2ba2c6c73f3ed9d9b3}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a83404c4126395a0f449bd015fda38273}\label{a02222_a83404c4126395a0f449bd015fda38273}} 
\index{AAX\_IController@{AAX\_IController}!CreateTableCopyForEffectFromFile@{CreateTableCopyForEffectFromFile}}
\index{CreateTableCopyForEffectFromFile@{CreateTableCopyForEffectFromFile}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{CreateTableCopyForEffectFromFile()}{CreateTableCopyForEffectFromFile()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a02294}{AAX\+\_\+\+IPage\+Table}} $\ast$ AAX\+\_\+\+IController\+::\+Create\+Table\+Copy\+For\+Effect\+From\+File (\begin{DoxyParamCaption}\item[{const char $\ast$}]{in\+Page\+Table\+File\+Path,  }\item[{\mbox{\hyperlink{a00446_a8152e57310850693e4e7f00fc4922d74}{AAX\+\_\+\+EText\+Encoding}}}]{in\+File\+Path\+Encoding,  }\item[{\mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}}}]{in\+Manufacturer\+ID,  }\item[{\mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}}}]{in\+Product\+ID,  }\item[{\mbox{\hyperlink{a00542_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}}}]{in\+Plug\+In\+ID,  }\item[{uint32\+\_\+t}]{in\+Table\+Type,  }\item[{int32\+\_\+t}]{in\+Table\+Page\+Size }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Copy the current page table data for a particular plug-\/in type.   

\begin{DoxyReturn}{Returns}
A new page table object to which the requested page table data has been copied. Ownership of this object passes to the caller.

a null pointer if the requested plug-\/in type is unkown, if {\ttfamily in\+Table\+Type} is unknown or if {\ttfamily in\+Table\+Page\+Size} is not a supported size for the given table type.
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Page\+Table\+File\+Path} & Path to XML page table file. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+File\+Path\+Encoding} & File path text encoding. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Manufacturer\+ID} & \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da996465cca29a2a15291d1c788ac5728c}{Manufacturer ID}} of the desired plug-\/in type \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Product\+ID} & \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da3a41fcdff5af1a4fd19dcbca7b1ba6f3}{Product ID}} of the desired plug-\/in type \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Plug\+In\+ID} & Type ID of the desired plug-\/in type (\mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da89ca3dd6e96895cda14976c1b1ceb826}{AAX\+\_\+e\+Property\+\_\+\+Plug\+In\+ID\+\_\+\+Native}}, \mbox{\hyperlink{a00608_a13e384f22825afd3db6d68395b79ce0da75f174df4efbeca86eaada126c1d9214}{AAX\+\_\+e\+Property\+\_\+\+Plug\+In\+ID\+\_\+\+TI}}) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Type} & Four-\/char type identifier for the requested table type (e.\+g. {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}}, {\ttfamily \textquotesingle{}Av81\textquotesingle{}}, etc.) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Page\+Size} & Page size for the requested table. Some tables support multiple page sizes. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a63547bb0f02c9e62084192f533eee5e9}{AAX\+\_\+\+VController}}.

\mbox{\Hypertarget{a02222_a63513a230f629cbc912283c9281b196b}\label{a02222_a63513a230f629cbc912283c9281b196b}} 
\index{AAX\_IController@{AAX\_IController}!CreateTableCopyForLayoutFromFile@{CreateTableCopyForLayoutFromFile}}
\index{CreateTableCopyForLayoutFromFile@{CreateTableCopyForLayoutFromFile}!AAX\_IController@{AAX\_IController}}
\doxysubsubsection{\texorpdfstring{CreateTableCopyForLayoutFromFile()}{CreateTableCopyForLayoutFromFile()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a02294}{AAX\+\_\+\+IPage\+Table}} $\ast$ AAX\+\_\+\+IController\+::\+Create\+Table\+Copy\+For\+Layout\+From\+File (\begin{DoxyParamCaption}\item[{const char $\ast$}]{in\+Page\+Table\+File\+Path,  }\item[{\mbox{\hyperlink{a00446_a8152e57310850693e4e7f00fc4922d74}{AAX\+\_\+\+EText\+Encoding}}}]{in\+File\+Path\+Encoding,  }\item[{const char $\ast$}]{in\+Layout\+Name,  }\item[{uint32\+\_\+t}]{in\+Table\+Type,  }\item[{int32\+\_\+t}]{in\+Table\+Page\+Size }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Copy the current page table data for a particular plug-\/in effect and page table layout.   

\begin{DoxyReturn}{Returns}
A new page table object to which the requested page table data has been copied. Ownership of this object passes to the caller.

a null pointer if {\ttfamily in\+Layout\+Name} is not a valid layout name for the page tables file.
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Page\+Table\+File\+Path} & Path to XML page table file. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+File\+Path\+Encoding} & File path text encoding. \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Layout\+Name} & Page table layout name (\char`\"{}name\char`\"{} attribute of the {\ttfamily PTLayout} XML tag) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Type} & Four-\/char type identifier for the requested table type (e.\+g. {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}}, {\ttfamily \textquotesingle{}Av81\textquotesingle{}}, etc.) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Page\+Size} & Page size for the requested table. Some tables support multiple page sizes. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{a02378_a8ac54e7b396b0930afe6df95960a42d3}{AAX\+\_\+\+VController}}.



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