VST 3 Interfaces  VST 3.7
SDK for developing VST plug-in

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

#include <ivsteditcontroller.h>

+ Inheritance diagram for IComponentHandler:

Public Member Functions

virtual tresult beginEdit (ParamID id)=0
 To be called before calling a performEdit (e.g. More...
 
virtual tresult performEdit (ParamID id, ParamValue valueNormalized)=0
 Called between beginEdit and endEdit to inform the handler that a given parameter has a new value. More...
 
virtual tresult endEdit (ParamID id)=0
 To be called after calling a performEdit (e.g. More...
 
virtual tresult restartComponent (int32 flags)=0
 Instructs host to restart the component. More...
 
- Public Member Functions inherited from FUnknown
virtual tresult queryInterface (const TUID _iid, void **obj)=0
 
virtual uint32 addRef ()=0
 
virtual uint32 release ()=0
 

Static Public Attributes

static const FUID iid
 
- Static Public Attributes inherited from 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

Member Function Documentation

◆ beginEdit()

virtual tresult 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!

◆ performEdit()

virtual tresult 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!

◆ endEdit()

virtual tresult 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!

◆ restartComponent()

virtual tresult restartComponent ( int32  flags)
pure virtual

Instructs host to restart the component.

This must be called in the UI-Thread context!

Parameters
flagsis a combination of RestartFlags

Member Data Documentation

◆ iid

const FUID iid
static
Empty

Copyright ©2020 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.