Remarks
If available, obtains information about the editor (user interface) of the given VST effect. You are free to define your own set of information about a certain editor.
The editor can be show, hidden or moved using the Effects.VstEditorShow method.
For further details about managing a VST effect refer to the How to manage VST effects section.
For further details about methods related to the use of special effects refer to the EffectsMan class.
Syntax
[Visual Basic]
Public Function VstEditorGetInfo (
nIdVST as Int32,
pInfo as IntPtr
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes VstEditorGetInfo (
Int32 nIdVST,
IntPtr pInfo
);
|
|
[C++]
public: enumErrorCodes VstEditorGetInfo (
Int32 nIdVST,
IntPtr pInfo
);
|
|
Parameter
|
Description
|
|
|
nIdVST
|
Unique identifier of the VST effect as returned by the Effects.VstLoad method.
|
pParamData
|
Pointer in memory to an object of class VstEditorInfo containing information about the VST editor.
The VST_EDITOR_INFO data structure is defined in C++ as follows:
public class VstEditorInfo
{
bool bIsEditorAvailable;
bool bIsEditorVisible;
Int16 nEditorLeft;
Int16 nEditorTop;
Int16 nEditorWidth;
Int16 nEditorHeight;
}
Member name
|
Description
|
|
|
bIsEditorAvailable
|
Boolean flag that specifies if the VST editor is available
|
bIsEditorVisible
|
Boolean flag that specifies if the VST editor is currently visible or hidden
|
nEditorLeft
|
Editor left position, within the container client area, expressed in pixels
|
nEditorTop
|
Editor top position, within the container client area, expressed in pixels
|
nEditorWidth
|
Editor width expressed in pixels
|
nEditorHeight
|
Editor height expressed in pixels
|
|
Return value
Value
|
Meaning
|
|
|
Negative value
|
An error occurred (see the LastError property for further error details)
|
enumErrorCodes.ERR_NOERROR (0)
|
The method call was successful.
|
|
