\hypertarget{a02034}{}\doxysection{AAX\+\_\+\+IACFController\+\_\+\+V3 Class Reference}
\label{a02034}\index{AAX\_IACFController\_V3@{AAX\_IACFController\_V3}}


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



Inheritance diagram for AAX\+\_\+\+IACFController\+\_\+\+V3\+:
% FIG 0


Collaboration diagram for AAX\+\_\+\+IACFController\+\_\+\+V3\+:
% FIG 1


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

\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02034_af2f012ae8fec830e52c5fca54b555a7b}{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{a02034_a2511f4ddb2d0fd17f6f17fe8a6980add}{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}\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions inherited from \mbox{\hyperlink{a02030}{AAX\+\_\+\+IACFController\+\_\+\+V2}}}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02030_a83640488e70f990fcfeeeb400b80776b}{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{a02030_afe1844d38559c2e7f8b35a23219407e6}{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{a02030_a0a3bdcf203a721bed5d772b125052ec3}{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{a02030_aeac17aa11caa18994fb891109681d0d6}{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}\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions inherited from \mbox{\hyperlink{a02026}{AAX\+\_\+\+IACFController}}}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02026_ae1ccab17cf8b38ab415a7f097cb7d683}{Get\+Effect\+ID}} (\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} $\ast$out\+Effect\+ID) const =0
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02026_a434883281a90e7bfa7cfe20d941bfa9a}{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{a02026_ae2bdea915b0d7165afd000deb9d4defc}{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{a02026_a7d2a011577cf27d9e79f7537aa279bcb}{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{a02026_ae4a19f971e0884aee6802ef0b3e0a020}{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{a02026_a37c235cb6a27eab95686a009edeffabe}{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{a02026_af34fa72c0e4043d5746adcf54e2299d7}{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}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02026_aee931a52f15789d1b6a4e78cfd4f4961}{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{a02026_a452f047d471518a0ff5221887fd387df}{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}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02026_a5bb3178980788c00cc2fe17729b5bf7b}{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}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02026_a2010fae8eb08f24156ae2fc4a3698c9a}{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{a02026_aec42969d56720ac54290250bc45f89fb}{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{a02026_ae2bc5026d16796a8cb4294f1805302bc}{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{a02026_a69fa28a0887223cce230d8380945ecb5}{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{a02026_a93d824d7415416028b2a7d5561deab58}{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}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02026_aaf316786f9f280cd5711848eeeec3d99}{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{a02026_a6a5c0cdfbe314476bdfd15caaee8d010}{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}\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions inherited from \mbox{\hyperlink{a01770}{IACFUnknown}}}
\begin{DoxyCompactItemize}
\item 
virtual BEGIN\+\_\+\+ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE \mbox{\hyperlink{a01770_a8b7f0ae9c78d007ca76aa462ebe53135}{Query\+Interface}} (const \mbox{\hyperlink{a00308_a59df0b41744eee7a066787aaedf97f67}{acf\+IID}} \&iid, void $\ast$$\ast$pp\+Out)=0
\begin{DoxyCompactList}\small\item\em Returns pointers to supported interfaces. \end{DoxyCompactList}\item 
virtual acf\+UInt32 ACFMETHODCALLTYPE \mbox{\hyperlink{a01770_aa9c7a5b9dff341092b7b86bb9b3a58fb}{Add\+Ref}} (void)=0
\begin{DoxyCompactList}\small\item\em Increments reference count. \end{DoxyCompactList}\item 
virtual acf\+UInt32 ACFMETHODCALLTYPE \mbox{\hyperlink{a01770_afabd38cec0a9ed37f1d3e8644a70ac41}{Release}} (void)=0
\begin{DoxyCompactList}\small\item\em Decrements reference count. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{a02034_af2f012ae8fec830e52c5fca54b555a7b}\label{a02034_af2f012ae8fec830e52c5fca54b555a7b}} 
\index{AAX\_IACFController\_V3@{AAX\_IACFController\_V3}!GetPlugInTargetPlatform@{GetPlugInTargetPlatform}}
\index{GetPlugInTargetPlatform@{GetPlugInTargetPlatform}!AAX\_IACFController\_V3@{AAX\_IACFController\_V3}}
\doxysubsubsection{\texorpdfstring{GetPlugInTargetPlatform()}{GetPlugInTargetPlatform()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFController\+\_\+\+V3\+::\+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}
\mbox{\Hypertarget{a02034_a2511f4ddb2d0fd17f6f17fe8a6980add}\label{a02034_a2511f4ddb2d0fd17f6f17fe8a6980add}} 
\index{AAX\_IACFController\_V3@{AAX\_IACFController\_V3}!GetIsAudioSuite@{GetIsAudioSuite}}
\index{GetIsAudioSuite@{GetIsAudioSuite}!AAX\_IACFController\_V3@{AAX\_IACFController\_V3}}
\doxysubsubsection{\texorpdfstring{GetIsAudioSuite()}{GetIsAudioSuite()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFController\+\_\+\+V3\+::\+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}


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