VST.EditorGetInfo method

VST.EditorGetInfo method

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 shown, hidden or moved using the VST.EditorShow method.

For further details about methods related to the use of VST effects refer to the VST COM object.

For further details about managing a VST effect refer to the How to manage VST effects tutorial.

Syntax

[Visual Basic]

control.VST.EditorGetInfo (

nPlayer as Integer,

nIdVST as Long,

pParamData as Long

) as enumErrorCodes

[C++]

short control.VST.EditorGetInfo (

short nPlayer,

long nIdVST,

long pParamData

);

Parameter

Description

nPlayer

Number representing the zero-based index of the involved player

nIdVST

Unique identifier of the VST effect as returned by the VST.Load method.

pParamData

Pointer in memory to a data structure of type VST_EDITOR_INFO containing information about the VST editor.

The VST_EDITOR_INFO data structure is defined in C++ as follows:

typedef struct

{

short bIsEditorAvailable;

short bIsEditorVisible;

short nEditorLeft;

short nEditorTop;

short nEditorWidth;

short nEditorHeight;

} VST_EDITOR_INFO;

Member name	Description

bIsEditorAvailable	Boolean flag that tells if the VST editor is available
bIsEditorVisible	Boolean flag that tells if the VST editor is actually 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.NOERROR (0)	The method call was successful.