All VST specific interfaces are located in Vst namespace. More...

Namespaces
namespace	Attributes
	Attributes used to defined a Layer in a VST XML Representation.

namespace	AttributesFlags
	Attributes Flags defining a Layer in a VST XML Representation.

namespace	AttributesFunction
	Attributes Function used to defined the function of a Layer in a VST XML Representation.

namespace	AttributesStyle
	Attributes Style associated a specific Layer Type in a VST XML Representation.

namespace	ChannelContext
	For Channel Context Info Interface.

namespace	CurveType
	Curve Types used in a VST XML Representation.

namespace	LayerType
	Layer Types used in a VST XML Representation.

namespace	PlugType
	Component Types used as subCategories in PClassInfo2.

namespace	SpeakerArr
	Speaker Arrangement Definitions (SpeakerArrangement)

namespace	ViewType
	View Types used for IEditController::createView.

Classes
class	AudioBus
	Description of an Audio Bus. More...

struct	AudioBusBuffers
	Processing buffers of an audio bus. More...

union	AudioBusBuffers.__unnamed17__

class	BufferStream
	Stream implementation for a memory buffer. More...

class	Bus
	Basic Bus object. More...

struct	BusInfo
	BusInfo: This is the structure used with getBusInfo, informing the host about what is a specific given bus. More...

class	BusList
	List of Busses. More...

struct	Chord
	Description of a chord. More...

struct	ChordEvent
	Chord event specific data. More...

class	Component
	Default implementation for a VST 3 Component. More...

class	ComponentBase
	Base class for VST 3 Component and Edit Controller. More...

struct	DataEvent
	Data event specific data. More...

class	EditController
	Default implementation for a VST 3 edit controller. More...

class	EditControllerEx1
	Advanced implementation (support IUnitInfo) for a VST 3 edit controller. More...

class	EditorView
	View related to an edit controller. More...

struct	Event
	EventStructure representing a single Event of different types associated to a specific event (kEvent) bus. More...

union	Event.__unnamed15__

class	EventBus
	Description of an Event Bus. More...

class	FileStream
	Stream implementation for a file using stdio. More...

struct	FrameRate
	Frame Rate A frame rate describes the number of image (frame) displayed per second. More...

class	HostApplication
	Implementation's example of IHostApplication. More...

class	HostAttributeList
	Example, ready to use implementation of IAttributeList. More...

class	HostMessage
	Example implementation of IMessage. More...

class	IAttributeList
	Attribute list used in IMessage and IStreamAttributes: Vst::IAttributeList. More...

class	IAudioPresentationLatency
	Extended IAudioProcessor interface for a component: Vst::IAudioPresentationLatency. More...

class	IAudioProcessor
	Audio processing interface: Vst::IAudioProcessor. More...

class	IAutomationState
	Extended plug-in interface IEditController: Vst::IAutomationState. More...

class	IComponent
	Component base interface: Vst::IComponent. More...

class	IComponentHandler
	Host callback interface for an edit controller: Vst::IComponentHandler. More...

class	IComponentHandler2
	Extended host callback interface for an edit controller: Vst::IComponentHandler2. More...

class	IComponentHandler3
	Extended host callback interface Vst::IComponentHandler3 for an edit controller. More...

class	IComponentHandlerBusActivation
	Extended host callback interface for an edit controller: Vst::IComponentHandlerBusActivation. More...

class	IConnectionPoint
	Connect a component with another one: Vst::IConnectionPoint. More...

class	IContextMenu
	Context Menu interface: Vst::IContextMenu. More...

struct	IContextMenuItem
	IContextMenuItem is an entry element of the context menu. More...

class	IContextMenuTarget
	Context Menu Item Target interface: Vst::IContextMenuTarget. More...

class	IEditController
	Edit controller component interface: Vst::IEditController. More...

class	IEditController2
	Edit controller component interface extension: Vst::IEditController2. More...

class	IEditControllerHostEditing
	Parameter Editing from host: Vst::IEditControllerHostEditing. More...

class	IEventList
	List of events to process: Vst::IEventList. More...

class	IHostApplication
	Basic host callback interface: Vst::IHostApplication. More...

class	IInterAppAudioConnectionNotification
	Extended plug-in interface IEditController for Inter-App Audio connection state change notifications. More...

class	IInterAppAudioHost
	Inter-App Audio host Interface. More...

class	IInterAppAudioPresetManager
	Extended plug-in interface IEditController for Inter-App Audio Preset Management. More...

class	IKeyswitchController
	Extended plug-in interface IEditController for key switches support: Vst::IKeyswitchController. More...

class	IMessage
	Private plug-in message: Vst::IMessage. More...

class	IMidiLearn
	MIDI Learn interface: Vst::IMidiLearn. More...

class	IMidiMapping
	MIDI Mapping interface: Vst::IMidiMapping. More...

class	INoteExpressionController
	Extended plug-in interface IEditController for note expression event support: Vst::INoteExpressionController. More...

class	INoteExpressionPhysicalUIMapping
	Extended plug-in interface IEditController for note expression event support: Vst::INoteExpressionPhysicalUIMapping. More...

class	IParameterChanges
	All parameter changes of a processing block: Vst::IParameterChanges. More...

class	IParameterFinder
	Extension for IPlugView to find view parameters (lookup value under mouse support): Vst::IParameterFinder. More...

class	IParameterFunctionName
	Edit controller component interface extension: Vst::IParameterFunctionName. More...

class	IParamValueQueue
	Queue of changes for a specific parameter: Vst::IParamValueQueue. More...

class	IPlugInterfaceSupport
	Host callback interface for an edit controller: Vst::IPlugInterfaceSupport. More...

class	IPrefetchableSupport
	Indicates that the plug-in could or not support Prefetch (dynamically): Vst::IPrefetchableSupport. More...

class	IProcessContextRequirements
	Extended IAudioProcessor interface for a component: Vst::IProcessContextRequirements. More...

class	IProgramListData
	Component extension to access program list data: Vst::IProgramListData. More...

class	IProgress
	Extended host callback interface for an edit controller: Vst::IProgress. More...

class	IStreamAttributes
	Meta attributes of a stream: Vst::IStreamAttributes. More...

class	ITestPlugProvider
	Test Helper. More...

class	ITestPlugProvider2
	Test Helper extension. More...

class	IUnitData
	Component extension to access unit data: Vst::IUnitData. More...

class	IUnitHandler
	Host callback for unit support: Vst::IUnitHandler. More...

class	IUnitHandler2
	Host callback for extended unit support: Vst::IUnitHandler2. More...

class	IUnitInfo
	Edit controller extension to describe the plug-in structure: Vst::IUnitInfo. More...

class	IVst3ToAAXWrapper
	VST 3 to AAX Wrapper interface: Vst::IVst3ToAAXWrapper. More...

class	IVst3ToAUWrapper
	VST 3 to AU Wrapper interface: Vst::IVst3ToAUWrapper. More...

class	IVst3ToVst2Wrapper
	VST 3 to VST 2 Wrapper interface: Vst::IVst3ToVst2Wrapper. More...

class	IVst3WrapperMPESupport
	Wrapper MPE Support interface: Vst::IVst3WrapperMPESupport. More...

class	IXmlRepresentationController
	Extended plug-in interface IEditController for a component: Vst::IXmlRepresentationController. More...

struct	KeyswitchInfo
	KeyswitchInfo is the structure describing a key switch This structure is used by the method IKeyswitchController::getKeyswitchInfo. More...

struct	LegacyMIDICCOutEvent
	Legacy MIDI CC Out event specific data. More...

struct	NoteExpressionTextEvent
	Note Expression Text event. More...

struct	NoteExpressionTypeInfo
	NoteExpressionTypeInfo is the structure describing a note expression supported by the plug-in. More...

struct	NoteExpressionValueDescription
	Description of a Note Expression Type This structure is part of the NoteExpressionTypeInfo structure, it describes for given NoteExpressionTypeID its default value (for example 0.5 for a kTuningTypeID (kIsBipolar: centered)), its minimum and maximum (for predefined NoteExpressionTypeID the full range is predefined too) and a stepCount when the given NoteExpressionTypeID is limited to discrete values (like on/off state). More...

struct	NoteExpressionValueEvent
	Note Expression Value event. More...

struct	NoteOffEvent
	Note-off event specific data. More...

struct	NoteOnEvent
	Note-on event specific data. More...

class	Parameter
	Description of a Parameter. More...

class	ParameterContainer
	Collection of parameters. More...

struct	ParameterInfo
	Controller Parameter Info. More...

struct	PhysicalUIMap
	PhysicalUIMap describes a mapping of a noteExpression Type to a Physical UI Type. More...

struct	PhysicalUIMapList
	PhysicalUIMapList describes a list of PhysicalUIMap. More...

class	PlugInterfaceSupport
	Example implementation of IPlugInterfaceSupport. More...

struct	PolyPressureEvent
	PolyPressure event specific data. More...

class	PresetFile
	Handler for a VST 3 Preset File. More...

struct	ProcessContext
	Audio processing context. More...

struct	ProcessData
	Any data needed in audio processing. More...

struct	ProcessSetup
	Audio processing setup. More...

class	ProgramList
	ProgramList element. More...

struct	ProgramListInfo
	Basic Program List Description. More...

class	ProgramListWithPitchNames
	ProgramListWithPitchNames element. More...

class	RangeParameter
	Description of a RangeParameter. More...

class	ReadOnlyBStream
	Stream representing a Read-Only subsection of its source stream. More...

struct	RepresentationInfo
	RepresentationInfo is the structure describing a representation This structure is used in the function. More...

struct	RoutingInfo
	Routing Information: When the plug-in supports multiple I/O busses, a host may want to know how the busses are related. More...

struct	ScaleEvent
	Scale event specific data. More...

class	StringListParameter
	Description of a StringListParameter. More...

class	Unit
	Unit element. More...

struct	UnitInfo
	Basic Unit Description. More...

Typedefs
typedef int32	KnobMode
	Knob Mode Type.

typedef uint32	NoteExpressionTypeID
	Note Expression Types.

typedef double	NoteExpressionValue
	Note Expression Value.

typedef uint32	KeyswitchTypeID

typedef uint32	PhysicalUITypeID
	Physical UI Type.

typedef uint32	PrefetchableSupport
	Prefetchable Support Type.

typedef char16	TChar
	UTF-16 character.

typedef TChar	String128[128]
	128 character UTF-16 string

typedef const char8 *	CString
	C-String.

typedef int32	MediaType
	media type (audio/event)

typedef int32	BusDirection
	bus direction (in/out)

typedef int32	BusType
	bus type (main/aux)

typedef int32	IoMode
	I/O mode (see vst3IoMode)

typedef int32	UnitID
	unit identifier

typedef double	ParamValue
	parameter value type

typedef uint32	ParamID
	parameter identifier

typedef int32	ProgramListID
	program list identifier

typedef int16	CtrlNumber
	MIDI controller number (see ControllerNumbers for allowed values)

typedef double	TQuarterNotes
	time expressed in quarter notes

typedef int64	TSamples
	time expressed in audio samples

typedef uint32	ColorSpec
	color defining by 4 component ARGB value (Alpha/Red/Green/Blue)

typedef float	Sample32
	32-bit precision audio sample

typedef double	Sample64
	64-bit precision audio sample

typedef double	SampleRate
	sample rate

typedef uint64	SpeakerArrangement
	Bitset of speakers.

typedef uint64	Speaker
	Bit for one speaker.

using	ChunkID = char[4]

Enumerations
enum	ComponentFlags { kDistributable , kSimpleModeSupported }
	Component Flags used as classFlags in PClassInfo2. More...

enum	SymbolicSampleSizes { kSample32 , kSample64 }
	Symbolic sample size. More...

enum	ProcessModes { kRealtime , kPrefetch , kOffline }
	Processing mode informs the plug-in about the context and at which frequency the process call is called. More...

enum	MediaTypes { kAudio , kEvent , kNumMediaTypes }
	Bus media types. More...

enum	BusDirections { kInput , kOutput }
	Bus directions. More...

enum	BusTypes { kMain , kAux }
	Bus types. More...

enum	IoModes { kSimple , kAdvanced , kOfflineProcessing }
	I/O modes. More...

enum	RestartFlags { kReloadComponent , kIoChanged , kParamValuesChanged , kLatencyChanged , kParamTitlesChanged , kMidiCCAssignmentChanged , kNoteExpressionChanged , kIoTitlesChanged , kPrefetchableSupportChanged , kRoutingInfoChanged , kKeyswitchChanged }
	Flags used for IComponentHandler::restartComponent. More...

enum	KnobModes { kCircularMode , kRelativCircularMode , kLinearMode }
	Knob Mode. More...

enum	NoteIDUserRange { kNoteIDUserRangeLowerBound , kNoteIDUserRangeUpperBound }
	Reserved note identifier (noteId) range for a plug-in. More...

enum	ControllerNumbers { kCtrlBankSelectMSB , kCtrlModWheel , kCtrlBreath , kCtrlFoot , kCtrlPortaTime , kCtrlDataEntryMSB , kCtrlVolume , kCtrlBalance , kCtrlPan , kCtrlExpression , kCtrlEffect1 , kCtrlEffect2 , kCtrlGPC1 , kCtrlGPC2 , kCtrlGPC3 , kCtrlGPC4 , kCtrlBankSelectLSB , kCtrlDataEntryLSB , kCtrlSustainOnOff , kCtrlPortaOnOff , kCtrlSustenutoOnOff , kCtrlSoftPedalOnOff , kCtrlLegatoFootSwOnOff , kCtrlHold2OnOff , kCtrlSoundVariation , kCtrlFilterCutoff , kCtrlReleaseTime , kCtrlAttackTime , kCtrlFilterResonance , kCtrlDecayTime , kCtrlVibratoRate , kCtrlVibratoDepth , kCtrlVibratoDelay , kCtrlSoundCtrler10 , kCtrlGPC5 , kCtrlGPC6 , kCtrlGPC7 , kCtrlGPC8 , kCtrlPortaControl , kCtrlEff1Depth , kCtrlEff2Depth , kCtrlEff3Depth , kCtrlEff4Depth , kCtrlEff5Depth , kCtrlDataIncrement , kCtrlDataDecrement , kCtrlNRPNSelectLSB , kCtrlNRPNSelectMSB , kCtrlRPNSelectLSB , kCtrlRPNSelectMSB , kCtrlAllSoundsOff , kCtrlResetAllCtrlers , kCtrlLocalCtrlOnOff , kCtrlAllNotesOff , kCtrlOmniModeOff , kCtrlOmniModeOn , kCtrlPolyModeOnOff , kCtrlPolyModeOn , kAfterTouch , kPitchBend , kCountCtrlNumber , kCtrlProgramChange , kCtrlPolyPressure , kCtrlQuarterFrame }
	Controller Numbers (MIDI) More...

enum	NoteExpressionTypeIDs : uint32 { kVolumeTypeID , kPanTypeID , kTuningTypeID , kVibratoTypeID , kExpressionTypeID , kBrightnessTypeID , kTextTypeID , kPhonemeTypeID , kCustomStart , kCustomEnd , kInvalidTypeID }
	NoteExpressionTypeIDs describes the type of the note expression. More...

enum	KeyswitchTypeIDs : uint32 { kNoteOnKeyswitchTypeID , kOnTheFlyKeyswitchTypeID , kOnReleaseKeyswitchTypeID , kKeyRangeTypeID }
	KeyswitchTypeIDs describes the type of a key switch. More...

enum	PhysicalUITypeIDs { kPUIXMovement , kPUIYMovement , kPUIPressure , kPUITypeCount , kInvalidPUITypeID }
	PhysicalUITypeIDs describes the type of Physical UI (PUI) which could be associated to a note expression. More...

enum	ePrefetchableSupport { kIsNeverPrefetchable , kIsYetPrefetchable , kIsNotYetPrefetchable , kNumPrefetchableSupport }
	Prefetchable Support Enum. More...

enum	ChunkType { kHeader , kComponentState , kControllerState , kProgramData , kMetaInfo , kChunkList , kNumPresetChunks }

Functions
IMessage *	allocateMessage (IHostApplication *host)
	Helper to allocate a message.

tresult	getSpeakerChannelIndex (SpeakerArrangement arrangement, uint64 speaker, int32 &channel)
	Gets the channel index of a given speaker in a arrangement, returns kResultFalse if speaker not part of the arrangement else returns kResultTrue.

const ChunkID &	getChunkID (ChunkType type)

bool	verify (tresult result)

bool	copyStream (IBStream inStream, IBStream outStream)

bool	isEqualID (const ChunkID id1, const ChunkID id2)

Variables
const int32	kDefaultFactoryFlags
	Standard value for PFactoryInfo::flags.

const Speaker	kSpeakerL
	Speaker Definitions.

const Speaker	kSpeakerR
	Right (R)

const Speaker	kSpeakerC
	Center (C)

const Speaker	kSpeakerLfe
	Subbass (Lfe)

const Speaker	kSpeakerLs
	Left Surround (Ls)

const Speaker	kSpeakerRs
	Right Surround (Rs)

const Speaker	kSpeakerLc
	Left of Center (Lc) - Front Left Center.

const Speaker	kSpeakerRc
	Right of Center (Rc) - Front Right Center.

const Speaker	kSpeakerS
	Surround (S)

const Speaker	kSpeakerCs
	Center of Surround (Cs) - Back Center - Surround (S)

const Speaker	kSpeakerSl
	Side Left (Sl)

const Speaker	kSpeakerSr
	Side Right (Sr)

const Speaker	kSpeakerTc
	Top Center Over-head, Top Middle (Tc)

const Speaker	kSpeakerTfl
	Top Front Left (Tfl)

const Speaker	kSpeakerTfc
	Top Front Center (Tfc)

const Speaker	kSpeakerTfr
	Top Front Right (Tfr)

const Speaker	kSpeakerTrl
	Top Rear/Back Left (Trl)

const Speaker	kSpeakerTrc
	Top Rear/Back Center (Trc)

const Speaker	kSpeakerTrr
	Top Rear/Back Right (Trr)

const Speaker	kSpeakerLfe2
	Subbass 2 (Lfe2)

const Speaker	kSpeakerM
	Mono (M)

const Speaker	kSpeakerACN0
	Ambisonic ACN 0.

const Speaker	kSpeakerACN1
	Ambisonic ACN 1.

const Speaker	kSpeakerACN2
	Ambisonic ACN 2.

const Speaker	kSpeakerACN3
	Ambisonic ACN 3.

const Speaker	kSpeakerACN4
	Ambisonic ACN 4.

const Speaker	kSpeakerACN5
	Ambisonic ACN 5.

const Speaker	kSpeakerACN6
	Ambisonic ACN 6.

const Speaker	kSpeakerACN7
	Ambisonic ACN 7.

const Speaker	kSpeakerACN8
	Ambisonic ACN 8.

const Speaker	kSpeakerACN9
	Ambisonic ACN 9.

const Speaker	kSpeakerACN10
	Ambisonic ACN 10.

const Speaker	kSpeakerACN11
	Ambisonic ACN 11.

const Speaker	kSpeakerACN12
	Ambisonic ACN 12.

const Speaker	kSpeakerACN13
	Ambisonic ACN 13.

const Speaker	kSpeakerACN14
	Ambisonic ACN 14.

const Speaker	kSpeakerACN15
	Ambisonic ACN 15.

const Speaker	kSpeakerACN16
	Ambisonic ACN 16.

const Speaker	kSpeakerACN17
	Ambisonic ACN 17.

const Speaker	kSpeakerACN18
	Ambisonic ACN 18.

const Speaker	kSpeakerACN19
	Ambisonic ACN 19.

const Speaker	kSpeakerACN20
	Ambisonic ACN 20.

const Speaker	kSpeakerACN21
	Ambisonic ACN 21.

const Speaker	kSpeakerACN22
	Ambisonic ACN 22.

const Speaker	kSpeakerACN23
	Ambisonic ACN 23.

const Speaker	kSpeakerACN24
	Ambisonic ACN 24.

const Speaker	kSpeakerTsl
	Top Side Left (Tsl)

const Speaker	kSpeakerTsr
	Top Side Right (Tsr)

const Speaker	kSpeakerLcs
	Left of Center Surround (Lcs) - Back Left Center.

const Speaker	kSpeakerRcs
	Right of Center Surround (Rcs) - Back Right Center.

const Speaker	kSpeakerBfl
	Bottom Front Left (Bfl)

const Speaker	kSpeakerBfc
	Bottom Front Center (Bfc)

const Speaker	kSpeakerBfr
	Bottom Front Right (Bfr)

const Speaker	kSpeakerPl
	Proximity Left (Pl)

const Speaker	kSpeakerPr
	Proximity Right (Pr)

const Speaker	kSpeakerBsl
	Bottom Side Left (Bsl)

const Speaker	kSpeakerBsr
	Bottom Side Right (Bsr)

const Speaker	kSpeakerBrl
	Bottom Rear Left (Brl)

const Speaker	kSpeakerBrc
	Bottom Rear Center (Brc)

const Speaker	kSpeakerBrr
	Bottom Rear Right (Brr)

Detailed Description

All VST specific interfaces are located in Vst namespace.

Class Documentation

◆ Steinberg::Vst::AudioBusBuffers.unnamed17

union Steinberg::Vst::AudioBusBuffers.__unnamed17__

Definition at line 198 of file ivstaudioprocessor.h.

Class Members
Sample32 **	channelBuffers32	sample buffers to process with 32-bit precision
Sample64 **	channelBuffers64	sample buffers to process with 64-bit precision

◆ Steinberg::Vst::ChordEvent

struct Steinberg::Vst::ChordEvent

Chord event specific data.

Used in Event (union)

Definition at line 99 of file ivstevents.h.

Class Members
int16	bassNote	range [0, 127] = [C-2, G8] with A3=440Hz
int16	mask	root is bit 0
int16	root	range [0, 127] = [C-2, G8] with A3=440Hz
const TChar *	text	UTF-16, null terminated Hosts Chord Name.
uint16	textLen	the number of characters (TChar) between the beginning of text and the terminating null character (without including the terminating null character itself)

◆ Steinberg::Vst::Event.unnamed15

union Steinberg::Vst::Event.__unnamed15__

Definition at line 173 of file ivstevents.h.

Class Members
ChordEvent	chord	type == kChordEvent
DataEvent	data	type == kDataEvent
LegacyMIDICCOutEvent	midiCCOut	type == kLegacyMIDICCOutEvent
NoteExpressionTextEvent	noteExpressionText	type == kNoteExpressionTextEvent
NoteExpressionValueEvent	noteExpressionValue	type == kNoteExpressionValueEvent
NoteOffEvent	noteOff	type == kNoteOffEvent
NoteOnEvent	noteOn	type == kNoteOnEvent
PolyPressureEvent	polyPressure	type == kPolyPressureEvent
ScaleEvent	scale	type == kScaleEvent

◆ Steinberg::Vst::KeyswitchInfo

struct Steinberg::Vst::KeyswitchInfo

KeyswitchInfo is the structure describing a key switch This structure is used by the method IKeyswitchController::getKeyswitchInfo.

See also: IKeyswitchController

Definition at line 206 of file ivstnoteexpression.h.

Class Members
int32	flags	not yet used (set to 0)
int32	keyRemapped
int32	keyswitchMax	associated main key switch max (value between [0, 127])
int32	keyswitchMin	associated main key switch min (value between [0, 127])
String128	shortTitle	short title (e.g. "Acc")
String128	title	name of key switch (e.g. "Accentuation")
KeyswitchTypeID	typeId	see KeyswitchTypeID
int32	unitId	optional remapped key switch (default -1), the plug-in could provide one remapped key for a key switch (allowing better location on the keyboard of the key switches) id of unit this key switch belongs to (see vst3Units), -1 means no unit used.

◆ Steinberg::Vst::LegacyMIDICCOutEvent

struct Steinberg::Vst::LegacyMIDICCOutEvent

Legacy MIDI CC Out event specific data.

Used in Event (union)

[released: 3.6.12]

This kind of event is reserved for generating MIDI CC as output event for kEvent Bus during the process call.

Definition at line 129 of file ivstevents.h.

Class Members
int8	channel	channel index in event bus [0, 15]
uint8	controlNumber	see enum ControllerNumbers [0, 255]
int8	value	value of Controller [0, 127]
int8	value2	[0, 127] used for pitch bend (kPitchBend) and polyPressure (kCtrlPolyPressure)

◆ Steinberg::Vst::NoteExpressionTextEvent

struct Steinberg::Vst::NoteExpressionTextEvent

Note Expression Text event.

Used in Event (union) A Expression event affects one single playing note.

See also: INoteExpressionController; NoteExpressionTypeInfo

Definition at line 106 of file ivstnoteexpression.h.

Class Members
int32	noteId	associated note identifier to apply the change
const TChar *	text	UTF-16, null terminated.
uint32	textLen	the number of characters (TChar) between the beginning of text and the terminating null character (without including the terminating null character itself)
NoteExpressionTypeID	typeId	see NoteExpressionTypeID (kTextTypeID or kPhoneticTypeID)

◆ Steinberg::Vst::NoteExpressionValueDescription

struct Steinberg::Vst::NoteExpressionValueDescription

Description of a Note Expression Type This structure is part of the NoteExpressionTypeInfo structure, it describes for given NoteExpressionTypeID its default value (for example 0.5 for a kTuningTypeID (kIsBipolar: centered)), its minimum and maximum (for predefined NoteExpressionTypeID the full range is predefined too) and a stepCount when the given NoteExpressionTypeID is limited to discrete values (like on/off state).

See also: NoteExpressionTypeInfo

Definition at line 72 of file ivstnoteexpression.h.

Class Members
NoteExpressionValue	defaultValue	default normalized value [0,1]
NoteExpressionValue	maximum	maximum normalized value [0,1]
NoteExpressionValue	minimum	minimum normalized value [0,1]
int32	stepCount	number of discrete steps (0: continuous, 1: toggle, discrete value otherwise - see vst3ParameterIntro)

◆ Steinberg::Vst::NoteExpressionValueEvent

struct Steinberg::Vst::NoteExpressionValueEvent

Note Expression Value event.

Used in Event (union) A note expression event affects one single playing note (referring its noteId). This kind of event is send from host to the plug-in like other events (NoteOnEvent, NoteOffEvent,...) in ProcessData during the process call. Note expression events for a specific noteId can only occur after a NoteOnEvent. The host must take care that the event list (IEventList) is properly sorted. Expression events are always absolute normalized values [0.0, 1.0]. The predefined types have a predefined mapping of the normalized values (see NoteExpressionTypeIDs)

See also: INoteExpressionController

Definition at line 92 of file ivstnoteexpression.h.

Class Members
int32	noteId	associated note identifier to apply the change
NoteExpressionTypeID	typeId	see NoteExpressionTypeID
NoteExpressionValue	value	normalized value [0.0, 1.0].

◆ Steinberg::Vst::NoteOffEvent

struct Steinberg::Vst::NoteOffEvent

Note-off event specific data.

Used in Event (union)

Definition at line 57 of file ivstevents.h.

Class Members
int16	channel	channel index in event bus
int32	noteId	associated noteOn identifier (if not available then -1)
int16	pitch	range [0, 127] = [C-2, G8] with A3=440Hz (12-TET)
float	tuning	1.f = +1 cent, -1.f = -1 cent
float	velocity	range [0.0, 1.0]

◆ Steinberg::Vst::NoteOnEvent

struct Steinberg::Vst::NoteOnEvent

Note-on event specific data.

Used in Event (union)

Pitch uses the twelve-tone equal temperament tuning (12-TET).

Definition at line 43 of file ivstevents.h.

Class Members
int16	channel	channel index in event bus
int32	length	in sample frames (optional, Note Off has to follow in any case!)
int32	noteId	note identifier (if not available then -1)
int16	pitch	range [0, 127] = [C-2, G8] with A3=440Hz (12-TET: twelve-tone equal temperament)
float	tuning	1.f = +1 cent, -1.f = -1 cent
float	velocity	range [0.0, 1.0]

◆ Steinberg::Vst::PhysicalUIMap

struct Steinberg::Vst::PhysicalUIMap

PhysicalUIMap describes a mapping of a noteExpression Type to a Physical UI Type.

It is used in PhysicalUIMapList.

See also: PhysicalUIMapList

Definition at line 61 of file ivstphysicalui.h.

Class Members
NoteExpressionTypeID	noteExpressionTypeID	This represents the associated noteExpression TypeID to the given physicalUITypeID. This will be filled by the plug-in in the call getPhysicalUIMapping, set it to kInvalidTypeID if no Note Expression is associated to the given PUI.
PhysicalUITypeID	physicalUITypeID	This represents the physical UI. /see PhysicalUITypeIDs, this is set by the caller of getPhysicalUIMapping

◆ Steinberg::Vst::PhysicalUIMapList

struct Steinberg::Vst::PhysicalUIMapList

PhysicalUIMapList describes a list of PhysicalUIMap.

See also: INoteExpressionPhysicalUIMapping

Definition at line 77 of file ivstphysicalui.h.

Class Members
uint32	count	Count of entries in the map array, set by the caller of getPhysicalUIMapping.
PhysicalUIMap *	map	Pointer to a list of PhysicalUIMap containing count entries.

◆ Steinberg::Vst::PolyPressureEvent

struct Steinberg::Vst::PolyPressureEvent

PolyPressure event specific data.

Used in Event (union)

Definition at line 87 of file ivstevents.h.

Class Members
int16	channel	channel index in event bus
int32	noteId	event should be applied to the noteId (if not -1)
int16	pitch	range [0, 127] = [C-2, G8] with A3=440Hz
float	pressure	range [0.0, 1.0]

◆ Steinberg::Vst::ProcessSetup

struct Steinberg::Vst::ProcessSetup

Audio processing setup.

See also: IAudioProcessor::setupProcessing

Definition at line 165 of file ivstaudioprocessor.h.

Class Members
int32	maxSamplesPerBlock	maximum number of samples per audio block
int32	processMode	ProcessModes
SampleRate	sampleRate	sample rate
int32	symbolicSampleSize	SymbolicSampleSizes

◆ Steinberg::Vst::ProgramListInfo

struct Steinberg::Vst::ProgramListInfo

Basic Program List Description.

See also: IUnitInfo

Definition at line 56 of file ivstunits.h.

Class Members
ProgramListID	id	program list identifier
String128	name	name of program list
int32	programCount	number of programs in this list

◆ Steinberg::Vst::RoutingInfo

struct Steinberg::Vst::RoutingInfo

Routing Information: When the plug-in supports multiple I/O busses, a host may want to know how the busses are related.

The relation of an event-input-channel to an audio-output-bus in particular is of interest to the host (in order to relate MIDI-tracks to audio-channels)
See also: IComponent::getRoutingInfo, vst3Routing

Definition at line 135 of file ivstcomponent.h.

Class Members
int32	busIndex	bus index
int32	channel	channel (-1 for all channels)
MediaType	mediaType	media type see MediaTypes

◆ Steinberg::Vst::ScaleEvent

struct Steinberg::Vst::ScaleEvent

Scale event specific data.

Used in Event (union)

Definition at line 113 of file ivstevents.h.

Class Members
int16	mask	Bit 0 = C, Bit 1 = C#, ... (0x5ab5 = Major Scale)
int16	root	range [0, 127] = root Note/Transpose Factor
const TChar *	text	UTF-16, null terminated, Hosts Scale Name.
uint16	textLen	the number of characters (TChar) between the beginning of text and the terminating null character (without including the terminating null character itself)

◆ Steinberg::Vst::UnitInfo

struct Steinberg::Vst::UnitInfo

Basic Unit Description.

See also: IUnitInfo

Definition at line 44 of file ivstunits.h.

Class Members
UnitID	id	unit identifier
String128	name	name, optional for the root component, required otherwise
UnitID	parentUnitId	identifier of parent unit (kNoParentUnitId: does not apply, this unit is the root)
ProgramListID	programListId	id of program list used in unit (kNoProgramListId = no programs used in this unit)

Typedef Documentation

◆ BusDirection

typedef int32 Steinberg::Vst::BusDirection

bus direction (in/out)

Definition at line 76 of file vsttypes.h.

◆ BusType

typedef int32 Steinberg::Vst::BusType

bus type (main/aux)

Definition at line 77 of file vsttypes.h.

◆ ChunkID

using Steinberg::Vst::ChunkID = typedef char[4]

Definition at line 84 of file vstpresetfile.h.

◆ ColorSpec

typedef uint32 Steinberg::Vst::ColorSpec

color defining by 4 component ARGB value (Alpha/Red/Green/Blue)

Definition at line 88 of file vsttypes.h.

◆ CString

typedef const char8* Steinberg::Vst::CString

C-String.

Definition at line 70 of file vsttypes.h.

◆ CtrlNumber

typedef int16 Steinberg::Vst::CtrlNumber

MIDI controller number (see ControllerNumbers for allowed values)

Definition at line 83 of file vsttypes.h.

◆ IoMode

typedef int32 Steinberg::Vst::IoMode

I/O mode (see vst3IoMode)

Definition at line 78 of file vsttypes.h.

◆ KeyswitchTypeID

typedef uint32 Steinberg::Vst::KeyswitchTypeID

Definition at line 199 of file ivstnoteexpression.h.

◆ KnobMode

typedef int32 Steinberg::Vst::KnobMode

Knob Mode Type.

Definition at line 465 of file ivsteditcontroller.h.

◆ MediaType

typedef int32 Steinberg::Vst::MediaType

media type (audio/event)

Definition at line 75 of file vsttypes.h.

◆ NoteExpressionTypeID

typedef uint32 Steinberg::Vst::NoteExpressionTypeID

Note Expression Types.

Definition at line 35 of file ivstnoteexpression.h.

◆ NoteExpressionValue

typedef double Steinberg::Vst::NoteExpressionValue

Note Expression Value.

Definition at line 37 of file ivstnoteexpression.h.

◆ ParamID

typedef uint32 Steinberg::Vst::ParamID

parameter identifier

Definition at line 81 of file vsttypes.h.

◆ ParamValue

typedef double Steinberg::Vst::ParamValue

parameter value type

Definition at line 80 of file vsttypes.h.

◆ PhysicalUITypeID

typedef uint32 Steinberg::Vst::PhysicalUITypeID

Physical UI Type.

Definition at line 34 of file ivstphysicalui.h.

◆ PrefetchableSupport

typedef uint32 Steinberg::Vst::PrefetchableSupport

Prefetchable Support Type.

Definition at line 35 of file ivstprefetchablesupport.h.

◆ ProgramListID

typedef int32 Steinberg::Vst::ProgramListID

program list identifier

Definition at line 82 of file vsttypes.h.

◆ Sample32

typedef float Steinberg::Vst::Sample32

32-bit precision audio sample

Definition at line 97 of file vsttypes.h.

◆ Sample64

typedef double Steinberg::Vst::Sample64

64-bit precision audio sample

Definition at line 98 of file vsttypes.h.

◆ SampleRate

typedef double Steinberg::Vst::SampleRate

sample rate

Definition at line 99 of file vsttypes.h.

◆ Speaker

typedef uint64 Steinberg::Vst::Speaker

Bit for one speaker.

Definition at line 105 of file vsttypes.h.

◆ SpeakerArrangement

typedef uint64 Steinberg::Vst::SpeakerArrangement

Bitset of speakers.

Definition at line 104 of file vsttypes.h.

◆ String128

typedef TChar Steinberg::Vst::String128[128]

128 character UTF-16 string

Definition at line 69 of file vsttypes.h.

◆ TChar

typedef char16 Steinberg::Vst::TChar

UTF-16 character.

Definition at line 68 of file vsttypes.h.

◆ TQuarterNotes

typedef double Steinberg::Vst::TQuarterNotes

time expressed in quarter notes

Definition at line 85 of file vsttypes.h.

◆ TSamples

typedef int64 Steinberg::Vst::TSamples

time expressed in audio samples

Definition at line 86 of file vsttypes.h.

◆ UnitID

typedef int32 Steinberg::Vst::UnitID

unit identifier

Definition at line 79 of file vsttypes.h.

Enumeration Type Documentation

◆ BusDirections

enum Steinberg::Vst::BusDirections

Bus directions.

Enumerator
kInput	input bus
kOutput	output bus

Definition at line 73 of file ivstcomponent.h.

◆ BusTypes

enum Steinberg::Vst::BusTypes

Bus types.

Enumerator
kMain	main bus
kAux	auxiliary bus (sidechain)

Definition at line 81 of file ivstcomponent.h.

◆ ChunkType

enum Steinberg::Vst::ChunkType

Definition at line 87 of file vstpresetfile.h.

◆ ComponentFlags

enum Steinberg::Vst::ComponentFlags

Component Flags used as classFlags in PClassInfo2.

Enumerator
kDistributable	Component can be run on remote computer.
kSimpleModeSupported	Component supports simple IO mode (or works in simple mode anyway) see vst3IoMode.

Definition at line 98 of file ivstaudioprocessor.h.

◆ ControllerNumbers

enum Steinberg::Vst::ControllerNumbers

Controller Numbers (MIDI)

Enumerator
kCtrlBankSelectMSB	Bank Select MSB.
kCtrlModWheel	Modulation Wheel.
kCtrlBreath	Breath controller.
kCtrlFoot	Foot Controller.
kCtrlPortaTime	Portamento Time.
kCtrlDataEntryMSB	Data Entry MSB.
kCtrlVolume	Channel Volume (formerly Main Volume)
kCtrlBalance	Balance.
kCtrlPan	Pan.
kCtrlExpression	Expression.
kCtrlEffect1	Effect Control 1.
kCtrlEffect2	Effect Control 2.
kCtrlGPC1	General Purpose Controller #1.
kCtrlGPC2	General Purpose Controller #2.
kCtrlGPC3	General Purpose Controller #3.
kCtrlGPC4	General Purpose Controller #4.
kCtrlBankSelectLSB	Bank Select LSB.
kCtrlDataEntryLSB	Data Entry LSB.
kCtrlSustainOnOff	Damper Pedal On/Off (Sustain)
kCtrlPortaOnOff	Portamento On/Off.
kCtrlSustenutoOnOff	Sustenuto On/Off.
kCtrlSoftPedalOnOff	Soft Pedal On/Off.
kCtrlLegatoFootSwOnOff	Legato Footswitch On/Off.
kCtrlHold2OnOff	Hold 2 On/Off.
kCtrlSoundVariation	Sound Variation.
kCtrlFilterCutoff	Filter Cutoff (Timbre/Harmonic Intensity)
kCtrlReleaseTime	Release Time.
kCtrlAttackTime	Attack Time.
kCtrlFilterResonance	Filter Resonance (Brightness)
kCtrlDecayTime	Decay Time.
kCtrlVibratoRate	Vibrato Rate.
kCtrlVibratoDepth	Vibrato Depth.
kCtrlVibratoDelay	Vibrato Delay.
kCtrlSoundCtrler10	undefined
kCtrlGPC5	General Purpose Controller #5.
kCtrlGPC6	General Purpose Controller #6.
kCtrlGPC7	General Purpose Controller #7.
kCtrlGPC8	General Purpose Controller #8.
kCtrlPortaControl	Portamento Control.
kCtrlEff1Depth	Effect 1 Depth (Reverb Send Level)
kCtrlEff2Depth	Effect 2 Depth (Tremolo Level)
kCtrlEff3Depth	Effect 3 Depth (Chorus Send Level)
kCtrlEff4Depth	Effect 4 Depth (Delay/Variation/Detune Level)
kCtrlEff5Depth	Effect 5 Depth (Phaser Level)
kCtrlDataIncrement	Data Increment (+1)
kCtrlDataDecrement	Data Decrement (-1)
kCtrlNRPNSelectLSB	NRPN Select LSB.
kCtrlNRPNSelectMSB	NRPN Select MSB.
kCtrlRPNSelectLSB	RPN Select LSB.
kCtrlRPNSelectMSB	RPN Select MSB.
kCtrlAllSoundsOff	All Sounds Off.
kCtrlResetAllCtrlers	Reset All Controllers.
kCtrlLocalCtrlOnOff	Local Control On/Off.
kCtrlAllNotesOff	All Notes Off.
kCtrlOmniModeOff	Omni Mode Off + All Notes Off.
kCtrlOmniModeOn	Omni Mode On + All Notes Off.
kCtrlPolyModeOnOff	Poly Mode On/Off + All Sounds Off.
kCtrlPolyModeOn	Poly Mode On.
kAfterTouch	After Touch (associated to Channel Pressure)
kPitchBend	Pitch Bend Change.
kCountCtrlNumber	Count of Controller Number.
kCtrlProgramChange	Program Change (use LegacyMIDICCOutEvent.value only)
kCtrlPolyPressure	Polyphonic Key Pressure (use LegacyMIDICCOutEvent.value for pitch and LegacyMIDICCOutEvent.value2 for pressure)
kCtrlQuarterFrame	Quarter Frame ((use LegacyMIDICCOutEvent.value only)

Definition at line 25 of file ivstmidicontrollers.h.

◆ ePrefetchableSupport

enum Steinberg::Vst::ePrefetchableSupport

Prefetchable Support Enum.

Enumerator
kIsNeverPrefetchable	every instance of the plug does not support prefetch processing
kIsYetPrefetchable	in the current state the plug support prefetch processing
kIsNotYetPrefetchable	in the current state the plug does not support prefetch processing

Definition at line 39 of file ivstprefetchablesupport.h.

◆ IoModes

enum Steinberg::Vst::IoModes

I/O modes.

Enumerator
kSimple	1:1 Input / Output. Only used for Instruments. See vst3IoMode
kAdvanced	n:m Input / Output. Only used for Instruments.
kOfflineProcessing	plug-in used in an offline processing context

Definition at line 121 of file ivstcomponent.h.

◆ KeyswitchTypeIDs

enum Steinberg::Vst::KeyswitchTypeIDs : uint32

KeyswitchTypeIDs describes the type of a key switch.

See also: KeyswitchInfo

Enumerator
kNoteOnKeyswitchTypeID	press before noteOn is played
kOnTheFlyKeyswitchTypeID	press while noteOn is played
kOnReleaseKeyswitchTypeID	press before entering release
kKeyRangeTypeID	key should be maintained pressed for playing

Definition at line 191 of file ivstnoteexpression.h.

◆ KnobModes

enum Steinberg::Vst::KnobModes

Knob Mode.

Enumerator
kCircularMode	Circular with jump to clicked position.
kRelativCircularMode	Circular without jump to clicked position.
kLinearMode	Linear: depending on vertical movement.

Definition at line 453 of file ivsteditcontroller.h.

◆ MediaTypes

enum Steinberg::Vst::MediaTypes

Bus media types.

Enumerator
kAudio	audio
kEvent	events

Definition at line 64 of file ivstcomponent.h.

◆ NoteExpressionTypeIDs

enum Steinberg::Vst::NoteExpressionTypeIDs : uint32

NoteExpressionTypeIDs describes the type of the note expression.

VST predefines some types like volume, pan, tuning by defining their ranges and curves. Used by NoteExpressionEvent::typeId and NoteExpressionTypeID::typeId

See also: NoteExpressionTypeInfo

Enumerator
kVolumeTypeID	Volume, plain range [0 = -oo , 0.25 = 0dB, 0.5 = +6dB, 1 = +12dB]: plain = 20 * log (4 * norm)
kPanTypeID	Panning (L-R), plain range [0 = left, 0.5 = center, 1 = right].
kTuningTypeID	Tuning, plain range [0 = -120.0 (ten octaves down), 0.5 none, 1 = +120.0 (ten octaves up)] plain = 240 * (norm - 0.5) and norm = plain / 240 + 0.5 oneOctave is 12.0 / 240.0; oneHalfTune = 1.0 / 240.0;.
kVibratoTypeID	Vibrato.
kExpressionTypeID	Expression.
kBrightnessTypeID	Brightness.
kTextTypeID	See NoteExpressionTextEvent.
kPhonemeTypeID	TODO:
kCustomStart	start of custom note expression type ids
kCustomEnd	end of custom note expression type ids
kInvalidTypeID	indicates an invalid note expression type

Definition at line 46 of file ivstnoteexpression.h.

◆ NoteIDUserRange

enum Steinberg::Vst::NoteIDUserRange

Reserved note identifier (noteId) range for a plug-in.

Guaranteed not used by the host.

Definition at line 32 of file ivstevents.h.

◆ PhysicalUITypeIDs

enum Steinberg::Vst::PhysicalUITypeIDs

PhysicalUITypeIDs describes the type of Physical UI (PUI) which could be associated to a note expression.

See also: PhysicalUIMap

Enumerator
kPUIXMovement	absolute X position when touching keys of PUIs. Range [0=left, 0.5=middle, 1=right]
kPUIYMovement	absolute Y position when touching keys of PUIs. Range [0=bottom/near, 0.5=center, 1=top/far]
kPUIPressure	pressing a key down on keys of PUIs. Range [0=No Pressure, 1=Full Pressure]
kPUITypeCount	count of current defined PUIs
kInvalidPUITypeID	indicates an invalid or not initialized PUI type

Definition at line 42 of file ivstphysicalui.h.

◆ ProcessModes

enum Steinberg::Vst::ProcessModes

Processing mode informs the plug-in about the context and at which frequency the process call is called.

VST3 defines 3 modes:

kRealtime: each process call is called at a realtime frequency (defined by [numSamples of ProcessData] / samplerate). The plug-in should always try to process as fast as possible in order to let enough time slice to other plug-ins.
kPrefetch: each process call could be called at a variable frequency (jitter, slower / faster than realtime), the plug-in should process at the same quality level than realtime, plug-in must not slow down to realtime (e.g. disk streaming)! The host should avoid to process in kPrefetch mode such sampler based plug-in.
kOffline: each process call could be faster than realtime or slower, higher quality than realtime could be used. plug-ins using disk streaming should be sure that they have enough time in the process call for streaming, if needed by slowing down to realtime or slower.

Note about Process Modes switching:

Switching between kRealtime and kPrefetch process modes are done in realtime thread without need of calling IAudioProcessor::setupProcessing, the plug-in should check in process call the member processMode of ProcessData in order to know in which mode it is processed.
Switching between kRealtime (or kPrefetch) and kOffline requires that the host calls IAudioProcessor::setupProcessing in order to inform the plug-in about this mode change.

See also: ProcessSetup, ProcessData

Enumerator
kRealtime	realtime processing
kPrefetch	prefetch processing
kOffline	offline processing

Definition at line 138 of file ivstaudioprocessor.h.

◆ RestartFlags

enum Steinberg::Vst::RestartFlags

Flags used for IComponentHandler::restartComponent.

Enumerator
kReloadComponent	The Component should be reloaded The host has to unload completely the plug-in (controller/processor) and reload it. [SDK 3.0.0]
kIoChanged	Input / Output Bus configuration has changed The plug-in informs the host that either the bus configuration or the bus count has changed. The host has to deactivate the plug-in, asks the plug-in for its wanted new bus configurations, adapts its processing graph and reactivate the plug-in. [SDK 3.0.0]
kParamValuesChanged	Multiple parameter values have changed (as result of a program change for example) The host invalidates all caches of parameter values and asks the edit controller for the current values. [SDK 3.0.0]
kLatencyChanged	Latency has changed The plug informs the host that its latency has changed, getLatencySamples should return the new latency after setActive (true) was called The host has to deactivate and reactivate the plug-in, then afterwards the host could ask for the current latency (getLatencySamples) see IAudioProcessor::getLatencySamples [SDK 3.0.0].
kParamTitlesChanged	Parameter titles, default values or flags (ParameterFlags) have changed The host invalidates all caches of parameter infos and asks the edit controller for the current infos. [SDK 3.0.0]
kMidiCCAssignmentChanged	MIDI Controllers and/or Program Changes Assignments have changed The plug-in informs the host that its MIDI-CC mapping has changed (for example after a MIDI learn or new loaded preset) or if the stepCount or UnitID of a ProgramChange parameter has changed. The host has to rebuild the MIDI-CC => parameter mapping (getMidiControllerAssignment) and reread program changes parameters (stepCount and associated unitID) [SDK 3.0.1]
kNoteExpressionChanged	Note Expression has changed (info, count, PhysicalUIMapping, ...) Either the note expression type info, the count of note expressions or the physical UI mapping has changed. The host invalidates all caches of note expression infos and asks the edit controller for the current ones. See INoteExpressionController, NoteExpressionTypeInfo and INoteExpressionPhysicalUIMapping [SDK 3.5.0]
kIoTitlesChanged	Input / Output bus titles have changed The host invalidates all caches of bus titles and asks the edit controller for the current titles. [SDK 3.5.0]
kPrefetchableSupportChanged	Prefetch support has changed The plug-in informs the host that its PrefetchSupport has changed The host has to deactivate the plug-in, calls IPrefetchableSupport::getPrefetchableSupport and reactivate the plug-in see IPrefetchableSupport [SDK 3.6.1].
kRoutingInfoChanged	RoutingInfo has changed The plug-in informs the host that its internal routing (relation of an event-input-channel to an audio-output-bus) has changed The host ask the plug-in for the new routing with IComponent::getRoutingInfo, vst3Routing see IComponent [SDK 3.6.6].
kKeyswitchChanged	Key switches has changed (info, count) Either the Key switches info, the count of Key switches has changed. The host invalidates all caches of Key switches infos and asks the edit controller (IKeyswitchController) for the current ones. See IKeyswitchController [SDK 3.7.3]

Definition at line 86 of file ivsteditcontroller.h.

◆ SymbolicSampleSizes

enum Steinberg::Vst::SymbolicSampleSizes

Symbolic sample size.

See also: ProcessSetup, ProcessData

Enumerator
kSample32	32-bit precision
kSample64	64-bit precision

Definition at line 110 of file ivstaudioprocessor.h.

Function Documentation

◆ allocateMessage()

IMessage * Steinberg::Vst::allocateMessage ( IHostApplication * host )

Helper to allocate a message.

Definition at line 53 of file ivsthostapplication.h.

◆ copyStream()

bool Steinberg::Vst::copyStream	(	IBStream *	inStream,
		IBStream *	outStream
	)

Definition at line 79 of file vstpresetfile.cpp.

◆ getChunkID()

const ChunkID & Steinberg::Vst::getChunkID ( ChunkType type )

Definition at line 63 of file vstpresetfile.cpp.

◆ getSpeakerChannelIndex()

tresult Steinberg::Vst::getSpeakerChannelIndex	(	SpeakerArrangement	arrangement,
		uint64	speaker,
		int32 &	channel
	)

Gets the channel index of a given speaker in a arrangement, returns kResultFalse if speaker not part of the arrangement else returns kResultTrue.

Definition at line 210 of file vstcomponent.cpp.

◆ isEqualID()

bool Steinberg::Vst::isEqualID	(	const ChunkID	id1,
		const ChunkID	id2
	)

Definition at line 102 of file vstpresetfile.h.

◆ verify()

bool Steinberg::Vst::verify ( tresult result )

Definition at line 73 of file vstpresetfile.cpp.

Variable Documentation

◆ kDefaultFactoryFlags

const int32 Steinberg::Vst::kDefaultFactoryFlags

Standard value for PFactoryInfo::flags.

Definition at line 34 of file ivstcomponent.h.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Class Documentation

◆ Steinberg::Vst::AudioBusBuffers.__unnamed17__

◆ Steinberg::Vst::ChordEvent

◆ Steinberg::Vst::Event.__unnamed15__

◆ Steinberg::Vst::KeyswitchInfo

◆ Steinberg::Vst::LegacyMIDICCOutEvent

◆ Steinberg::Vst::NoteExpressionTextEvent

◆ Steinberg::Vst::NoteExpressionValueDescription

◆ Steinberg::Vst::NoteExpressionValueEvent

◆ Steinberg::Vst::NoteOffEvent

◆ Steinberg::Vst::NoteOnEvent

◆ Steinberg::Vst::PhysicalUIMap

◆ Steinberg::Vst::PhysicalUIMapList

◆ Steinberg::Vst::PolyPressureEvent

◆ Steinberg::Vst::ProcessSetup

◆ Steinberg::Vst::ProgramListInfo

◆ Steinberg::Vst::RoutingInfo

◆ Steinberg::Vst::ScaleEvent

◆ Steinberg::Vst::UnitInfo

Typedef Documentation

◆ BusDirection

◆ BusType

◆ ChunkID

◆ ColorSpec

◆ CString

◆ CtrlNumber

◆ IoMode

◆ KeyswitchTypeID

◆ KnobMode

◆ MediaType

◆ NoteExpressionTypeID

◆ NoteExpressionValue

◆ ParamID

◆ ParamValue

◆ PhysicalUITypeID

◆ PrefetchableSupport

◆ ProgramListID

◆ Sample32

◆ Sample64

◆ SampleRate

◆ Speaker

◆ SpeakerArrangement

◆ String128

◆ TChar

◆ TQuarterNotes

◆ TSamples

◆ UnitID

Enumeration Type Documentation

◆ BusDirections

◆ BusTypes

◆ ChunkType

◆ ComponentFlags

◆ ControllerNumbers

◆ ePrefetchableSupport

◆ IoModes

◆ KeyswitchTypeIDs

◆ KnobModes

◆ MediaTypes

◆ NoteExpressionTypeIDs

◆ NoteIDUserRange

◆ PhysicalUITypeIDs

◆ ProcessModes

◆ RestartFlags

◆ SymbolicSampleSizes

Function Documentation

◆ allocateMessage()

◆ copyStream()

◆ getChunkID()

◆ getSpeakerChannelIndex()

◆ isEqualID()

◆ verify()

Variable Documentation

◆ kDefaultFactoryFlags

◆ Steinberg::Vst::AudioBusBuffers.unnamed17

◆ Steinberg::Vst::Event.unnamed15