ASPiK SDK
Steinberg::Vst::ASPiK::PluginHostConnector Class Reference

The PluginHostConnector implements the IPluginHostConnector interface for the plugin shell object. For VST, 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 <vst3plugin.h>

Inheritance diagram for Steinberg::Vst::ASPiK::PluginHostConnector:
IPluginHostConnector IPluginHostConnector

Public Member Functions

 PluginHostConnector (VST3Plugin *_editController)
 
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) More...
 
 PluginHostConnector (VST3Plugin *_editController)
 
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) More...
 

Protected Attributes

VST3PlugineditController = nullptr
 our parent plugin
 

Detailed Description

The PluginHostConnector implements the IPluginHostConnector interface for the plugin shell object. For VST, 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.

Author
Will Pirkle http://www.willpirkle.com
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/2]

virtual void Steinberg::Vst::ASPiK::PluginHostConnector::sendHostMessage ( const HostMessageInfo hostMessageInfo)
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
hostMessageInfocustom 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() [2/2]

virtual void Steinberg::Vst::ASPiK::PluginHostConnector::sendHostMessage ( const HostMessageInfo hostMessageInfo)
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
hostMessageInfocustom 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 file: