Copyright © 2001-2018 MultiMedia Soft

VST.EditorShow method

Previous pageReturn to chapter overviewNext page

Remarks

 

If available, shows/hides or moves the editor (user interface) of the given VST.

Information about the VST editor can be obtained through the VST.EditorGetInfo 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.EditorShow (

nPlayer as Integer,

nIdVST as Long,

bShow as enumBoolean,

hWndParent as OLE_HANDLE,

leftPos as Long,

topPos as Long

) as enumErrorCodes


 

[C++]

short control.VST.EditorShow (

short nPlayer,

long nIdDsp,

short bShow,

OLE_HANDLE hWndParent,

long leftPos,

long topPos

);


 

 

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.EffectLoad or VST.InstrumentLoad methods.

bShow

Show/hide flag.

Supported values are the following:

Value

Meaning

BOOL_FALSE

Hides the editor window

BOOL_TRUE

Shows the editor window

hWndParent

Handle of the window (HWND) that will be parent of the editor's window.

leftPos

Left position, respect to the container window client area, expressed in pixels

topPos

Top position, respect to the container window client area, 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.