- Main Page
- Namespaces
- Classes
- Files
- Directories
- Related Pages

- File List
- File Members

# aeffectx.h File Reference

`#include "aeffect.h"`

## Classes
struct | VstEvent
struct | VstEvents
struct | VstMidiEvent
struct | VstMidiSysexEvent
struct | VstTimeInfo
struct | VstVariableIo
struct | VstParameterProperties
struct | VstPinProperties
struct | MidiProgramName
struct | MidiProgramCategory
struct | MidiKeyName
struct | VstSpeakerProperties
struct | VstSpeakerArrangement
struct | VstOfflineTask
struct | VstAudioFile
struct | VstAudioFileMarker
struct | VstWindow
struct | VstKeyCode
struct | VstFileType
struct | VstFileSelect
struct | VstPatchChunkInfo
## Enumerations
enum | Vst2StringConstants { kVstMaxNameLen = 64, kVstMaxLabelLen = 64, kVstMaxShortLabelLen = 8, kVstMaxCategLabelLen = 24, kVstMaxFileNameLen = 100 }
enum | VstEventTypes { kVstMidiType = 1, kVstAudioType, kVstVideoType, kVstParameterType, kVstTriggerType, kVstSysExType }
enum | VstMidiEventFlags { kVstMidiEventIsRealtime = 1 << 0 }
enum | VstTimeInfoFlags { kVstTransportChanged = 1, kVstTransportPlaying = 1 << 1, kVstTransportCycleActive = 1 << 2, kVstTransportRecording = 1 << 3, kVstAutomationWriting = 1 << 6, kVstAutomationReading = 1 << 7, kVstNanosValid = 1 << 8, kVstPpqPosValid = 1 << 9, kVstTempoValid = 1 << 10, kVstBarsValid = 1 << 11, kVstCyclePosValid = 1 << 12, kVstTimeSigValid = 1 << 13, kVstSmpteValid = 1 << 14, kVstClockValid = 1 << 15 }
enum | VstSmpteFrameRate { kVstSmpte24fps = 0, kVstSmpte25fps = 1, kVstSmpte2997fps = 2, kVstSmpte30fps = 3, kVstSmpte2997dfps = 4, kVstSmpte30dfps = 5, kVstSmpteFilm16mm = 6, kVstSmpteFilm35mm = 7, kVstSmpte239fps = 10, kVstSmpte249fps = 11, kVstSmpte599fps = 12, kVstSmpte60fps = 13 }
enum | VstHostLanguage { kVstLangEnglish = 1, kVstLangGerman, kVstLangFrench, kVstLangItalian, kVstLangSpanish, kVstLangJapanese }
enum | AudioMasterOpcodesX { audioMasterWantMidi = audioMasterPinConnected + 2, audioMasterGetTime, audioMasterProcessEvents, audioMasterSetTime, audioMasterTempoAt, audioMasterGetNumAutomatableParameters, audioMasterGetParameterQuantization, audioMasterIOChanged, audioMasterNeedIdle, audioMasterSizeWindow, audioMasterGetSampleRate, audioMasterGetBlockSize, audioMasterGetInputLatency, audioMasterGetOutputLatency, audioMasterGetPreviousPlug, audioMasterGetNextPlug, audioMasterWillReplaceOrAccumulate, audioMasterGetCurrentProcessLevel, audioMasterGetAutomationState, audioMasterOfflineStart, audioMasterOfflineRead, audioMasterOfflineWrite, audioMasterOfflineGetCurrentPass, audioMasterOfflineGetCurrentMetaPass, audioMasterSetOutputSampleRate, audioMasterGetOutputSpeakerArrangement, audioMasterGetVendorString, audioMasterGetProductString, audioMasterGetVendorVersion, audioMasterVendorSpecific, audioMasterSetIcon, audioMasterCanDo, audioMasterGetLanguage, audioMasterOpenWindow, audioMasterCloseWindow, audioMasterGetDirectory, audioMasterUpdateDisplay, audioMasterBeginEdit, audioMasterEndEdit, audioMasterOpenFileSelector, audioMasterCloseFileSelector, audioMasterEditFile, audioMasterGetChunkFile, audioMasterGetInputSpeakerArrangement }
enum | AEffectXOpcodes { effProcessEvents = effSetChunk + 1, effCanBeAutomated, effString2Parameter, effGetNumProgramCategories, effGetProgramNameIndexed, effCopyProgram, effConnectInput, effConnectOutput, effGetInputProperties, effGetOutputProperties, effGetPlugCategory, effGetCurrentPosition, effGetDestinationBuffer, effOfflineNotify, effOfflinePrepare, effOfflineRun, effProcessVarIo, effSetSpeakerArrangement, effSetBlockSizeAndSampleRate, effSetBypass, effGetEffectName, effGetErrorText, effGetVendorString, effGetProductString, effGetVendorVersion, effVendorSpecific, effCanDo, effGetTailSize, effIdle, effGetIcon, effSetViewPosition, effGetParameterProperties, effKeysRequired, effGetVstVersion, effEditKeyDown, effEditKeyUp, effSetEditKnobMode, effGetMidiProgramName, effGetCurrentMidiProgram, effGetMidiProgramCategory, effHasMidiProgramsChanged, effGetMidiKeyName, effBeginSetProgram, effEndSetProgram, effGetSpeakerArrangement, effShellGetNextPlugin, effStartProcess, effStopProcess, effSetTotalSampleToProcess, effSetPanLaw, effBeginLoadBank, effBeginLoadProgram, effSetProcessPrecision, effGetNumMidiInputChannels, effGetNumMidiOutputChannels }
enum | VstProcessPrecision { kVstProcessPrecision32 = 0, kVstProcessPrecision64 }
enum | VstParameterFlags { kVstParameterIsSwitch = 1 << 0, kVstParameterUsesIntegerMinMax = 1 << 1, kVstParameterUsesFloatStep = 1 << 2, kVstParameterUsesIntStep = 1 << 3, kVstParameterSupportsDisplayIndex = 1 << 4, kVstParameterSupportsDisplayCategory = 1 << 5, kVstParameterCanRamp = 1 << 6 }
enum | VstPinPropertiesFlags { kVstPinIsActive = 1 << 0, kVstPinIsStereo = 1 << 1, kVstPinUseSpeaker = 1 << 2 }
enum | VstPlugCategory { kPlugCategUnknown = 0, kPlugCategEffect, kPlugCategSynth, kPlugCategAnalysis, kPlugCategMastering, kPlugCategSpacializer, kPlugCategRoomFx, kPlugSurroundFx, kPlugCategRestoration, kPlugCategOfflineProcess, kPlugCategShell, kPlugCategGenerator, kPlugCategMaxCount }
enum | VstMidiProgramNameFlags { kMidiIsOmni = 1 }
enum | VstSpeakerType { kSpeakerUndefined = 0x7fffffff, kSpeakerM = 0, kSpeakerL, kSpeakerR, kSpeakerC, kSpeakerLfe, kSpeakerLs, kSpeakerRs, kSpeakerLc, kSpeakerRc, kSpeakerS, kSpeakerCs = kSpeakerS, kSpeakerSl, kSpeakerSr, kSpeakerTm, kSpeakerTfl, kSpeakerTfc, kSpeakerTfr, kSpeakerTrl, kSpeakerTrc, kSpeakerTrr, kSpeakerLfe2 }
enum | VstUserSpeakerType { kSpeakerU32 = -32, kSpeakerU31, kSpeakerU30, kSpeakerU29, kSpeakerU28, kSpeakerU27, kSpeakerU26, kSpeakerU25, kSpeakerU24, kSpeakerU23, kSpeakerU22, kSpeakerU21, kSpeakerU20, kSpeakerU19, kSpeakerU18, kSpeakerU17, kSpeakerU16, kSpeakerU15, kSpeakerU14, kSpeakerU13, kSpeakerU12, kSpeakerU11, kSpeakerU10, kSpeakerU9, kSpeakerU8, kSpeakerU7, kSpeakerU6, kSpeakerU5, kSpeakerU4, kSpeakerU3, kSpeakerU2, kSpeakerU1 }
enum | VstSpeakerArrangementType { kSpeakerArrUserDefined = -2, kSpeakerArrEmpty = -1, kSpeakerArrMono = 0, kSpeakerArrStereo, kSpeakerArrStereoSurround, kSpeakerArrStereoCenter, kSpeakerArrStereoSide, kSpeakerArrStereoCLfe, kSpeakerArr30Cine, kSpeakerArr30Music, kSpeakerArr31Cine, kSpeakerArr31Music, kSpeakerArr40Cine, kSpeakerArr40Music, kSpeakerArr41Cine, kSpeakerArr41Music, kSpeakerArr50, kSpeakerArr51, kSpeakerArr60Cine, kSpeakerArr60Music, kSpeakerArr61Cine, kSpeakerArr61Music, kSpeakerArr70Cine, kSpeakerArr70Music, kSpeakerArr71Cine, kSpeakerArr71Music, kSpeakerArr80Cine, kSpeakerArr80Music, kSpeakerArr81Cine, kSpeakerArr81Music, kSpeakerArr102, kNumSpeakerArr }
enum | VstOfflineTaskFlags { kVstOfflineUnvalidParameter = 1 << 0, kVstOfflineNewFile = 1 << 1, kVstOfflinePlugError = 1 << 10, kVstOfflineInterleavedAudio = 1 << 11, kVstOfflineTempOutputFile = 1 << 12, kVstOfflineFloatOutputFile = 1 << 13, kVstOfflineRandomWrite = 1 << 14, kVstOfflineStretch = 1 << 15, kVstOfflineNoThread = 1 << 16 }
enum | VstOfflineOption { kVstOfflineAudio, kVstOfflinePeaks, kVstOfflineParameter, kVstOfflineMarker, kVstOfflineCursor, kVstOfflineSelection, kVstOfflineQueryFiles }
enum | VstAudioFileFlags { kVstOfflineReadOnly = 1 << 0, kVstOfflineNoRateConversion = 1 << 1, kVstOfflineNoChannelChange = 1 << 2, kVstOfflineCanProcessSelection = 1 << 10, kVstOfflineNoCrossfade = 1 << 11, kVstOfflineWantRead = 1 << 12, kVstOfflineWantWrite = 1 << 13, kVstOfflineWantWriteMarker = 1 << 14, kVstOfflineWantMoveCursor = 1 << 15, kVstOfflineWantSelect = 1 << 16 }
enum | VstVirtualKey { VKEY_BACK = 1, VKEY_TAB, VKEY_CLEAR, VKEY_RETURN, VKEY_PAUSE, VKEY_ESCAPE, VKEY_SPACE, VKEY_NEXT, VKEY_END, VKEY_HOME, VKEY_LEFT, VKEY_UP, VKEY_RIGHT, VKEY_DOWN, VKEY_PAGEUP, VKEY_PAGEDOWN, VKEY_SELECT, VKEY_PRINT, VKEY_ENTER, VKEY_SNAPSHOT, VKEY_INSERT, VKEY_DELETE, VKEY_HELP, VKEY_NUMPAD0, VKEY_NUMPAD1, VKEY_NUMPAD2, VKEY_NUMPAD3, VKEY_NUMPAD4, VKEY_NUMPAD5, VKEY_NUMPAD6, VKEY_NUMPAD7, VKEY_NUMPAD8, VKEY_NUMPAD9, VKEY_MULTIPLY, VKEY_ADD, VKEY_SEPARATOR, VKEY_SUBTRACT, VKEY_DECIMAL, VKEY_DIVIDE, VKEY_F1, VKEY_F2, VKEY_F3, VKEY_F4, VKEY_F5, VKEY_F6, VKEY_F7, VKEY_F8, VKEY_F9, VKEY_F10, VKEY_F11, VKEY_F12, VKEY_NUMLOCK, VKEY_SCROLL, VKEY_SHIFT, VKEY_CONTROL, VKEY_ALT, VKEY_EQUALS }
enum | VstModifierKey { MODIFIER_SHIFT = 1<<0, MODIFIER_ALTERNATE = 1<<1, MODIFIER_COMMAND = 1<<2, MODIFIER_CONTROL = 1<<3 }
enum | VstFileSelectCommand { kVstFileLoad = 0, kVstFileSave, kVstMultipleFilesLoad, kVstDirectorySelect }
enum | VstFileSelectType { kVstFileType = 0 }
enum | VstPanLawType { kLinearPanLaw = 0, kEqualPowerPanLaw }
enum | VstProcessLevels { kVstProcessLevelUnknown = 0, kVstProcessLevelUser, kVstProcessLevelRealtime, kVstProcessLevelPrefetch, kVstProcessLevelOffline }
enum | VstAutomationStates { kVstAutomationUnsupported = 0, kVstAutomationOff, kVstAutomationRead, kVstAutomationWrite, kVstAutomationReadWrite }

## Enumeration Type Documentation

enum AEffectXOpcodes

VST 2.x dispatcher Opcodes (Host to Plug-in). Extension of AEffectOpcodes

Enumerator:

  effProcessEvents | [ptr]: VstEvents* See also: AudioEffectX::processEvents
  effCanBeAutomated | [index]: parameter index [return value]: 1=true, 0=false See also: AudioEffectX::canParameterBeAutomated
  effString2Parameter | [index]: parameter index [ptr]: parameter string [return value]: true for success See also: AudioEffectX::string2parameter
  effGetNumProgramCategories | Deprecated: deprecated in VST 2.4
  effGetProgramNameIndexed | [index]: program index [ptr]: buffer for program name, limited to kVstMaxProgNameLen [return value]: true for success See also: AudioEffectX::getProgramNameIndexed
  effCopyProgram | Deprecated: deprecated in VST 2.4
  effConnectInput | Deprecated: deprecated in VST 2.4
  effConnectOutput | Deprecated: deprecated in VST 2.4
  effGetInputProperties | [index]: input index [ptr]: VstPinProperties* [return value]: 1 if supported See also: AudioEffectX::getInputProperties
  effGetOutputProperties | [index]: output index [ptr]: VstPinProperties* [return value]: 1 if supported See also: AudioEffectX::getOutputProperties
  effGetPlugCategory | [return value]: category See also: VstPlugCategory AudioEffectX::getPlugCategory
  effGetCurrentPosition | Deprecated: deprecated in VST 2.4
  effGetDestinationBuffer | Deprecated: deprecated in VST 2.4
  effOfflineNotify | [ptr]: VstAudioFile array [value]: count [index]: start flag See also: AudioEffectX::offlineNotify
  effOfflinePrepare | [ptr]: VstOfflineTask array [value]: count See also: AudioEffectX::offlinePrepare
  effOfflineRun | [ptr]: VstOfflineTask array [value]: count See also: AudioEffectX::offlineRun
  effProcessVarIo | [ptr]: VstVariableIo* See also: AudioEffectX::processVariableIo
  effSetSpeakerArrangement | [value]: input VstSpeakerArrangement* [ptr]: output VstSpeakerArrangement* See also: AudioEffectX::setSpeakerArrangement
  effSetBlockSizeAndSampleRate | Deprecated: deprecated in VST 2.4
  effSetBypass | [value]: 1 = bypass, 0 = no bypass See also: AudioEffectX::setBypass
  effGetEffectName | [ptr]: buffer for effect name, limited to kVstMaxEffectNameLen See also: AudioEffectX::getEffectName
  effGetErrorText | Deprecated: deprecated in VST 2.4
  effGetVendorString | [ptr]: buffer for effect vendor string, limited to kVstMaxVendorStrLen See also: AudioEffectX::getVendorString
  effGetProductString | [ptr]: buffer for effect vendor string, limited to kVstMaxProductStrLen See also: AudioEffectX::getProductString
  effGetVendorVersion | [return value]: vendor-specific version See also: AudioEffectX::getVendorVersion
  effVendorSpecific | no definition, vendor specific handling See also: AudioEffectX::vendorSpecific
  effCanDo | [ptr]: "can do" string [return value]: 0: "don't know" -1: "no" 1: "yes" See also: AudioEffectX::canDo
  effGetTailSize | [return value]: tail size (for example the reverb time of a reverb plug-in); 0 is default (return 1 for 'no tail')
  effIdle | Deprecated: deprecated in VST 2.4
  effGetIcon | Deprecated: deprecated in VST 2.4
  effSetViewPosition | Deprecated: deprecated in VST 2.4
  effGetParameterProperties | [index]: parameter index [ptr]: VstParameterProperties* [return value]: 1 if supported See also: AudioEffectX::getParameterProperties
  effKeysRequired | Deprecated: deprecated in VST 2.4
  effGetVstVersion | [return value]: VST version See also: AudioEffectX::getVstVersion
  effEditKeyDown | [index]: ASCII character [value]: virtual key [opt]: modifiers [return value]: 1 if key used See also: AEffEditor::onKeyDown
  effEditKeyUp | [index]: ASCII character [value]: virtual key [opt]: modifiers [return value]: 1 if key used See also: AEffEditor::onKeyUp
  effSetEditKnobMode | [value]: knob mode 0: circular, 1: circular relativ, 2: linear (CKnobMode in VSTGUI) See also: AEffEditor::setKnobMode
  effGetMidiProgramName | [index]: MIDI channel [ptr]: MidiProgramName* [return value]: number of used programs, 0 if unsupported See also: AudioEffectX::getMidiProgramName
  effGetCurrentMidiProgram | [index]: MIDI channel [ptr]: MidiProgramName* [return value]: index of current program See also: AudioEffectX::getCurrentMidiProgram
  effGetMidiProgramCategory | [index]: MIDI channel [ptr]: MidiProgramCategory* [return value]: number of used categories, 0 if unsupported See also: AudioEffectX::getMidiProgramCategory
  effHasMidiProgramsChanged | [index]: MIDI channel [return value]: 1 if the MidiProgramName(s) or MidiKeyName(s) have changed See also: AudioEffectX::hasMidiProgramsChanged
  effGetMidiKeyName | [index]: MIDI channel [ptr]: MidiKeyName* [return value]: true if supported, false otherwise See also: AudioEffectX::getMidiKeyName
  effBeginSetProgram | no arguments See also: AudioEffectX::beginSetProgram
  effEndSetProgram | no arguments See also: AudioEffectX::endSetProgram
  effGetSpeakerArrangement | [value]: input VstSpeakerArrangement* [ptr]: output VstSpeakerArrangement* See also: AudioEffectX::getSpeakerArrangement
  effShellGetNextPlugin | [ptr]: buffer for plug-in name, limited to kVstMaxProductStrLen [return value]: next plugin's uniqueID See also: AudioEffectX::getNextShellPlugin
  effStartProcess | no arguments See also: AudioEffectX::startProcess
  effStopProcess | no arguments See also: AudioEffectX::stopProcess
  effSetTotalSampleToProcess | [value]: number of samples to process, offline only! See also: AudioEffectX::setTotalSampleToProcess
  effSetPanLaw | [value]: pan law [opt]: gain See also: VstPanLawType AudioEffectX::setPanLaw
  effBeginLoadBank | [ptr]: VstPatchChunkInfo* [return value]: -1: bank can't be loaded, 1: bank can be loaded, 0: unsupported See also: AudioEffectX::beginLoadBank
  effBeginLoadProgram | [ptr]: VstPatchChunkInfo* [return value]: -1: prog can't be loaded, 1: prog can be loaded, 0: unsupported See also: AudioEffectX::beginLoadProgram
  effSetProcessPrecision | [value]: See also: VstProcessPrecision AudioEffectX::setProcessPrecision
  effGetNumMidiInputChannels | [return value]: number of used MIDI input channels (1-15) See also: AudioEffectX::getNumMidiInputChannels
  effGetNumMidiOutputChannels | [return value]: number of used MIDI output channels (1-15) See also: AudioEffectX::getNumMidiOutputChannels

enum AudioMasterOpcodesX

VST 2.x dispatcher Opcodes (Plug-in to Host). Extension of AudioMasterOpcodes

Enumerator:

  audioMasterWantMidi | Deprecated: deprecated in VST 2.4
  audioMasterGetTime | [return value]: VstTimeInfo* or null if not supported [value]: request mask See also: VstTimeInfoFlags AudioEffectX::getTimeInfo
  audioMasterProcessEvents | [ptr]: pointer to VstEvents See also: VstEvents AudioEffectX::sendVstEventsToHost
  audioMasterSetTime | Deprecated: deprecated in VST 2.4
  audioMasterTempoAt | Deprecated: deprecated in VST 2.4
  audioMasterGetNumAutomatableParameters | Deprecated: deprecated in VST 2.4
  audioMasterGetParameterQuantization | Deprecated: deprecated in VST 2.4
  audioMasterIOChanged | [return value]: 1 if supported See also: AudioEffectX::ioChanged
  audioMasterNeedIdle | Deprecated: deprecated in VST 2.4
  audioMasterSizeWindow | [index]: new width [value]: new height [return value]: 1 if supported See also: AudioEffectX::sizeWindow
  audioMasterGetSampleRate | [return value]: current sample rate See also: AudioEffectX::updateSampleRate
  audioMasterGetBlockSize | [return value]: current block size See also: AudioEffectX::updateBlockSize
  audioMasterGetInputLatency | [return value]: input latency in audio samples See also: AudioEffectX::getInputLatency
  audioMasterGetOutputLatency | [return value]: output latency in audio samples See also: AudioEffectX::getOutputLatency
  audioMasterGetPreviousPlug | Deprecated: deprecated in VST 2.4
  audioMasterGetNextPlug | Deprecated: deprecated in VST 2.4
  audioMasterWillReplaceOrAccumulate | Deprecated: deprecated in VST 2.4
  audioMasterGetCurrentProcessLevel | [return value]: current process level See also: VstProcessLevels
  audioMasterGetAutomationState | [return value]: current automation state See also: VstAutomationStates
  audioMasterOfflineStart | [index]: numNewAudioFiles [value]: numAudioFiles [ptr]: VstAudioFile* See also: AudioEffectX::offlineStart
  audioMasterOfflineRead | [index]: bool readSource [value]: VstOfflineOption* See also: VstOfflineOption [ptr]: VstOfflineTask* VstOfflineTask AudioEffectX::offlineRead
  audioMasterOfflineWrite | See also: audioMasterOfflineRead AudioEffectX::offlineRead
  audioMasterOfflineGetCurrentPass | See also: AudioEffectX::offlineGetCurrentPass
  audioMasterOfflineGetCurrentMetaPass | See also: AudioEffectX::offlineGetCurrentMetaPass
  audioMasterSetOutputSampleRate | Deprecated: deprecated in VST 2.4
  audioMasterGetOutputSpeakerArrangement | Deprecated: deprecated in VST 2.4
  audioMasterGetVendorString | [ptr]: char buffer for vendor string, limited to kVstMaxVendorStrLen See also: AudioEffectX::getHostVendorString
  audioMasterGetProductString | [ptr]: char buffer for vendor string, limited to kVstMaxProductStrLen See also: AudioEffectX::getHostProductString
  audioMasterGetVendorVersion | [return value]: vendor-specific version See also: AudioEffectX::getHostVendorVersion
  audioMasterVendorSpecific | no definition, vendor specific handling See also: AudioEffectX::hostVendorSpecific
  audioMasterSetIcon | Deprecated: deprecated in VST 2.4
  audioMasterCanDo | [ptr]: "can do" string [return value]: 1 for supported
  audioMasterGetLanguage | [return value]: language code See also: VstHostLanguage
  audioMasterOpenWindow | Deprecated: deprecated in VST 2.4
  audioMasterCloseWindow | Deprecated: deprecated in VST 2.4
  audioMasterGetDirectory | [return value]: FSSpec on MAC, else char* See also: AudioEffectX::getDirectory
  audioMasterUpdateDisplay | no arguments
  audioMasterBeginEdit | [index]: parameter index See also: AudioEffectX::beginEdit
  audioMasterEndEdit | [index]: parameter index See also: AudioEffectX::endEdit
  audioMasterOpenFileSelector | [ptr]: VstFileSelect* [return value]: 1 if supported See also: AudioEffectX::openFileSelector
  audioMasterCloseFileSelector | [ptr]: VstFileSelect* See also: AudioEffectX::closeFileSelector
  audioMasterEditFile | Deprecated: deprecated in VST 2.4
  audioMasterGetChunkFile | Deprecated: deprecated in VST 2.4 [ptr]: char[2048] or sizeof (FSSpec) [return value]: 1 if supported See also: AudioEffectX::getChunkFile
  audioMasterGetInputSpeakerArrangement | Deprecated: deprecated in VST 2.4

enum Vst2StringConstants

String length limits (in characters excl. 0 byte).

Enumerator:

  kVstMaxNameLen | used for MidiProgramName, MidiProgramCategory, MidiKeyName, VstSpeakerProperties, VstPinProperties
  kVstMaxLabelLen | used for VstParameterProperties->label, VstPinProperties->label
  kVstMaxShortLabelLen | used for VstParameterProperties->shortLabel, VstPinProperties->shortLabel
  kVstMaxCategLabelLen | used for VstParameterProperties->label
  kVstMaxFileNameLen | used for VstAudioFile->name

enum VstAudioFileFlags

Flags used in VstAudioFile.

Enumerator:

  kVstOfflineReadOnly | set by Host (in call offlineNotify)
  kVstOfflineNoRateConversion | set by Host (in call offlineNotify)
  kVstOfflineNoChannelChange | set by Host (in call offlineNotify)
  kVstOfflineCanProcessSelection | set by plug-in (in call offlineStart)
  kVstOfflineNoCrossfade | set by plug-in (in call offlineStart)
  kVstOfflineWantRead | set by plug-in (in call offlineStart)
  kVstOfflineWantWrite | set by plug-in (in call offlineStart)
  kVstOfflineWantWriteMarker | set by plug-in (in call offlineStart)
  kVstOfflineWantMoveCursor | set by plug-in (in call offlineStart)
  kVstOfflineWantSelect | set by plug-in (in call offlineStart)

enum VstAutomationStates

Automation States returned by audioMasterGetAutomationState.

Enumerator:

  kVstAutomationUnsupported | not supported by Host
  kVstAutomationOff | off
  kVstAutomationRead | read
  kVstAutomationWrite | write
  kVstAutomationReadWrite | read and write

enum VstEventTypes

VstEvent Types used by VstEvent.

Enumerator:

  kVstMidiType | MIDI event. See also: VstMidiEvent
  kVstAudioType | Deprecated: unused event type
  kVstVideoType | Deprecated: unused event type
  kVstParameterType | Deprecated: unused event type
  kVstTriggerType | Deprecated: unused event type
  kVstSysExType | MIDI system exclusive. See also: VstMidiSysexEvent

enum VstFileSelectCommand

Command constants used in VstFileSelect structure.

Enumerator:

  kVstFileLoad | for loading a file
  kVstFileSave | for saving a file
  kVstMultipleFilesLoad | for loading multiple files
  kVstDirectorySelect | for selecting a directory/folder

enum VstFileSelectType

Types used in VstFileSelect structure.

Enumerator:

  kVstFileType | regular file selector

enum VstHostLanguage

Language code returned by audioMasterGetLanguage.

Enumerator:

  kVstLangEnglish | English.
  kVstLangGerman | German.
  kVstLangFrench | French.
  kVstLangItalian | Italian.
  kVstLangSpanish | Spanish.
  kVstLangJapanese | Japanese.

enum VstMidiEventFlags

Flags used in VstMidiEvent.

Enumerator:

  kVstMidiEventIsRealtime | means that this event is played life (not in playback from a sequencer track). This allows the Plug-In to handle these flagged events with higher priority, especially when the Plug-In has a big latency (AEffect::initialDelay)

enum VstMidiProgramNameFlags

Flags used in MidiProgramName.

Enumerator:

  kMidiIsOmni | default is multi. for omni mode, channel 0 is used for inquiries and program changes

enum VstModifierKey

Modifier flags used in VstKeyCode.

Enumerator:

  MODIFIER_SHIFT | Shift.
  MODIFIER_ALTERNATE | Alt.
  MODIFIER_COMMAND | Control on Mac.
  MODIFIER_CONTROL | Ctrl on PC, Apple on Mac.

enum VstOfflineOption

Option passed to offlineRead/offlineWrite.

Enumerator:

  kVstOfflineAudio | reading/writing audio samples
  kVstOfflinePeaks | reading graphic representation
  kVstOfflineParameter | reading/writing parameters
  kVstOfflineMarker | reading/writing marker
  kVstOfflineCursor | reading/moving edit cursor
  kVstOfflineSelection | reading/changing selection
  kVstOfflineQueryFiles | to request the Host to call asynchronously offlineNotify

enum VstOfflineTaskFlags

Flags used in VstOfflineTask.

Enumerator:

  kVstOfflineUnvalidParameter | set by Host
  kVstOfflineNewFile | set by Host
  kVstOfflinePlugError | set by plug-in
  kVstOfflineInterleavedAudio | set by plug-in
  kVstOfflineTempOutputFile | set by plug-in
  kVstOfflineFloatOutputFile | set by plug-in
  kVstOfflineRandomWrite | set by plug-in
  kVstOfflineStretch | set by plug-in
  kVstOfflineNoThread | set by plug-in

enum VstPanLawType

PanLaw Type.

Enumerator:

  kLinearPanLaw | L = pan * M; R = (1 - pan) * M;.
  kEqualPowerPanLaw | L = pow (pan, 0.5) * M; R = pow ((1 - pan), 0.5) * M;.

enum VstParameterFlags

Flags used in VstParameterProperties.

Enumerator:

  kVstParameterIsSwitch | parameter is a switch (on/off)
  kVstParameterUsesIntegerMinMax | minInteger, maxInteger valid
  kVstParameterUsesFloatStep | stepFloat, smallStepFloat, largeStepFloat valid
  kVstParameterUsesIntStep | stepInteger, largeStepInteger valid
  kVstParameterSupportsDisplayIndex | displayIndex valid
  kVstParameterSupportsDisplayCategory | category, etc. valid
  kVstParameterCanRamp | set if parameter value can ramp up/down

enum VstPinPropertiesFlags

Flags used in VstPinProperties.

Enumerator:

  kVstPinIsActive | pin is active, ignored by Host
  kVstPinIsStereo | pin is first of a stereo pair
  kVstPinUseSpeaker | VstPinProperties::arrangementType is valid and can be used to get the wanted arrangement

enum VstPlugCategory

Plug-in Categories.

Enumerator:

  kPlugCategUnknown | Unknown, category not implemented.
  kPlugCategEffect | Simple Effect.
  kPlugCategSynth | VST Instrument (Synths, samplers,...).
  kPlugCategAnalysis | Scope, Tuner, ...
  kPlugCategMastering | Dynamics, ...
  kPlugCategSpacializer | Panners, ...
  kPlugCategRoomFx | Delays and Reverbs.
  kPlugSurroundFx | Dedicated surround processor.
  kPlugCategRestoration | Denoiser, ...
  kPlugCategOfflineProcess | Offline Process.
  kPlugCategShell | Plug-in is container of other plug-ins. See also: effShellGetNextPlugin
  kPlugCategGenerator | ToneGenerator, ...
  kPlugCategMaxCount | Marker to count the categories.

enum VstProcessLevels

Process Levels returned by audioMasterGetCurrentProcessLevel.

Enumerator:

  kVstProcessLevelUnknown | not supported by Host
  kVstProcessLevelUser | 1: currently in user thread (GUI)
  kVstProcessLevelRealtime | 2: currently in audio thread (where process is called)
  kVstProcessLevelPrefetch | 3: currently in 'sequencer' thread (MIDI, timer etc)
  kVstProcessLevelOffline | 4: currently offline processing and thus in user thread

enum VstProcessPrecision

Symbolic precision constants used for effSetProcessPrecision.

Enumerator:

  kVstProcessPrecision32 | single precision float (32bits)
  kVstProcessPrecision64 | double precision (64bits)

enum VstSmpteFrameRate

SMPTE Frame Rates.

Enumerator:

  kVstSmpte24fps | 24 fps
  kVstSmpte25fps | 25 fps
  kVstSmpte2997fps | 29.97 fps
  kVstSmpte30fps | 30 fps
  kVstSmpte2997dfps | 29.97 drop
  kVstSmpte30dfps | 30 drop
  kVstSmpteFilm16mm | Film 16mm.
  kVstSmpteFilm35mm | Film 35mm.
  kVstSmpte239fps | HDTV: 23.976 fps.
  kVstSmpte249fps | HDTV: 24.976 fps.
  kVstSmpte599fps | HDTV: 59.94 fps.
  kVstSmpte60fps | HDTV: 60 fps.

enum VstSpeakerArrangementType

Speaker Arrangement Types

Enumerator:

  kSpeakerArrUserDefined | user defined
  kSpeakerArrEmpty | empty arrangement
  kSpeakerArrMono | M.
  kSpeakerArrStereo | L R.
  kSpeakerArrStereoSurround | Ls Rs.
  kSpeakerArrStereoCenter | Lc Rc.
  kSpeakerArrStereoSide | Sl Sr.
  kSpeakerArrStereoCLfe | C Lfe.
  kSpeakerArr30Cine | L R C.
  kSpeakerArr30Music | L R S.
  kSpeakerArr31Cine | L R C Lfe.
  kSpeakerArr31Music | L R Lfe S.
  kSpeakerArr40Cine | L R C S (LCRS).
  kSpeakerArr40Music | L R Ls Rs (Quadro).
  kSpeakerArr41Cine | L R C Lfe S (LCRS+Lfe).
  kSpeakerArr41Music | L R Lfe Ls Rs (Quadro+Lfe).
  kSpeakerArr50 | L R C Ls Rs.
  kSpeakerArr51 | L R C Lfe Ls Rs.
  kSpeakerArr60Cine | L R C Ls Rs Cs.
  kSpeakerArr60Music | L R Ls Rs Sl Sr.
  kSpeakerArr61Cine | L R C Lfe Ls Rs Cs.
  kSpeakerArr61Music | L R Lfe Ls Rs Sl Sr.
  kSpeakerArr70Cine | L R C Ls Rs Lc Rc.
  kSpeakerArr70Music | L R C Ls Rs Sl Sr.
  kSpeakerArr71Cine | L R C Lfe Ls Rs Lc Rc.
  kSpeakerArr71Music | L R C Lfe Ls Rs Sl Sr.
  kSpeakerArr80Cine | L R C Ls Rs Lc Rc Cs.
  kSpeakerArr80Music | L R C Ls Rs Cs Sl Sr.
  kSpeakerArr81Cine | L R C Lfe Ls Rs Lc Rc Cs.
  kSpeakerArr81Music | L R C Lfe Ls Rs Cs Sl Sr.
  kSpeakerArr102 | L R C Lfe Ls Rs Tfl Tfc Tfr Trl Trr Lfe2.
  kNumSpeakerArr |

enum VstSpeakerType

Speaker Types.

Enumerator:

  kSpeakerUndefined | Undefined.
  kSpeakerM | Mono (M).
  kSpeakerL | Left (L).
  kSpeakerR | Right (R).
  kSpeakerC | Center (C).
  kSpeakerLfe | Subbass (Lfe).
  kSpeakerLs | Left Surround (Ls).
  kSpeakerRs | Right Surround (Rs).
  kSpeakerLc | Left of Center (Lc).
  kSpeakerRc | Right of Center (Rc).
  kSpeakerS | Surround (S).
  kSpeakerCs | Center of Surround (Cs) = Surround (S).
  kSpeakerSl | Side Left (Sl).
  kSpeakerSr | Side Right (Sr).
  kSpeakerTm | Top Middle (Tm).
  kSpeakerTfl | Top Front Left (Tfl).
  kSpeakerTfc | Top Front Center (Tfc).
  kSpeakerTfr | Top Front Right (Tfr).
  kSpeakerTrl | Top Rear Left (Trl).
  kSpeakerTrc | Top Rear Center (Trc).
  kSpeakerTrr | Top Rear Right (Trr).
  kSpeakerLfe2 | Subbass 2 (Lfe2).

enum VstTimeInfoFlags

Flags used in VstTimeInfo.

Enumerator:

  kVstTransportChanged | indicates that play, cycle or record state has changed
  kVstTransportPlaying | set if Host sequencer is currently playing
  kVstTransportCycleActive | set if Host sequencer is in cycle mode
  kVstTransportRecording | set if Host sequencer is in record mode
  kVstAutomationWriting | set if automation write mode active (record parameter changes)
  kVstAutomationReading | set if automation read mode active (play parameter changes)
  kVstNanosValid | VstTimeInfo::nanoSeconds valid.
  kVstPpqPosValid | VstTimeInfo::ppqPos valid.
  kVstTempoValid | VstTimeInfo::tempo valid.
  kVstBarsValid | VstTimeInfo::barStartPos valid.
  kVstCyclePosValid | VstTimeInfo::cycleStartPos and VstTimeInfo::cycleEndPos valid.
  kVstTimeSigValid | VstTimeInfo::timeSigNumerator and VstTimeInfo::timeSigDenominator valid.
  kVstSmpteValid | VstTimeInfo::smpteOffset and VstTimeInfo::smpteFrameRate valid.
  kVstClockValid | VstTimeInfo::samplesToNextClock valid.

enum VstUserSpeakerType

User-defined speaker types, to be extended in the negative range. Will be handled as their corresponding speaker types with abs values: e.g abs(kSpeakerU1) == kSpeakerL, abs(kSpeakerU2) == kSpeakerR)

Enumerator:

  kSpeakerU32 |
  kSpeakerU31 |
  kSpeakerU30 |
  kSpeakerU29 |
  kSpeakerU28 |
  kSpeakerU27 |
  kSpeakerU26 |
  kSpeakerU25 |
  kSpeakerU24 |
  kSpeakerU23 |
  kSpeakerU22 |
  kSpeakerU21 |
  kSpeakerU20 | == kSpeakerLfe2
  kSpeakerU19 | == kSpeakerTrr
  kSpeakerU18 | == kSpeakerTrc
  kSpeakerU17 | == kSpeakerTrl
  kSpeakerU16 | == kSpeakerTfr
  kSpeakerU15 | == kSpeakerTfc
  kSpeakerU14 | == kSpeakerTfl
  kSpeakerU13 | == kSpeakerTm
  kSpeakerU12 | == kSpeakerSr
  kSpeakerU11 | == kSpeakerSl
  kSpeakerU10 | == kSpeakerCs
  kSpeakerU9 | == kSpeakerS
  kSpeakerU8 | == kSpeakerRc
  kSpeakerU7 | == kSpeakerLc
  kSpeakerU6 | == kSpeakerRs
  kSpeakerU5 | == kSpeakerLs
  kSpeakerU4 | == kSpeakerLfe
  kSpeakerU3 | == kSpeakerC
  kSpeakerU2 | == kSpeakerR
  kSpeakerU1 | == kSpeakerL

enum VstVirtualKey

Platform-independent definition of Virtual Keys (used in VstKeyCode).

Enumerator:

  VKEY_BACK |
  VKEY_TAB |
  VKEY_CLEAR |
  VKEY_RETURN |
  VKEY_PAUSE |
  VKEY_ESCAPE |
  VKEY_SPACE |
  VKEY_NEXT |
  VKEY_END |
  VKEY_HOME |
  VKEY_LEFT |
  VKEY_UP |
  VKEY_RIGHT |
  VKEY_DOWN |
  VKEY_PAGEUP |
  VKEY_PAGEDOWN |
  VKEY_SELECT |
  VKEY_PRINT |
  VKEY_ENTER |
  VKEY_SNAPSHOT |
  VKEY_INSERT |
  VKEY_DELETE |
  VKEY_HELP |
  VKEY_NUMPAD0 |
  VKEY_NUMPAD1 |
  VKEY_NUMPAD2 |
  VKEY_NUMPAD3 |
  VKEY_NUMPAD4 |
  VKEY_NUMPAD5 |
  VKEY_NUMPAD6 |
  VKEY_NUMPAD7 |
  VKEY_NUMPAD8 |
  VKEY_NUMPAD9 |
  VKEY_MULTIPLY |
  VKEY_ADD |
  VKEY_SEPARATOR |
  VKEY_SUBTRACT |
  VKEY_DECIMAL |
  VKEY_DIVIDE |
  VKEY_F1 |
  VKEY_F2 |
  VKEY_F3 |
  VKEY_F4 |
  VKEY_F5 |
  VKEY_F6 |
  VKEY_F7 |
  VKEY_F8 |
  VKEY_F9 |
  VKEY_F10 |
  VKEY_F11 |
  VKEY_F12 |
  VKEY_NUMLOCK |
  VKEY_SCROLL |
  VKEY_SHIFT |
  VKEY_CONTROL |
  VKEY_ALT |
  VKEY_EQUALS |

Empty

Copyright ©2006 Steinberg Media Technologies. All Rights Reserved.