Remarks
Enables/disables the given DSP effect.
For further details about methods related to the use of custom DSP effects refer to the CustomDSP COM object.
Further information about the use of Custom DSP effects can be found inside the How to manage custom DSP effects tutorial.
Syntax
[Visual Basic]
control.CustomDSP.Enable (
nPlayer as Integer,
nIdDsp as Long,
bEnable as enumBoolean,
nUserData as Long,
nPriority as Long
) as enumErrorCodes
|
|
[C++]
short control.CustomDSP.Enable (
short nPlayer,
long nIdDsp,
short bEnable,
long nUserData,
long nPriority
);
|
|
Parameter
|
Description
|
|
|
nPlayer
|
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
|
BOOL_FALSE
|
Disables the custom DSP effect
|
BOOL_TRUE
|
Enables 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.
|
|
