Steinberg::IPluginBase Class Reference

#include <ipluginbase.h>

Inheritance diagram for Steinberg::IPluginBase:

Steinberg::FUnknown Steinberg::Vst::ComponentBase Steinberg::Vst::IComponent Steinberg::Vst::IEditController Steinberg::Vst::Component Steinberg::Vst::EditController Steinberg::Vst::Component Steinberg::Vst::EditController Steinberg::Vst::AudioEffect AGainController Steinberg::Vst::AudioEffect AGainController AGain AGain List of all members.

Public Member Functions

virtual tresult PLUGIN_API initialize (FUnknown *context)=0
virtual tresult PLUGIN_API terminate ()=0

Static Public Attributes

static const FUID iid

Detailed Description

Basic interface to a plugin component. [plug imp]

The host uses this interface to initialize and to terminate the plugin component. The context that is passed to the initialize method contains any interface to the host that the plugin will need to work. The number of interfaces may vary from category to category, but any context contains a number of standard Host Interfaces .

Definition at line 60 of file ipluginbase.h.


Member Function Documentation

virtual tresult PLUGIN_API Steinberg::IPluginBase::initialize ( FUnknown context  )  [pure 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!

Implemented in Steinberg::Vst::Component, Steinberg::Vst::ComponentBase, and Steinberg::Vst::EditController.

virtual tresult PLUGIN_API Steinberg::IPluginBase::terminate (  )  [pure 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.

Implemented in Steinberg::Vst::Component, Steinberg::Vst::ComponentBase, Steinberg::Vst::EditController, AGain, and AGainController.


Member Data Documentation

const FUID Steinberg::IPluginBase::iid [static]

Reimplemented from Steinberg::FUnknown.

Reimplemented in Steinberg::Vst::IComponent, and Steinberg::Vst::IEditController.

Definition at line 74 of file ipluginbase.h.


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

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.