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

effGetParamDisplay / getParameterDisplay()


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 7:
7. effGetParamDisplay   >= VST1.0   @see AudioEffect::getParameterDisplay()
host requests parameter textual representation
e[index]: parameter index
x[ptr]: returns string-pointer to parameter textual representation (max 8 bytes), examples: 0.5, -3, PLATE

C++ method:
 void AudioEffect::getParameterDisplay(VstInt32 index, char* text)

Delphi method:
 procedure AudioEffectX.getParamDisplay(index: VstInt32; text: pchar);
warning:
Please be aware that the string lengths supported by the default VST interface are normally limited to 8 characters (max 7 chars plus null terminating character). If you copy too much data into the buffers provided, you may break certain Host applications.

FIRST   -   PREV   -   NEXT   -   TOP