The PluginHostConnector implements the IPluginHostConnector interface for the plugin shell object. For AAX, this requires implementing only one method, sendHostMessage( ). Only one message is processed for sendGUIUpdate that provides a mechanism to update the GUI controls from the plugin core. Note that this is not an ideal solution for most problems (e.g. linking controls together intelligently) – you should always consider using a custom sub-controller and/or custom view to do this properly. On occasion, a more difficult scenario may arise (e.g. MIDI learn button, that must wait for user input from a MIDI instrument to toggle states) where the sendGUIUpdate method may be appropriate. See the example in the ASPiK SDK for more information. More...
#include <AAXPluginParameters.h>
Public Member Functions | |
| PluginHostConnector (AAX_IEffectParameters *_aaxParameters) | |
| virtual void | sendHostMessage (const HostMessageInfo &hostMessageInfo) |
| process a message; by default it processes sendGUIUpdate to safely send a parameter change event but you can add your own custom message processing here (be careful) | |
| PluginHostConnector (AUFXPlugin *_auInstance) | |
| virtual void | sendHostMessage (const HostMessageInfo &hostMessageInfo) |
| process a message; by default it processes sendGUIUpdate to safely send a parameter change event but you can add your own custom message processing here (be careful) | |
| PluginHostConnector (AUSynthPlugin *_auInstance) | |
| virtual void | sendHostMessage (const HostMessageInfo &hostMessageInfo) |
| process a message; by default it processes sendGUIUpdate to safely send a parameter change event but you can add your own custom message processing here (be careful) | |
| virtual void | sendHostMessage (const HostMessageInfo &hostMessageInfo)=0 |
Protected Attributes | |
| AAX_IEffectParameters * | aaxParameters |
| parent parameters; lifelong existence | |
| AUFXPlugin * | auInstance = nullptr |
| our plugin object for setAUParameterChangeEvent() | |
| AUSynthPlugin * | auInstance = nullptr |
| our plugin object for setAUParameterChangeEvent() | |
Detailed Description
The PluginHostConnector implements the IPluginHostConnector interface for the plugin shell object. For AAX, this requires implementing only one method, sendHostMessage( ). Only one message is processed for sendGUIUpdate that provides a mechanism to update the GUI controls from the plugin core. Note that this is not an ideal solution for most problems (e.g. linking controls together intelligently) – you should always consider using a custom sub-controller and/or custom view to do this properly. On occasion, a more difficult scenario may arise (e.g. MIDI learn button, that must wait for user input from a MIDI instrument to toggle states) where the sendGUIUpdate method may be appropriate. See the example in the ASPiK SDK for more information.
The PluginHostConnector implements the IPluginHostConnector interface for the plugin shell object. For AU, this requires implementing only one method, sendHostMessage( ). Only one message is processed for sendGUIUpdate that provides a mechanism to update the GUI controls from the plugin core. Note that this is not an ideal solution for most problems (e.g. linking controls together intelligently) – you should always consider using a custom sub-controller and/or custom view to do this properly. On occasion, a more difficult scenario may arise (e.g. MIDI learn button, that must wait for user input from a MIDI instrument to toggle states) where the sendGUIUpdate method may be appropriate. See the example in the ASPiK SDK for more information.
- Remarks
- This object is included in ASPiK
- Version
- Revision : 1.0
- Date
- Date : 2018 / 09 / 7
- Remarks
- This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle
- Version
- Revision : 1.0
- Date
- Date : 2018 / 09 / 7
- Remarks
- This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle
- Version
- Revision : 1.0
- Date
- Date : 2018 / 09 / 7
Member Function Documentation
◆ sendHostMessage() [1/3]
|
inlinevirtual |
process a message; by default it processes sendGUIUpdate to safely send a parameter change event but you can add your own custom message processing here (be careful)
- Parameters
-
hostMessageInfo custom structure with message information; for sendGUIUpdate the message data arrives in the hostMessageInfo.guiUpdateData list; the function iterates over the list and sets AAX parameters with a thread-safe function specifically for external set-operations like this.
Implements IPluginHostConnector.
◆ sendHostMessage() [2/3]
|
inlinevirtual |
process a message; by default it processes sendGUIUpdate to safely send a parameter change event but you can add your own custom message processing here (be careful)
- Parameters
-
hostMessageInfo custom structure with message information; for sendGUIUpdate the message data arrives in the hostMessageInfo.guiUpdateData list; the function iterates over the list and sends AU parameter change events.
Implements IPluginHostConnector.
◆ sendHostMessage() [3/3]
|
inlinevirtual |
process a message; by default it processes sendGUIUpdate to safely send a parameter change event but you can add your own custom message processing here (be careful)
- Parameters
-
hostMessageInfo custom structure with message information; for sendGUIUpdate the message data arrives in the hostMessageInfo.guiUpdateData list; the function iterates over the list and sends AU parameter change events.
Implements IPluginHostConnector.
The documentation for this class was generated from the following files:
- C:/RackAFX_v7/ASPIK_Doxygen/PluginTemplate/project_source/source/aax_source/AAXPluginParameters.h
- C:/RackAFX_v7/ASPIK_Doxygen/PluginTemplate/project_source/source/au_source/aufxplugin.h
- C:/RackAFX_v7/ASPIK_Doxygen/PluginTemplate/project_source/source/au_source/ausynthplugin.h
