Copyright © 2001-2018 MultiMedia Soft

VST.InstrumentLoad method

Previous pageReturn to chapter overviewNext page



Loads a VST instrument plugin into the given player from an external dynamic-link library (DLL) file. For VST effects use the VST.EffectLoad method.


For further details about methods related to the use of VST effects refer to the VST COM object.

For further details about managing a VST effect refer to the How to manage VST effects tutorial.





[Visual Basic]

control.VST.InstrumentLoad (

nPlayer as Integer,

strPathname as String,

nFrequency as Long,

nChannels as Integer

) as Long



long control.VST.InstrumentLoad (

short nPlayer,

LPCTSTR strPathname,

long nFrequency,

short nChannels









Number representing the zero-based index of the player that hosts the VST instrument


String representing the filename or absolute pathname of the DLL file containing the VST instrument.

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.


Sample rate of the audio stream


Number of channels of the audio stream




Return value







An error occurred: see the LastError property for further error details or for a list of the possible error values.

Other values

Numeric value representing the unique identifier of the VST instrument: this unique identifier will be used in order to invoke further methods related to the use of the loaded VST instrument.