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

#include "vstcomponentbase.h"

Inheritance diagram for Steinberg::Vst::ComponentBase:

Public Member Functions
FUnknown *	getHostContext () const
	Returns the hostContext (set by the host during initialize call).

IConnectionPoint *	getPeer () const
	Returns the peer for the messaging communication (you can only use IConnectionPoint::notify for communicate between peers, do not try to cast peerConnection.

IMessage *	allocateMessage () const
	Allocates a message instance (do not forget to release it).

tresult	sendMessage (IMessage *message) const
	Sends the given message to the peer.

tresult	sendTextMessage (const char8 *text) const
	Sends a simple text message to the peer (max 255 characters).

tresult	sendMessageID (const char8 *messageID) const
	Sends a message with a given ID without any other payload.

virtual tresult	receiveText (const char8 *text)
	Receives a simple text message from the peer (max 255 characters).

tresult PLUGIN_API	initialize (FUnknown *context) SMTG_OVERRIDE
	The host passes a number of interfaces as context to initialize the plug-in class.

tresult PLUGIN_API	terminate () SMTG_OVERRIDE
	This function is called before the plug-in is unloaded and can be used for cleanups.

tresult PLUGIN_API	connect (IConnectionPoint *other) SMTG_OVERRIDE
	Connects this instance with another connection point.

tresult PLUGIN_API	disconnect (IConnectionPoint *other) SMTG_OVERRIDE
	Disconnects a given connection point from this.

tresult PLUGIN_API	notify (IMessage *message) SMTG_OVERRIDE
	Called when a message has been sent from the connection point to this.

Public Member Functions inherited from Steinberg::FObject
	FObject ()=default
	default constructor...

	FObject (const FObject &)

FObject &	operator= (const FObject &)
	overloads operator "=" as the reference assignment

virtual	~FObject ()
	destructor...

virtual FClassID	isA () const
	a local alternative to getFClassID ()

virtual bool	isA (FClassID s) const
	evaluates if the passed ID is of the FObject type

virtual bool	isTypeOf (FClassID s, bool=true) const
	evaluates if the passed ID is of the FObject type

int32	getRefCount ()
	returns the current interface reference count

FUnknown *	unknownCast ()
	get FUnknown interface from object

tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj) SMTG_OVERRIDE
	please refer to FUnknown::queryInterface ()

uint32 PLUGIN_API	addRef () SMTG_OVERRIDE
	please refer to FUnknown::addref ()

uint32 PLUGIN_API	release () SMTG_OVERRIDE
	please refer to FUnknown::release ()

void PLUGIN_API	update (FUnknown *, int32) SMTG_OVERRIDE
	empty virtual method that should be overridden by derived classes for data updates upon changes

virtual void	addDependent (IDependent *dep)
	adds dependency to the object

virtual void	removeDependent (IDependent *dep)
	removes dependency from the object

virtual void	changed (int32 msg=kChanged)
	Inform all dependents, that the object has changed.

virtual void	deferUpdate (int32 msg=kChanged)
	Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates).

virtual void	updateDone (int32)
	empty virtual method that should be overridden by derived classes

virtual bool	isEqualInstance (FUnknown *d)

Protected Attributes
IPtr< FUnknown >	hostContext

IPtr< IConnectionPoint >	peerConnection

Protected Attributes inherited from Steinberg::FObject
int32	refCount
	COM-model local reference count.

Additional Inherited Members
Public Types inherited from Steinberg::IDependent
enum	ChangeMessage { kWillChange , kChanged , kDestroyed , kWillDestroy , kStdChangeMessageLast }

Static Public Member Functions inherited from Steinberg::FObject
static FClassID	getFClassID ()
	return Class ID as an ASCII string (statically)

static void	setUpdateHandler (IUpdateHandler *handler)
	set method for the local attribute

static IUpdateHandler *	getUpdateHandler ()
	get method for the local attribute

static bool	classIDsEqual (FClassID ci1, FClassID ci2)
	compares (evaluates) 2 class IDs

static FObject *	unknownToObject (FUnknown *unknown)
	pointer conversion from FUnknown to FObject

Static Public Attributes inherited from Steinberg::FObject
static const FUID	iid
	Special UID that is used to cast an FUnknown pointer to a FObject.

Static Public Attributes inherited from Steinberg::IDependent
static const FUID	iid

Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Static Public Attributes inherited from Steinberg::IPluginBase
static const FUID	iid

Static Public Attributes inherited from Steinberg::Vst::IConnectionPoint
static const FUID	iid

Static Protected Attributes inherited from Steinberg::FObject
static IUpdateHandler *	gUpdateHandler

Detailed Description

Base class for VST 3 Component and Edit Controller.

Definition at line 52 of file vstcomponentbase.h.

Constructor & Destructor Documentation

◆ ComponentBase()

Steinberg::Vst::ComponentBase::ComponentBase ( )

Definition at line 46 of file vstcomponentbase.cpp.

◆ ~ComponentBase()

Steinberg::Vst::ComponentBase::~ComponentBase ( )

override

Definition at line 51 of file vstcomponentbase.cpp.

Member Function Documentation

◆ allocateMessage()

IMessage * Steinberg::Vst::ComponentBase::allocateMessage ( ) const

Allocates a message instance (do not forget to release it).

Definition at line 130 of file vstcomponentbase.cpp.

◆ connect()

tresult PLUGIN_API Steinberg::Vst::ComponentBase::connect ( IConnectionPoint * other )

virtual

Connects this instance with another connection point.

Implements Steinberg::Vst::IConnectionPoint.

Definition at line 85 of file vstcomponentbase.cpp.

◆ disconnect()

tresult PLUGIN_API Steinberg::Vst::ComponentBase::disconnect ( IConnectionPoint * other )

virtual

Disconnects a given connection point from this.

Implements Steinberg::Vst::IConnectionPoint.

Definition at line 99 of file vstcomponentbase.cpp.

◆ getHostContext()

FUnknown * Steinberg::Vst::ComponentBase::getHostContext ( ) const

Returns the hostContext (set by the host during initialize call).

Definition at line 63 of file vstcomponentbase.h.

◆ getPeer()

IConnectionPoint * Steinberg::Vst::ComponentBase::getPeer ( ) const

Returns the peer for the messaging communication (you can only use IConnectionPoint::notify for communicate between peers, do not try to cast peerConnection.

Definition at line 67 of file vstcomponentbase.h.

◆ initialize()

tresult PLUGIN_API Steinberg::Vst::ComponentBase::initialize ( FUnknown * context )

virtual

The host passes a number of interfaces as context to initialize the plug-in class.

Parameters

context,passed by the host, is mandatory and should implement IHostApplication

Note: Extensive memory allocations etc. should be performed in this method rather than in the class' constructor! If the method does NOT return kResultOk, the object is released immediately. In this case terminate is not called!

Implements Steinberg::IPluginBase.

Reimplemented in Steinberg::Vst::EditController.

Definition at line 56 of file vstcomponentbase.cpp.

◆ notify()

tresult PLUGIN_API Steinberg::Vst::ComponentBase::notify ( IMessage * message )

virtual

Called when a message has been sent from the connection point to this.

Implements Steinberg::Vst::IConnectionPoint.

Definition at line 110 of file vstcomponentbase.cpp.

◆ receiveText()

tresult Steinberg::Vst::ComponentBase::receiveText ( const char8 * text )

virtual

Receives a simple text message from the peer (max 255 characters).

Text is UTF-8 encoded.

Definition at line 173 of file vstcomponentbase.cpp.

◆ sendMessage()

tresult Steinberg::Vst::ComponentBase::sendMessage ( IMessage * message ) const

Sends the given message to the peer.

Definition at line 139 of file vstcomponentbase.cpp.

◆ sendMessageID()

tresult Steinberg::Vst::ComponentBase::sendMessageID ( const char8 * messageID ) const

Sends a message with a given ID without any other payload.

Definition at line 162 of file vstcomponentbase.cpp.

◆ sendTextMessage()

tresult Steinberg::Vst::ComponentBase::sendTextMessage ( const char8 * text ) const

Sends a simple text message to the peer (max 255 characters).

Text is interpreted as UTF-8.

Definition at line 147 of file vstcomponentbase.cpp.

◆ terminate()

tresult PLUGIN_API Steinberg::Vst::ComponentBase::terminate ( )

virtual

This function is called before the plug-in is unloaded and can be used for cleanups.

You have to release all references to any host application interfaces.

Implements Steinberg::IPluginBase.

Reimplemented in Steinberg::Vst::EditController, and Steinberg::Vst::EditControllerEx1.

Definition at line 68 of file vstcomponentbase.cpp.

Member Data Documentation

◆ hostContext

IPtr<FUnknown> Steinberg::Vst::ComponentBase::hostContext

protected

Definition at line 104 of file vstcomponentbase.h.

◆ peerConnection

IPtr<IConnectionPoint> Steinberg::Vst::ComponentBase::peerConnection

protected

Definition at line 105 of file vstcomponentbase.h.

The documentation for this class was generated from the following files:

juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vstcomponentbase.h
juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vstcomponentbase.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ComponentBase()

◆ ~ComponentBase()

Member Function Documentation

◆ allocateMessage()

◆ connect()

◆ disconnect()

◆ getHostContext()

◆ getPeer()

◆ initialize()

◆ notify()

◆ receiveText()

◆ sendMessage()

◆ sendMessageID()

◆ sendTextMessage()

◆ terminate()

Member Data Documentation

◆ hostContext

◆ peerConnection