Edit controller component interface: Vst::IEditController. More...

#include "ivsteditcontroller.h"

Inheritance diagram for Steinberg::Vst::IEditController:

Public Member Functions
virtual tresult PLUGIN_API	setComponentState (IBStream *state)=0
	Receives the component state.

virtual tresult PLUGIN_API	setState (IBStream *state)=0
	Sets the controller state.

virtual tresult PLUGIN_API	getState (IBStream *state)=0
	Gets the controller state.

virtual int32 PLUGIN_API	getParameterCount ()=0
	Returns the number of parameters exported.

virtual tresult PLUGIN_API	getParameterInfo (int32 paramIndex, ParameterInfo &info)=0
	Gets for a given index the parameter information.

virtual tresult PLUGIN_API	getParamStringByValue (ParamID id, ParamValue valueNormalized, String128 string)=0
	Gets for a given paramID and normalized value its associated string representation.

virtual tresult PLUGIN_API	getParamValueByString (ParamID id, TChar *string, ParamValue &valueNormalized)=0
	Gets for a given paramID and string its normalized value.

virtual ParamValue PLUGIN_API	normalizedParamToPlain (ParamID id, ParamValue valueNormalized)=0
	Returns for a given paramID and a normalized value its plain representation (for example -6 for -6dB - see vst3AutomationIntro).

virtual ParamValue PLUGIN_API	plainParamToNormalized (ParamID id, ParamValue plainValue)=0
	Returns for a given paramID and a plain value its normalized value.

virtual ParamValue PLUGIN_API	getParamNormalized (ParamID id)=0
	Returns the normalized value of the parameter associated to the paramID.

virtual tresult PLUGIN_API	setParamNormalized (ParamID id, ParamValue value)=0
	Sets the normalized value to the parameter associated to the paramID.

virtual tresult PLUGIN_API	setComponentHandler (IComponentHandler *handler)=0
	Gets from host a handler which allows the Plugin-in to communicate with the host.

virtual IPlugView *PLUGIN_API	createView (FIDString name)=0
	Creates the editor view of the plug-in, currently only "editor" is supported, see ViewType.

Public Member Functions inherited from Steinberg::IPluginBase
virtual tresult PLUGIN_API	initialize (FUnknown *context)=0
	The host passes a number of interfaces as context to initialize the plug-in class.

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

Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
	Query for a pointer to the specified interface.

virtual uint32 PLUGIN_API	addRef ()=0
	Adds a reference and returns the new reference count.

virtual uint32 PLUGIN_API	release ()=0
	Releases a reference and returns the new reference count.

Static Public Attributes
static const FUID	iid

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

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

Detailed Description

Edit controller component interface: Vst::IEditController.

[plug imp]
[released: 3.0.0]
[mandatory]

The controller part of an effect or instrument with parameter handling (export, definition, conversion...).

See also: IComponent::getControllerClassId, IMidiMapping

Definition at line 398 of file ivsteditcontroller.h.

Member Function Documentation

◆ createView()

virtual IPlugView *PLUGIN_API Steinberg::Vst::IEditController::createView ( FIDString name )

pure virtual

Creates the editor view of the plug-in, currently only "editor" is supported, see ViewType.

The life time of the editor view will never exceed the life time of this controller instance.

Implemented in Steinberg::Vst::EditController.

◆ getParameterCount()

virtual int32 PLUGIN_API Steinberg::Vst::IEditController::getParameterCount ( )

pure virtual

Returns the number of parameters exported.

Implemented in Steinberg::Vst::EditController.

◆ getParameterInfo()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController::getParameterInfo	(	int32	paramIndex,
		ParameterInfo &	info
	)

pure virtual

Gets for a given index the parameter information.

Implemented in Steinberg::Vst::EditController.

◆ getParamNormalized()

virtual ParamValue PLUGIN_API Steinberg::Vst::IEditController::getParamNormalized ( ParamID id )

pure virtual

Returns the normalized value of the parameter associated to the paramID.

Implemented in Steinberg::Vst::EditController.

◆ getParamStringByValue()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController::getParamStringByValue	(	ParamID	id,
		ParamValue	valueNormalized,
		String128	string
	)

pure virtual

Gets for a given paramID and normalized value its associated string representation.

Implemented in Steinberg::Vst::EditController.

◆ getParamValueByString()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController::getParamValueByString	(	ParamID	id,
		TChar *	string,
		ParamValue &	valueNormalized
	)

pure virtual

Gets for a given paramID and string its normalized value.

Implemented in Steinberg::Vst::EditController.

◆ getState()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController::getState ( IBStream * state )

pure virtual

Gets the controller state.

Implemented in Steinberg::Vst::EditController.

◆ normalizedParamToPlain()

virtual ParamValue PLUGIN_API Steinberg::Vst::IEditController::normalizedParamToPlain	(	ParamID	id,
		ParamValue	valueNormalized
	)

pure virtual

Returns for a given paramID and a normalized value its plain representation (for example -6 for -6dB - see vst3AutomationIntro).

Implemented in Steinberg::Vst::EditController.

◆ plainParamToNormalized()

virtual ParamValue PLUGIN_API Steinberg::Vst::IEditController::plainParamToNormalized	(	ParamID	id,
		ParamValue	plainValue
	)

pure virtual

Returns for a given paramID and a plain value its normalized value.

(see vst3AutomationIntro)

Implemented in Steinberg::Vst::EditController.

◆ setComponentHandler()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController::setComponentHandler ( IComponentHandler * handler )

pure virtual

Gets from host a handler which allows the Plugin-in to communicate with the host.

Note: This is mandatory if the host is using the IEditController!

Implemented in Steinberg::Vst::EditController.

◆ setComponentState()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController::setComponentState ( IBStream * state )

pure virtual

Receives the component state.

Implemented in Steinberg::Vst::EditController.

◆ setParamNormalized()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController::setParamNormalized	(	ParamID	id,
		ParamValue	value
	)

pure virtual

Sets the normalized value to the parameter associated to the paramID.

The controller must never pass this value-change back to the host via the IComponentHandler. It should update the according GUI element(s) only!

Implemented in Steinberg::Vst::EditController.

◆ setState()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController::setState ( IBStream * state )

pure virtual

Sets the controller state.

Implemented in Steinberg::Vst::EditController.

Member Data Documentation

◆ iid

const FUID Steinberg::Vst::IEditController::iid

static

Definition at line 446 of file ivsteditcontroller.h.

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

juce_audio_processors/format_types/VST3_SDK/pluginterfaces/vst/ivsteditcontroller.h

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ createView()

◆ getParameterCount()

◆ getParameterInfo()

◆ getParamNormalized()

◆ getParamStringByValue()

◆ getParamValueByString()

◆ getState()

◆ normalizedParamToPlain()

◆ plainParamToNormalized()

◆ setComponentHandler()

◆ setComponentState()

◆ setParamNormalized()

◆ setState()

Member Data Documentation

◆ iid