Remarks
Loads a VST effect from an external dynamic-link library (DLL) file. For VST instruments use the VST.InstrumentLoad method.
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 EffectLoad (
nPlayerIndex as Int16,
strPathname as String,
bEnable as Boolean
) as Int32
|
|
[C#]
public Int32 EffectLoad (
Int16 nPlayerIndex,
string strPathname,
bool bEnable
);
|
|
[C++]
public: Int32 EffectLoad (
Int16 nPlayerIndex,
string strPathname,
bool bEnable
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the involved player
|
strPathname
|
String representing the filename or absolute pathname of the DLL file containing the VST effect.
If the string specifies a path but the file does not exist in the specified directory, the function fails. When specifying a path, be sure to use backslashes (\), not forward slashes (/).
If the string does not specify a path, the function uses the standard search strategy of the LoadLibrary Windows API to find the file.
|
bEnable
|
Boolean flag that specifies if the VST effect must be immediately enabled after loading.
Supported values are the following:
Value
|
Meaning
|
false
|
Doesn't enable the VST effect after loading
|
true
|
Enables the VST effect after loading
|
|
Return value
Value
|
Meaning
|
|
|
0
|
An error occurred: see the LastError property for further error details or for a list of the possible error values.
In case the value of the LastError property should be ERR_VST_NOT_COMPATIBLE, meaning that there was an attempt to load a VST Instrument, the player would assume an undetermined status so there would be the need to reload the sound again inside the player through a call the CloseSound method followed by a new LoadSound call.
|
Other values
|
Numeric value representing the unique identifier of the VST effect: this unique identifier will be used in order to invoke further methods related to the use of the loaded VST effect.
|
|
