Copyright © 2011-2018 MultiMedia Soft

Effects.CustomDspExternalEditorGetInfo method

Previous pageReturn to chapter overviewNext page

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 show, hidden or moved using the Effects.CustomDspExternalEditorShow 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 special effects refer to the EffectsMan class.

 

 

Syntax

 

[Visual Basic]

Public Function CustomDspExternalEditorGetInfo (

nIdDsp as Int32,

pInfo as IntPtr

) as enumErrorCodes


 

[C#]

public enumErrorCodes CustomDspExternalEditorGetInfo (

Int32 nIdDsp,

IntPtr pInfo

);


 

[C++]

public: enumErrorCodes CustomDspExternalEditorGetInfo (

Int32 nIdDsp,

IntPtr pInfo

);


 

 

Parameter

Description

 

 

nIdDsp

Unique identifier of the custom DSP as returned by the Effects.CustomDspExternalLoad method

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.ERR_NOERROR (0)

The method call was successful.