For more info see the Steinberg VST SDK documentation.
Namespace: Un4seen.Bass.AddOn.Vst
Assembly: Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Member name | Value | Description | |
---|---|---|---|
effOpen | 0 | Initialise. | |
effClose | 1 | Exit, release all memory and other resources! | |
effSetProgram | 2 | Program number in "value". | |
effGetProgram | 3 | Returns the current program number. | |
effSetProgramName | 4 | User changed program name (max 24 char + 0) to as passed in string. | |
effGetProgramName | 5 | Stuff program name (max 24 char + 0) into string. | |
effGetParamLabel | 6 |
Stuff parameter "index" label (max 8 char + 0) into string.
Examples: 'sec', 'dB', 'type' | |
effGetParamDisplay | 7 |
Stuff parameter "index" textual representation into string.
Examples: '0.5', '-3', 'PLATE' | |
effGetParamName | 8 |
Stuff parameter "index" label (max 8 char + 0) into string.
Examples: 'Time', 'Gain', 'RoomType' | |
effGetVu | 9 | Called if (flags & (effFlagsHasClip | effFlagsHasVu)). | |
effSetSampleRate | 10 | System: In opt (float value in Hz; for example 44100.0Hz). | |
effSetBlockSize | 11 | System: In value (this is the maximun size of an audio block, pls check sampleframes in process call). | |
effMainsChanged | 12 | System: The user has switched the 'power on' button to value (0 off, else on). This only switches audio processing; you should flush delay buffers etc. | |
effEditGetRect | 13 | Editor: Stuff rect (top, left, bottom, right) into ptr. | |
effEditOpen | 14 | Editor: System dependant Window pointer in ptr. | |
effEditClose | 15 | Editor: No arguments. | |
effEditDraw | 16 | Editor: Draw method, ptr points to rect (MAC Only). | |
effEditMouse | 17 | Editor: index: x, value: y (MAC Only). | |
effEditKey | 18 | Editor: System keycode in value. | |
effEditIdle | 19 | Editor: no arguments. Be gentle! | |
effEditTop | 20 | Editor: Window has topped, no arguments. | |
effEditSleep | 21 | Editor: Window goes to background. | |
effIdentify | 22 | Returns 'NvEf'. | |
effGetChunk | 23 | Host requests pointer to chunk into (void**)ptr, byteSize returned. | |
effSetChunk | 24 | Plug-in receives saved chunk, byteSize passed. | |
effProcessEvents | 25 | VstEvents* in "ptr". | |
effCanBeAutomated | 26 | Parameter index in "index". | |
effString2Parameter | 27 | Parameter index in "index", string in "ptr". | |
effGetNumProgramCategories | 28 | No arguments. This is for dividing programs into groups (like GM). | |
effGetProgramNameIndexed | 29 |
Get program name of category "value", program "index" into "ptr".
Category (that is, "value") may be -1, in which case program indices are enumerated linearily (as usual); otherwise, each category starts over with index 0. | |
effCopyProgram | 30 |
Copy current program to destination "index"
Note: implies setParameter connections, configuration. | |
effConnectInput | 31 | Input at "index" has been (dis-)connected; "value" == 0: disconnected, else connected. | |
effConnectOutput | 32 | Onput at "index" has been (dis-)connected; "value" == 0: disconnected, else connected. | |
effGetInputProperties | 33 | "index", VstPinProperties* in ptr, return != 0 means true. | |
effGetOutputProperties | 34 | "index", VstPinProperties* in ptr, return != 0 means true. | |
effGetPlugCategory | 35 | No parameter, return value is category. | |
effGetCurrentPosition | 36 | Realtime: for external dsp, see flag bits below. | |
effGetDestinationBuffer | 37 | Realtime: for external dsp, see flag bits below. returns float*. | |
effOfflineNotify | 38 | Offline: ptr = VstAudioFile array, value = count, index = start flag. | |
effOfflinePrepare | 39 | Offline: ptr = VstOfflineTask array, value = count. | |
effOfflineRun | 40 | Offline: ptr = VstOfflineTask array, value = count. | |
effProcessVarIo | 41 | VstVariableIo* in "ptr". | |
effSetSpeakerArrangement | 42 | VstSpeakerArrangement* pluginInput in "value"; VstSpeakerArrangement* pluginOutput in "ptr". | |
effSetBlockSizeAndSampleRate | 43 | Block size in "value", sampleRate in "opt" | |
effSetBypass | 44 | On/Off in "value" (0 = off, 1 = on). | |
effGetEffectName | 45 | char* name (max 32 bytes) in "ptr". | |
effGetErrorText | 46 | char* text (max 256 bytes) in "ptr". | |
effGetVendorString | 47 | Fills "ptr" with a string identifying the vendor (max 64 char). | |
effGetProductString | 48 | Fills "ptr" with a string with product name (max 64 char). | |
effGetVendorVersion | 49 | Returns vendor-specific version. | |
effVendorSpecific | 50 | No definition, vendor specific handling. | |
effCanDo | 51 | "ptr" contains one of the 'plugCanDos' strings (e.g. "bypass"). | |
effGetTailSize | 52 | Returns tail size; 0 is default (return 1 for 'no tail'). | |
effIdle | 53 | Idle call in response to audioMasterneedIdle. Must return 1 to keep idle calls beeing issued. | |
effGetIcon | 54 | GUI: void* in "ptr", not yet defined. | |
effSetViewPosition | 55 | GUI: set view position (in window) to x "index" y "value" | |
effGetParameterProperties | 56 | Of param "index", VstParameterProperties* in "ptr". | |
effKeysRequired | 57 | Returns 0: needs keys (default for 1.0 plugs), 1: don't need. | |
effGetVstVersion | 58 | Returns 2 for VST 2; older versions return 0; 2100 for VST 2.1...2400 for VST 2.4. | |
effEditKeyDown | 59 | Character in "index", virtual in "value", modifiers in "opt", return -1 if not used, return 1 if used. | |
effEditKeyUp | 60 | Character in "index", virtual in "value", modifiers in "opt", return -1 if not used, return 1 if used. | |
effSetEditKnobMode | 61 | Mode in "value": 0: circular, 1:circular relativ, 2:linear. | |
effGetMidiProgramName | 62 |
Passed "ptr" points to MidiProgramName struct.
Struct will be filled with information for 'thisProgramIndex'. Returns number of used programIndexes, if 0 is returned, no MidiProgramNames supported. | |
effGetCurrentMidiProgram | 63 |
Returns the programIndex of the current program.
Passed "ptr" points to MidiProgramName struct, struct will be filled with information for the current program. | |
effGetMidiProgramCategory | 64 |
Passed "ptr" points to MidiProgramCategory struct.
Struct will be filled with information for 'thisCategoryIndex'. Returns number of used categoryIndexes, if 0 is returned, no MidiProgramCategories supported. | |
effHasMidiProgramsChanged | 65 | Returns 1 if the MidiProgramNames or MidiKeyNames had changed on this channel, 0 otherwise. "ptr" ignored. | |
effGetMidiKeyName | 66 |
Passed "ptr" points to MidiKeyName struct.
Struct will be filled with information for 'thisProgramIndex' and 'thisKeyNumber'. If keyName is "" the standard name of the key will be displayed. If 0 is returned, no MidiKeyNames are defined for 'thisProgramIndex'. | |
effBeginSetProgram | 67 | Called before a new program is loaded. | |
effEndSetProgram | 68 | Called when the program is loaded. | |
effGetSpeakerArrangement | 69 | VstSpeakerArrangement** pluginInput in "value". VstSpeakerArrangement** pluginOutput in "ptr". | |
effShellGetNextPlugin | 70 |
This opcode is only called, if plugin is of type kPlugCategShell. Returns the next plugin's uniqueID.
"ptr" points to a char buffer of size 64, which is to be filled with the name of the plugin including the terminating zero. | |
effStartProcess | 71 | Called before the start of process call. | |
effStopProcess | 72 | Called after the stop of process call. | |
effSetTotalSampleToProcess | 73 | Called in offline (non RealTime) Process before process is called, indicates how many sample will be processed. | |
effSetPanLaw | 74 | PanLaw : Type (Linear, Equal Power,.. see enum PanLaw Type) in "value", Gain in "opt": for Linear : [1.0 means 0dB PanLaw], [~0.58 means -4.5dB], [0.5 means -6.02dB]. | |
effBeginLoadBank | 75 |
Called before a Bank is loaded, "ptr" points to VstPatchChunkInfo structure.
Return -1 if the Bank can not be loaded, return 1 if it can be loaded else 0 (for compatibility). | |
effBeginLoadProgram | 76 | Called before a Program is loaded, "ptr" points to VstPatchChunkInfo structure. Return -1 if the Program can not be loaded, return 1 if it can be loaded else 0 (for compatibility). | |
effSetProcessPrecision | 77 | Sets the processing precision in "value" (0=32 bit, 1=64 bit). | |
effGetNumMidiInputChannels | 78 | Returns the number of used MIDI input channels (1-15). | |
effGetNumMidiOutputChannels | 79 | Returns the number of used MIDI output channels (1-15). | |
effNumOpcodes | 80 | Returns the number of available OpCodes |