VST2.4 specs 
HOME   |   Software       VST2.4 specs :: FIRST   -   PREV   -   NEXT

effGetPlugCategory / getPlugCategory()


C++: VstIntPtr function dispatcher(AEffect* e, VstInt32 opcode, VstInt32 index, VstIntPtr value, void* ptr, float opt);
Delphi: function dispatcher(e: PAEffect; opcode, index: VstInt32; value: VstIntPtr; ptr: pointer; opt: Single): VstIntPtr; cdecl;
always returns 0, unless otherwise defined.
all string-pointers points to zero terminated strings.
e[ ]: = plugin receives as entry parameter
x[ ]: = plugin returns to host

dispatcher() function using opcode 35:
35. effGetPlugCategory   >= VST2.0   @see AudioEffectX::getPlugCategory()
host requests plugin category
x[return]: @see VstPlugCategory constants

C++ method:
 VstPlugCategory AudioEffectX::getPlugCategory()

Delphi method:
 function AudioEffectX.getPlugCategory: VstPlugcategory;

VstPlugCategory constants:
 enum VstPlugCategory
{
  kPlugCategUnknown = 0,    // 0=Unknown, category not implemented
  kPlugCategEffect,         // 1=Simple Effect
  kPlugCategSynth,          // 2=VST Instrument (Synths, samplers,...)
  kPlugCategAnalysis,       // 3=Scope, Tuner, ...
  kPlugCategMastering,      // 4=Dynamics, ...
  kPlugCategSpacializer,    // 5=Panners, ...
  kPlugCategRoomFx,         // 6=Delays and Reverbs
  kPlugSurroundFx,          // 7=Dedicated surround processor
  kPlugCategRestoration,    // 8=Denoiser, ...
  kPlugCategOfflineProcess, // 9=Offline Process
  kPlugCategShell,          // 10=Plug-in is container of other plug-ins  @see effShellGetNextPlugin()
  kPlugCategGenerator,      // 11=ToneGenerator, ...
  kPlugCategMaxCount        // 12=Marker to count the categories
};

FIRST   -   PREV   -   NEXT   -   TOP