ASPiK SDK
Loading...
Searching...
No Matches
VST-Shell

Classes

class  Steinberg::Vst::ASPiK::PeakParameter
 The PeakParameter object encapsulates a uni-polar parameter such as a metering variable. More...
 
class  Steinberg::Vst::ASPiK::LogParameter
 The LogParameter object encapsulates a log parameter. Note that the standard log potentiometer in electronics is actually anti-log! More...
 
class  Steinberg::Vst::ASPiK::AntiLogParameter
 The AntiLogParameter object encapsulates an anti-log parameter. Note that the standard log potentiometer in electronics is actually anti-log! More...
 
class  Steinberg::Vst::ASPiK::VoltOctaveParameter
 The VoltOctaveParameter object encapsulates a Volt-per-Octave parameter for emulating analog synthesizer controls. Also provide a smooth linear-in-octave control for any Frequency type of continuous control. More...
 
class  Steinberg::Vst::ASPiK::VST3Plugin
 The VST3Plugin object is the ASPiK plugin shell for the VST3 API. More...
 
class  Steinberg::Vst::ASPiK::VSTParamUpdateQueue
 The VSTParamUpdateQueue object maintains a parameter update queue for one ASPiK PluginParameter object. It is only used as part of the sample-accurate automation feature in ASPiK. More...
 
class  Steinberg::Vst::ASPiK::PluginHostConnector
 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...
 
class  Steinberg::Vst::ASPiK::GUIPluginConnector
 The GUIPluginConnector interface creates a safe message mechanism for the GUI to issue requests to the plugin shell. The following messages are processed via functions: More...
 
class  Steinberg::Vst::ASPiK::VSTMIDIEventQueue
 The VSTMIDIEventQueue interface queues incoming MIDI messages and blasts them out during the buffer processing phase. More...
 
class  Steinberg::Vst::ASPiK::VST3UpdateHandler
 Little update handler object for VST-approved GUI updating. More...
 
class  Steinberg::Vst::ASPiK::PluginEditor
 The VST GUI for the plugin. This is needed because VST3 requires an IPlugView GUI, which is VST3 specific (involves VST3 SDK files) More...
 

Functions

uint32_t Steinberg::Vst::ASPiK::getNumSupportedChannelFormats ()
 returns number of supported channel I/O combinations
 
 BEGIN_FACTORY_DEF (Steinberg::Vst::ASPiK::VST3Plugin::getVendorName(), Steinberg::Vst::ASPiK::VST3Plugin::getVendorURL(), Steinberg::Vst::ASPiK::VST3Plugin::getVendorEmail()) DEF_CLASS2(INLINE_UID_FROM_FUID((*(Steinberg
 VST macro for defining a VST plugin.
 
bool DeinitModule ()
 VST function called before module is un-loaded.
 

Variables

const unsigned int NUM_SUPPORTED_CHANNEL_FORMATS = 15
 number of supported channel I/O combinations
 
SpeakerArrangement Steinberg::Vst::ASPiK::speakerArrangements [NUM_SUPPORTED_CHANNEL_FORMATS]
 fixed array of supported VST3 speaker arrangements you can add more here if you want to support more channel arrangements; NOTE: these were chosen to match with AU and AAX channal I/O support.
 

Detailed Description

The VST plugin shell consists of the following files:

Function Documentation

◆ BEGIN_FACTORY_DEF()

VST macro for defining a VST plugin.

@DEF_CLASS2

  • see VST3 SDK Documentation for more details @InitModule

VST function called after module is loaded

  • see VST3 SDK Documentation for more details
  • used for initializing the VSTGUI4 library only

◆ DeinitModule()

bool DeinitModule ( )

VST function called before module is un-loaded.

@DeinitModule

  • see VST3 SDK Documentation for more details
  • used for exiting the VSTGUI4 library only

◆ getNumSupportedChannelFormats()

uint32_t Steinberg::Vst::ASPiK::getNumSupportedChannelFormats ( )

returns number of supported channel I/O combinations

@getNumSupportedChannelFormats

Variable Documentation

◆ NUM_SUPPORTED_CHANNEL_FORMATS

const unsigned int NUM_SUPPORTED_CHANNEL_FORMATS = 15

number of supported channel I/O combinations

@NUM_SUPPORTED_CHANNEL_FORMATS

◆ speakerArrangements

SpeakerArrangement Steinberg::Vst::ASPiK::speakerArrangements[NUM_SUPPORTED_CHANNEL_FORMATS]
Initial value:
=
{SpeakerArr::kEmpty, SpeakerArr::kMono, SpeakerArr::kStereo, SpeakerArr::k30Cine,
SpeakerArr::k31Cine, SpeakerArr::k40Music, SpeakerArr::k50, SpeakerArr::k51,
SpeakerArr::k60Music, SpeakerArr::k61Music, SpeakerArr::k70Cine, SpeakerArr::k70Music,
SpeakerArr::k71Cine, SpeakerArr::k71Music, SpeakerArr::k71Proximity}

fixed array of supported VST3 speaker arrangements you can add more here if you want to support more channel arrangements; NOTE: these were chosen to match with AU and AAX channal I/O support.

@speakerArrangements