IEditController

Edit controller component interface. \ingroup vstIPlug vst300 - [plug imp] - [released: 3.0.0]

The Controller part of an effect or instrument with parameter handling (export, definition, conversion...). \see IComponent::getControllerClassId, IMidiMapping

version(VST3)

interface IEditController : IPluginBase {

tresult setComponentState(IBStream state);

tresult setStateController(IBStream state);

tresult getStateController(IBStream state);

int32 getParameterCount();

tresult getParameterInfo(int32 paramIndex, ParameterInfo info);

tresult getParamStringByValue(ParamID id, ParamValue valueNormalized, String128* string_);

tresult getParamValueByString(ParamID id, TChar* string_, ParamValue valueNormalized);

ParamValue normalizedParamToPlain(ParamID id, ParamValue valueNormalized);

ParamValue plainParamToNormalized(ParamID id, ParamValue plainValue);

ParamValue getParamNormalized(ParamID id);

tresult setParamNormalized(ParamID id, ParamValue value);

tresult setComponentHandler(IComponentHandler handler);

IPlugView createView(FIDString name);

nothrow @nogc __gshared immutable

TUID iid;

}

Members

Functions

createView IPlugView createView(FIDString name): Creates the editor view of the Plug-in, currently only "editor" is supported, see \ref ViewType. The life time of the editor view will never exceed the life time of this controller instance.
getParamNormalized ParamValue getParamNormalized(ParamID id): Returns the normalized value of the parameter associated to the paramID.
getParamStringByValue tresult getParamStringByValue(ParamID id, ParamValue valueNormalized, String128* string_): Gets for a given paramID and normalized value its associated string representation.
getParamValueByString tresult getParamValueByString(ParamID id, TChar* string_, ParamValue valueNormalized): Gets for a given paramID and string its normalized value.
getParameterCount int32 getParameterCount(): Returns the number of parameters exported.
getParameterInfo tresult getParameterInfo(int32 paramIndex, ParameterInfo info): Gets for a given index the parameter information.
getStateController tresult getStateController(IBStream state): Gets the controller state.
normalizedParamToPlain ParamValue normalizedParamToPlain(ParamID id, ParamValue valueNormalized): Returns for a given paramID and a normalized value its plain representation (for example 90 for 90db - see \ref vst3AutomationIntro).
plainParamToNormalized ParamValue plainParamToNormalized(ParamID id, ParamValue plainValue): Returns for a given paramID and a plain value its normalized value. (see \ref vst3AutomationIntro)
setComponentHandler tresult setComponentHandler(IComponentHandler handler): Gets from host a handler.
setComponentState tresult setComponentState(IBStream state): Receives the component state.
setParamNormalized tresult setParamNormalized(ParamID id, ParamValue value): 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!
setStateController tresult setStateController(IBStream state): Sets the controller state.

Static variables

iid TUID iid;: Undocumented in source.

Inherited Members

From IPluginBase

initialize tresult initialize(FUnknown context): The host passes a number of interfaces as context to initialize the Plug-in 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!
terminate tresult terminate(): This function is called before the Plug-in is unloaded and can be used for cleanups. You have to release all references to any host application interfaces.
iid TUID iid;: Undocumented in source.