VST.Enable method

VST.Enable method

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

nPlayerIndex as Int16,

nIdVST as Int32,

bEnable as Boolean,

nPriority as Int32

[C#]

public enumErrorCodes Enable (

Int16 nPlayerIndex,

Int32 nIdVST,

bool bEnable,

Int32 nPriority

);

[C++]

public: enumErrorCodes Enable (

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

bEnable

Boolean flag that tells if the custom DSP must be enabled or disabled.

Supported values are the following:

nPriority

VST priority level: VST with higher priority are applied before VST with lower priority

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.