Steinberg::Vst::IComponentHandler Class Reference

Host callback interface for an edit controller: Vst::IComponentHandler. More...

#include "ivsteditcontroller.h"

Inheritance diagram for Steinberg::Vst::IComponentHandler:

Public Member Functions
virtual tresult PLUGIN_API	beginEdit (ParamID id)=0
	To be called before calling a performEdit (e.g.
virtual tresult PLUGIN_API	performEdit (ParamID id, ParamValue valueNormalized)=0
	Called between beginEdit and endEdit to inform the handler that a given parameter has a new value.
virtual tresult PLUGIN_API	endEdit (ParamID id)=0
	To be called after calling a performEdit (e.g.
virtual tresult PLUGIN_API	restartComponent (int32 flags)=0
	Instructs host to restart the component.
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::FUnknown
static const FUID	iid

Detailed Description

Host callback interface for an edit controller: Vst::IComponentHandler.

• [host imp]
• [released: 3.0.0]
• [mandatory]

Allow transfer of parameter editing to component (processor) via host and support automation. Cause the host to react on configuration changes (restartComponent).

See also

IEditController

Definition at line 171 of file ivsteditcontroller.h.

Member Function Documentation

beginEdit()

virtual tresult PLUGIN_API Steinberg::Vst::IComponentHandler::beginEdit ( ParamID  id )

pure virtual

To be called before calling a performEdit (e.g.

on mouse-click-down event). This must be called in the UI-Thread context!

endEdit()

virtual tresult PLUGIN_API Steinberg::Vst::IComponentHandler::endEdit ( ParamID  id )

pure virtual

To be called after calling a performEdit (e.g.

on mouse-click-up event). This must be called in the UI-Thread context!

performEdit()

virtual tresult PLUGIN_API Steinberg::Vst::IComponentHandler::performEdit ( ParamID  id, ParamValue  valueNormalized  )

pure virtual

Called between beginEdit and endEdit to inform the handler that a given parameter has a new value.

This must be called in the UI-Thread context!

restartComponent()

virtual tresult PLUGIN_API Steinberg::Vst::IComponentHandler::restartComponent ( int32  flags )

pure virtual

Instructs host to restart the component.

This must be called in the UI-Thread context!

Parameters

flags

is a combination of RestartFlags

Member Data Documentation

iid

const FUID Steinberg::Vst::IComponentHandler::iid

static

Definition at line 192 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