Remarks
Enables/disables the given 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 custom DSP effects refer to the CustomDSP COM object.
Syntax
[Visual Basic]
control.CustomDSP.Enable (
nIdDsp as Long,
bEnable as enumBoolean,
nUserData as Long,
nPriority as Long
) as enumErrorCodes
|
|
[C++]
short control.CustomDSP.Enable (
long nIdDsp,
short bEnable,
long nUserData,
long nPriority
);
|
|
Parameter
|
Description
|
|
|
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
|
Disable the custom DSP effect
|
BOOL_TRUE
|
Enable the custom DSP effect
|
|
nUserData
|
User data to pass to the custom DSP
|
nPriority
|
DSP priority
|
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.
|
|