ASPiK SDK
Loading...
Searching...
No Matches
PluginDescriptor Struct Reference

Information package about the plugin itself, consisting mainly of simple strings and ID values. More...

#include <pluginstructures.h>

Public Member Functions

uint32_t getDefaultChannelIOConfigForChannelCount (uint32_t channelCount)
 
uint32_t getChannelCountForChannelIOConfig (uint32_t format)
 

Public Attributes

std::string pluginName
 name (up to 31 chars)
 
std::string shortPluginName
 name (up to 15 chars)
 
std::string vendorName
 manufacturer name
 
uint32_t pluginTypeCode = 0
 FX or synth.
 
bool hasSidechain = false
 sidechain flag
 
bool processFrames = true
 want frames (default)
 
bool wantsMIDI = true
 want MIDI (don't need to actually use it)
 
bool hasCustomGUI = true
 default on
 
uint32_t latencyInSamples = 0
 latency
 
double tailTimeInMSec = 0.0
 tail time
 
bool infiniteTailVST3 = false
 VST3 infinite tail flag.
 
uint32_t numSupportedIOCombinations = 0
 should support at least main 3 combos
 
ChannelIOConfigsupportedIOCombinations
 
uint32_t numSupportedAuxIOCombinations = 0
 should support at least main 3 combos
 
ChannelIOConfigsupportedAuxIOCombinations
 

Detailed Description

Information package about the plugin itself, consisting mainly of simple strings and ID values.

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

◆ getChannelCountForChannelIOConfig()

uint32_t PluginDescriptor::getChannelCountForChannelIOConfig ( uint32_t  format)
inline

for AU plugins, this converts channel I/0 confirguration into an integer channel count value

◆ getDefaultChannelIOConfigForChannelCount()

uint32_t PluginDescriptor::getDefaultChannelIOConfigForChannelCount ( uint32_t  channelCount)
inline

for AU plugins, returns default setting


The documentation for this struct was generated from the following file: