Copyright © 2006-2018 MultiMedia Soft

CustomDSP.ExternalEditorShow method

Previous pageReturn to chapter overviewNext page

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 managing a custom DSP effect refer to the How to manage custom DSP effects section.

For further details about methods related to the use of custom DSP effects refer to the CustomDSP COM object.

 

 

Syntax

 

[Visual Basic]

control.CustomDSP.ExternalEditorShow (

nIdDsp as Long,

bShow as enumBoolean,

hWndParent as OLE_HANDLE,

leftPos as Long,

topPos as Long

) as enumErrorCodes


 

[C++]

short control.CustomDSP.ExternalEditorShow (

long nIdDsp,

short bShow,

OLE_HANDLE hWndParent,

long leftPos,

long topPos

);


 

 

Parameter

Description

 

 

nIdDsp

Unique identifier of the custom DSP

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)

>= 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