Copyright © 2005-2018 MultiMedia Soft

CustomDSP.ExternalGetParameters method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves parameters currently set into an external custom DSP effect.

 

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

nPlayerIndex as Int16,

nIdDsp as Int32,

pParameters as IntPtr

) as enumErrorCodes


 

[C#]

public enumErrorCodes ExternalGetParameters (

Int16 nPlayerIndex,

Int32 nIdDsp,

IntPtr pParameters

);


 

[C++]

public: enumErrorCodes ExternalGetParameters (

Int16 nPlayerIndex,

Int32 nIdDsp,

IntPtr pParameters

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

nIdDsp

Unique identifier of the custom DSP

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

The method call was successful.