Remarks
Enables/disables the given 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 Enable (
nPlayerIndex as Int16,
nIdDsp as Int32,
bEnable as Boolean,
nUserData as Int32,
nPriority as Int32
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes Enable (
Int16 nPlayerIndex,
Int32 nIdDsp,
bool bEnable,
Int32 nUserData,
Int32 nPriority
);
|
|
[C++]
public: enumErrorCodes Enable (
Int16 nPlayerIndex,
Int32 nIdDsp,
bool bEnable,
Int32 nUserData,
Int32 nPriority
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the involved player
|
nIdDsp
|
Unique identifier of the custom DSP
|
bEnable
|
Boolean flag that specifies if the custom DSP must be enabled or disabled.
Supported values are the following:
Value
|
Meaning
|
false
|
Disable the custom DSP effect
|
true
|
Enable the custom DSP effect
|
|
nUserData
|
User data to pass to the custom DSP
|
nPriority
|
DSP priority level inside the chain of DirectX effects, custom DSP effects and VST effects. Effects with higher priority are applied before effects with lower priority; in case more effects should have the same priority, they would be invoked in the same order that they were added..
|
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.
|
|
