CustomDSP.ExternalEditorGetInfo method

CustomDSP.ExternalEditorGetInfo method

Remarks

If available, obtains information about the editor (user interface) of the given external DSP effect. You are free to define your own set of information about a certain editor.

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.

The editor can be shown, hidden or moved using the CustomDSP.ExternalEditorShow 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 ExternalEditorGetInfo (

nPlayerIndex as Int16,

nIdDsp as Int32,

pInfo as IntPtr

) as enumErrorCodes

[C#]

public enumErrorCodes ExternalEditorGetInfo (

Int16 nPlayerIndex,

Int32 nIdDsp,

IntPtr pInfo

);

[C++]

public: enumErrorCodes ExternalEditorGetInfo (

Int16 nPlayerIndex,

Int32 nIdDsp,

IntPtr pInfo

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the involved player
nIdDsp	Unique identifier of the custom DSP
pInfo	Pointer in memory to the data structure containing information about the DSP's editor. As already mentioned before, you are free to define your own set of information about a certain editor; a typical implementation of this data structure could be the one provided below in C++ language: typedef struct { HWND hWnd; // HWND of the window bool bIsVisible; // visibility flag long nLeftPosPx; // left position in pixels long nTopPosPx; // to position in pixels long nWidthPx; // width in pixels long nHeightPx; // height in pixels } DSP_EDITOR_WINDOW_INFO;

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.

Return to Table of contents