VST 3 Examples  VST 3.6.14
SDK for developing VST Plug-in
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Plug Class Reference

#include <plug.h>

+ Inheritance diagram for Plug:

Public Member Functions

 Plug ()
 
tresult initialize (FUnknown *context) SMTG_OVERRIDE
 Called at first after constructor. More...
 
tresult process (ProcessData &data) SMTG_OVERRIDE
 Here we go...the process call. More...
 
tresult setState (IBStream *state) SMTG_OVERRIDE
 For persistence. More...
 
tresult getState (IBStream *state) SMTG_OVERRIDE
 
 Plug ()
 
tresult initialize (FUnknown *context) SMTG_OVERRIDE
 Called at first after constructor. More...
 
tresult process (ProcessData &data) SMTG_OVERRIDE
 Here we go...the process call. More...
 
tresult setState (IBStream *state) SMTG_OVERRIDE
 For persistence. More...
 
tresult getState (IBStream *state) SMTG_OVERRIDE
 
tresult sendTextMessage (const char16 *text)
 
 Plug ()
 
tresult initialize (FUnknown *context) SMTG_OVERRIDE
 Called at first after constructor. More...
 
tresult process (ProcessData &data) SMTG_OVERRIDE
 Here we go...the process call. More...
 
tresult setState (IBStream *state) SMTG_OVERRIDE
 For persistence. More...
 
tresult getState (IBStream *state) SMTG_OVERRIDE
 
tresult getPrefetchableSupport (PrefetchableSupport &prefetchable) SMTG_OVERRIDE
 
 Plug ()
 
tresult initialize (FUnknown *context) SMTG_OVERRIDE
 Called at first after constructor. More...
 
tresult process (ProcessData &data) SMTG_OVERRIDE
 Here we go...the process call. More...
 
tresult setState (IBStream *state) SMTG_OVERRIDE
 For persistence. More...
 
tresult getState (IBStream *state) SMTG_OVERRIDE
 
- Public Member Functions inherited from AudioEffect
 AudioEffect ()
 
AudioBusaddAudioInput (const TChar *name, SpeakerArrangement arr, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 
AudioBusaddAudioOutput (const TChar *name, SpeakerArrangement arr, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 
AudioBusgetAudioInput (int32 index)
 
AudioBusgetAudioOutput (int32 index)
 
EventBusaddEventInput (const TChar *name, int32 channels=16, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 
EventBusaddEventOutput (const TChar *name, int32 channels=16, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 
EventBusgetEventInput (int32 index)
 
EventBusgetEventOutput (int32 index)
 
tresult setBusArrangements (SpeakerArrangement *inputs, int32 numIns, SpeakerArrangement *outputs, int32 numOuts) SMTG_OVERRIDE
 
tresult getBusArrangement (BusDirection dir, int32 busIndex, SpeakerArrangement &arr) SMTG_OVERRIDE
 
tresult canProcessSampleSize (int32 symbolicSampleSize) SMTG_OVERRIDE
 
uint32 getLatencySamples () SMTG_OVERRIDE
 
tresult setupProcessing (ProcessSetup &setup) SMTG_OVERRIDE
 
tresult setProcessing (TBool state) SMTG_OVERRIDE
 
uint32 getTailSamples () SMTG_OVERRIDE
 
 Component ()
 
void setControllerClass (const FUID &cid)
 
tresult removeAudioBusses ()
 
tresult removeEventBusses ()
 
tresult renameBus (MediaType type, BusDirection dir, int32 index, const String128 newName)
 
tresult getControllerClassId (TUID classID) SMTG_OVERRIDE
 
tresult setIoMode (IoMode mode) SMTG_OVERRIDE
 
int32 getBusCount (MediaType type, BusDirection dir) SMTG_OVERRIDE
 
tresult getBusInfo (MediaType type, BusDirection dir, int32 index, BusInfo &info) SMTG_OVERRIDE
 
tresult getRoutingInfo (RoutingInfo &inInfo, RoutingInfo &outInfo) SMTG_OVERRIDE
 
tresult activateBus (MediaType type, BusDirection dir, int32 index, TBool state) SMTG_OVERRIDE
 
tresult setActive (TBool state) SMTG_OVERRIDE
 
tresult terminate () SMTG_OVERRIDE
 
BusListgetBusList (MediaType type, BusDirection dir)
 
tresult removeAllBusses ()
 
 ComponentBase ()
 
 ~ComponentBase () override
 
FUnknowngetHostContext () const
 
IConnectionPointgetPeer () const
 
IMessageallocateMessage ()
 
tresult sendMessage (IMessage *message)
 
tresult sendTextMessage (const char8 *text)
 
virtual tresult receiveText (const char8 *text)
 
tresult terminate () SMTG_OVERRIDE
 
tresult connect (IConnectionPoint *other) SMTG_OVERRIDE
 
tresult disconnect (IConnectionPoint *other) SMTG_OVERRIDE
 
tresult notify (IMessage *message) SMTG_OVERRIDE
 
- Public Member Functions inherited from FUnknown
virtual tresult queryInterface (const TUID _iid, void **obj)=0
 
virtual uint32 addRef ()=0
 
virtual uint32 release ()=0
 

Static Public Member Functions

static FUnknowncreateInstance (void *context)
 
static FUnknowncreateInstance (void *context)
 
static FUnknowncreateInstance (void *context)
 
static FUnknowncreateInstance (void *context)
 

Public Attributes

OBJ_METHODS(Plug, AudioEffect)
DEFINE_INTERFACES
DEF_INTERFACE(Vst int32 
mPrefetchableMode
 
- Public Attributes inherited from AudioEffect
OBJ_METHODS(Component,
ComponentBase)
DEFINE_INTERFACES
DEF_INTERFACE(IComponent)
END_DEFINE_INTERFACES(ComponentBase)
REFCOUNT_METHODS(ComponentBase)
protected BusList 
audioInputs
 
BusList audioOutputs
 
BusList eventInputs
 
BusList eventOutputs
 
OBJ_METHODS(ComponentBase,
FObject) DEFINE_INTERFACES
DEF_INTERFACE(IPluginBase)
DEF_INTERFACE(IConnectionPoint)
END_DEFINE_INTERFACES(FObject)
REFCOUNT_METHODS(FObject)
protected IPtr
< IConnectionPoint
peerConnection
 

Protected Attributes

bool bBypass
 
int32 mLastNoteOnId
 
int32 mLastNoteOnPitch
 
int32 currentProgram
 
float currentGainValue
 

Additional Inherited Members

- Static Public Attributes inherited from IPluginBase
static const FUID iid
 
- Static Public Attributes inherited from FUnknown
static const FUID iid
 
- Static Public Attributes inherited from IConnectionPoint
static const FUID iid
 
- Static Public Attributes inherited from IComponent
static const FUID iid
 
- Static Public Attributes inherited from IAudioProcessor
static const FUID iid
 
- Static Public Attributes inherited from IPrefetchableSupport
static const FUID iid
 

Constructor & Destructor Documentation

Plug ( )
Plug ( )
Plug ( )
Plug ( )

Member Function Documentation

static FUnknown* createInstance ( void *  context)
inlinestatic
tresult initialize ( FUnknown context)
virtual

Called at first after constructor.

Reimplemented from AudioEffect.

tresult process ( ProcessData data)
virtual

Here we go...the process call.

Reimplemented from AudioEffect.

tresult setState ( IBStream state)
virtual

For persistence.

Reimplemented from AudioEffect.

tresult getState ( IBStream state)
virtual

Reimplemented from AudioEffect.

static FUnknown* createInstance ( void *  context)
inlinestatic
tresult initialize ( FUnknown context)
virtual

Called at first after constructor.

Reimplemented from AudioEffect.

tresult process ( ProcessData data)
virtual

Here we go...the process call.

Reimplemented from AudioEffect.

tresult setState ( IBStream state)
virtual

For persistence.

Reimplemented from AudioEffect.

tresult getState ( IBStream state)
virtual

Reimplemented from AudioEffect.

tresult sendTextMessage ( const char16 text)
static FUnknown* createInstance ( void *  context)
inlinestatic
tresult initialize ( FUnknown context)
virtual

Called at first after constructor.

Reimplemented from AudioEffect.

tresult process ( ProcessData data)
virtual

Here we go...the process call.

Reimplemented from AudioEffect.

tresult setState ( IBStream state)
virtual

For persistence.

Reimplemented from AudioEffect.

tresult getState ( IBStream state)
virtual

Reimplemented from AudioEffect.

tresult getPrefetchableSupport ( PrefetchableSupport prefetchable)
virtual

Implements IPrefetchableSupport.

static FUnknown* createInstance ( void *  context)
inlinestatic
tresult initialize ( FUnknown context)
virtual

Called at first after constructor.

Reimplemented from AudioEffect.

tresult process ( ProcessData data)
virtual

Here we go...the process call.

Reimplemented from AudioEffect.

tresult setState ( IBStream state)
virtual

For persistence.

Reimplemented from AudioEffect.

tresult getState ( IBStream state)
virtual

Reimplemented from AudioEffect.

Member Data Documentation

bool bBypass
protected
int32 mLastNoteOnId
protected
int32 mLastNoteOnPitch
protected
OBJ_METHODS (Plug, AudioEffect) DEFINE_INTERFACES DEF_INTERFACE (Vst int32 mPrefetchableMode
int32 currentProgram
protected
float currentGainValue
protected
Empty

Copyright ©2019 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.