Copyright © 2008-2019 MultiMedia Soft

Effects.CustomDspExternalGetParameters method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves parameters currently set into an external custom DSP effect.

 

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 CustomDspExternalGetParameters (

nIdDsp as Int32,

pParameters as IntPtr

) as enumErrorCodes


 

[C#]

public enumErrorCodes CustomDspExternalGetParameters (

Int32 nIdDsp,

IntPtr pParameters

);


 

[C++]

public: enumErrorCodes CustomDspExternalGetParameters (

Int32 nIdDsp,

IntPtr pParameters

);


 

 

Parameter

Description

 

 

nIdDsp

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

pParameters

Pointer to the data structure containing specific parameters for the custom DSP effect: this data structure is not predefined and its fields strictly depends upon the parameters effectively needed by the DSP algorithm: it's very important that this data structure reflects exactly (also in terms of bytes length) the data structure used inside the DLL containing the external DSP

 

 

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.