Remarks
If available, shows/hides the editor (user interface) of the given external DSP effect.
The concept of "editor" implemented by external custom DSP effects is very similar to the concept of "editor" implemented by VST effects: as for VST effects, having an available editor is not mandatory but, in some case, it could be useful.
Information about the editor can be obtained through the CustomDSP.ExternalEditorGetInfo method.
For further details about methods related to the use of custom DSP effects refer to the CustomDSPs class.
Further information about the use of Custom DSP effects can be found inside the How to manage custom DSP effects tutorial.
Syntax
[Visual Basic]
Public Function ExternalEditorShow (
nPlayerIndex as Int16,
nIdDsp as Int32,
bShow as Boolean,
hWndParent as IntPtr,
leftPos as Int32,
topPos as Int32
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes ExternalEditorShow (
Int16 nPlayerIndex,
Int32 nIdDsp,
bool bShow,
IntPtr hWndParent,
Int32 leftPos,
Int32 topPos
);
|
|
[C++]
public: enumErrorCodes ExternalEditorShow (
Int16 nPlayerIndex,
Int32 nIdDsp,
bool bShow,
IntPtr hWndParent,
Int32 leftPos,
Int32 topPos
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the involved player
|
nIdDsp
|
Unique identifier of the custom DSP
|
bShow
|
Show/hide flag..
Supported values are the following:
Value
|
Meaning
|
false
|
Hides the editor window
|
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)
|
>= 0
|
A custom return value: you can define your own set of return values in order to let the container application know the result of the custom command
|
|
