Remarks
Enables/disables the given VST effect.
For further details about methods related to the use of VST effects refer to the VSTs class.
For further details about managing a VST effect refer to the How to manage VST effects tutorial.
Syntax
[Visual Basic]
Public Function EffectEnable (
nPlayerIndex as Int16,
nIdVST as Int32,
bEnable as Boolean,
nPriority as Int32
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes EffectEnable (
Int16 nPlayerIndex,
Int32 nIdVST,
bool bEnable,
Int32 nPriority
);
|
|
[C++]
public: enumErrorCodes EffectEnable (
Int16 nPlayerIndex,
Int32 nIdVST,
bool bEnable,
Int32 nPriority
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the involved player
|
nIdVST
|
Unique identifier of the VST effect as returned by the VST.EffectLoad method.
|
bEnable
|
Boolean flag that specifies if the VST effect must be enabled or disabled.
Supported values are the following:
Value
|
Meaning
|
false
|
Disables the VST effect
|
true
|
Enable the VST effect
|
|
nPriority
|
VST effects 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.
|
|
