Steinberg::Vst::IEditController2 Class Reference

Edit controller component interface extension: Vst::IEditController2. More...

#include "ivsteditcontroller.h"

Inheritance diagram for Steinberg::Vst::IEditController2:

Public Member Functions
virtual tresult PLUGIN_API	setKnobMode (KnobMode mode)=0
	Host could set the Knob Mode for the plug-in.
virtual tresult PLUGIN_API	openHelp (TBool onlyCheck)=0
	Host could ask to open the plug-in help (could be: opening a PDF document or link to a web page).
virtual tresult PLUGIN_API	openAboutBox (TBool onlyCheck)=0
	Host could ask to open the plug-in about box.
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

Edit controller component interface extension: Vst::IEditController2.

• [plug imp]
• [extends IEditController]
• [released: 3.1.0]
• [optional]

Extension to allow the host to inform the plug-in about the host Knob Mode, and to open the plug-in about box or help documentation.

See also

IEditController, EditController

Definition at line 481 of file ivsteditcontroller.h.

Member Function Documentation

openAboutBox()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController2::openAboutBox ( TBool  onlyCheck )

pure virtual

Host could ask to open the plug-in about box.

The host could call it with onlyCheck set to true for testing support of open AboutBox. Return kResultFalse means not supported function.

Implemented in Steinberg::Vst::EditController.

openHelp()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController2::openHelp ( TBool  onlyCheck )

pure virtual

Host could ask to open the plug-in help (could be: opening a PDF document or link to a web page).

The host could call it with onlyCheck set to true for testing support of open Help. Return kResultFalse means not supported function.

Implemented in Steinberg::Vst::EditController.

setKnobMode()

virtual tresult PLUGIN_API Steinberg::Vst::IEditController2::setKnobMode ( KnobMode  mode )

pure virtual

Host could set the Knob Mode for the plug-in.

Return kResultFalse means not supported mode.

See also

KnobModes.

Implemented in Steinberg::Vst::EditController.

Member Data Documentation

iid

const FUID Steinberg::Vst::IEditController2::iid

static

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