VST 3 Examples  VST 3.6.6
SDK for developing VST Plug-in
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Attributes
Plug Class Reference

#include <plug.h>

+ Inheritance diagram for Plug:

Public Member Functions

 Plug ()
 
tresult initialize (FUnknown *context) override
 Called at first after constructor. More...
 
tresult process (ProcessData &data) override
 Here we go...the process call. More...
 
tresult setState (IBStream *state) override
 For persistence. More...
 
tresult getState (IBStream *state) override
 
 Plug ()
 
tresult initialize (FUnknown *context) override
 Called at first after constructor. More...
 
tresult process (ProcessData &data) override
 Here we go...the process call. More...
 
tresult setState (IBStream *state) override
 For persistence. More...
 
tresult getState (IBStream *state) override
 
tresult getPrefetchableSupport (PrefetchableSupport &prefetchable) 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)
 
tresult getBusArrangement (BusDirection dir, int32 busIndex, SpeakerArrangement &arr)
 
tresult canProcessSampleSize (int32 symbolicSampleSize)
 
uint32 getLatencySamples ()
 
tresult setupProcessing (ProcessSetup &setup)
 
tresult setProcessing (TBool state)
 
uint32 getTailSamples ()
 
 OBJ_METHODS (AudioEffect, Component) DEFINE_INTERFACES DEF_INTERFACE(IAudioProcessor) END_DEFINE_INTERFACES(Component) REFCOUNT_METHODS(Component) void **getChannelBuffersPointer(const AudioBusBuffers &bufs) const
 
uint32 getSampleFramesSizeInBytes (int32 numSamples)
 
 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)
 
tresult setIoMode (IoMode mode)
 
int32 getBusCount (MediaType type, BusDirection dir)
 
tresult getBusInfo (MediaType type, BusDirection dir, int32 index, BusInfo &info)
 
tresult getRoutingInfo (RoutingInfo &inInfo, RoutingInfo &outInfo)
 
tresult activateBus (MediaType type, BusDirection dir, int32 index, TBool state)
 
tresult setActive (TBool state)
 
tresult terminate ()
 
BusListgetBusList (MediaType type, BusDirection dir)
 
tresult removeAllBusses ()
 
 ComponentBase ()
 
virtual ~ComponentBase ()
 
FUnknowngetHostContext ()
 
IConnectionPointgetPeer ()
 
IMessageallocateMessage ()
 
tresult sendMessage (IMessage *message)
 
tresult sendTextMessage (const char8 *text)
 
virtual tresult receiveText (const char8 *text)
 
tresult connect (IConnectionPoint *other)
 
tresult disconnect (IConnectionPoint *other)
 
tresult notify (IMessage *message)
 
- 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)
 

Data Fields

OBJ_METHODS(Plug, AudioEffect)
DEFINE_INTERFACES
DEF_INTERFACE(Vst int32 
mPrefetchableMode
 
- Data Fields 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 IConnectionPoint
peerConnection
 

Protected Attributes

bool bBypass
 
- Protected Attributes inherited from AudioEffect
ProcessSetup processSetup
 

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 ( )

Member Function Documentation

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

Called at first after constructor.

Reimplemented from AudioEffect.

tresult process ( ProcessData data)
overridevirtual

Here we go...the process call.

Reimplemented from AudioEffect.

tresult setState ( IBStream state)
overridevirtual

For persistence.

Reimplemented from AudioEffect.

tresult getState ( IBStream state)
overridevirtual

Reimplemented from AudioEffect.

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

Called at first after constructor.

Reimplemented from AudioEffect.

tresult process ( ProcessData data)
overridevirtual

Here we go...the process call.

Reimplemented from AudioEffect.

tresult setState ( IBStream state)
overridevirtual

For persistence.

Reimplemented from AudioEffect.

tresult getState ( IBStream state)
overridevirtual

Reimplemented from AudioEffect.

tresult getPrefetchableSupport ( PrefetchableSupport prefetchable)
overridevirtual

Implements IPrefetchableSupport.

Field Documentation

bool bBypass
protected
OBJ_METHODS (Plug, AudioEffect) DEFINE_INTERFACES DEF_INTERFACE (Vst int32 mPrefetchableMode
Empty

Copyright ©2016 Steinberg Media Technologies GmbH. All Rights Reserved.