Steinberg::Vst::ComponentBase Class Reference

#include <vstcomponentbase.h>

Inheritance diagram for Steinberg::Vst::ComponentBase:

Steinberg::IPluginBase Steinberg::Vst::IConnectionPoint Steinberg::FUnknown Steinberg::FUnknown Steinberg::Vst::Component Steinberg::Vst::EditController Steinberg::Vst::AudioEffect AGainController AGain List of all members.

Public Member Functions

 ComponentBase ()
virtual ~ComponentBase ()
FUnknowngetHostContext ()
IConnectionPointgetPeer ()
IMessageallocateMessage ()
tresult sendMessage (IMessage *message)
tresult sendTextMessage (const char *text)
virtual tresult receiveText (const char *text)
DECLARE_FUNKNOWN_METHODS tresult
PLUGIN_API 
initialize (FUnknown *context)
tresult PLUGIN_API terminate ()
tresult PLUGIN_API connect (IConnectionPoint *other)
tresult PLUGIN_API disconnect (IConnectionPoint *other)
tresult PLUGIN_API notify (IMessage *message)

Protected Attributes

FUnknownhostContext
IConnectionPointpeerConnection

Detailed Description

Base class for Component and Edit Controller.

Definition at line 51 of file vstcomponentbase.h.


Constructor & Destructor Documentation

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

Definition at line 44 of file vstcomponentbase.cpp.

Steinberg::Vst::ComponentBase::~ComponentBase (  )  [virtual]

Definition at line 52 of file vstcomponentbase.cpp.


Member Function Documentation

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

Allocates a message instance (dont forget to release it).

Definition at line 154 of file vstcomponentbase.cpp.

tresult PLUGIN_API Steinberg::Vst::ComponentBase::connect ( IConnectionPoint other  )  [virtual]

Connects this instance with an another connection point.

Implements Steinberg::Vst::IConnectionPoint.

Definition at line 107 of file vstcomponentbase.cpp.

tresult PLUGIN_API Steinberg::Vst::ComponentBase::disconnect ( IConnectionPoint other  )  [virtual]

Disconnects a given connection point from this.

Implements Steinberg::Vst::IConnectionPoint.

Definition at line 122 of file vstcomponentbase.cpp.

FUnknown* Steinberg::Vst::ComponentBase::getHostContext (  )  [inline]

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

Definition at line 61 of file vstcomponentbase.h.

IConnectionPoint* Steinberg::Vst::ComponentBase::getPeer (  )  [inline]

Returns the peer for the messaging communication.

Definition at line 64 of file vstcomponentbase.h.

tresult PLUGIN_API Steinberg::Vst::ComponentBase::initialize ( FUnknown context  )  [virtual]

The host passes a number of interfaces as context to initialize the plugin class.

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::Component, and Steinberg::Vst::EditController.

Definition at line 71 of file vstcomponentbase.cpp.

tresult PLUGIN_API Steinberg::Vst::ComponentBase::notify ( IMessage message  )  [virtual]

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

Implements Steinberg::Vst::IConnectionPoint.

Definition at line 134 of file vstcomponentbase.cpp.

tresult Steinberg::Vst::ComponentBase::receiveText ( const char *  text  )  [virtual]

Receives a simple text message from the peer.

Reimplemented in AGain, and AGainController.

Definition at line 184 of file vstcomponentbase.cpp.

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

Sends the given message to the peer.

Definition at line 163 of file vstcomponentbase.cpp.

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

Sends a simple text message to the peer.

Definition at line 171 of file vstcomponentbase.cpp.

tresult PLUGIN_API Steinberg::Vst::ComponentBase::terminate (  )  [virtual]

This function is called, before the plugin 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::Component, Steinberg::Vst::EditController, AGain, and AGainController.

Definition at line 85 of file vstcomponentbase.cpp.


Member Data Documentation

FUnknown* Steinberg::Vst::ComponentBase::hostContext [protected]

Definition at line 88 of file vstcomponentbase.h.

IConnectionPoint* Steinberg::Vst::ComponentBase::peerConnection [protected]

Definition at line 89 of file vstcomponentbase.h.


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

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.