Copyright © 2001-2018 MultiMedia Soft

VST.GetInfo method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains information about the VST.

 

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.

 

 

Syntax

 

[Visual Basic]

control.VST.GetInfo (

nPlayer as Integer,

nIdVST as Long,

pParamData as Long

) as enumErrorCodes


 

[C++]

short control.VST.GetInfo (

short nPlayer,

long nIdVST,

long *pParamData

);


 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

nIdVST

Unique identifier of the VST effect as returned by the VST.EffectLoad or VST.InstrumentLoad methods.

pParamData

Address of a data structure of type VST_EFFECT_INFO that receives the information about the VST effect.

The VST_EFFECT_INFO data structure is defined in C++ as follows:

 

typedef struct

{

 long    nRegisteredUniqueID;

 long    nVersion;

 long    nVstVersion;

 long    nVstMaxSupportedVersion;

 long    nInputChannels;

 long    nOutputChannels;

 long    nInitialDelay;

 long    ptrUnderlyingAEffect;

} VST_EFFECT_INFO;

 

Member name

Description

 

 

nRegisteredUniqueID

Unique identifier of the VST effect: this unique identifier is assigned and registered at Steinberg

nVersion

Effect version

nVstVersion

The VST version the effect was written for

nVstMaxSupportedVersion

The max VST version (currently 2.4) supported by the control

nInputChannels

Max number of supported input channels

nOutputChannels

Max number of supported output channels

nInitialDelay

Plugin latency expressed in samples

ptrUnderlyingAEffect

The underlying AEffect object (see aeffectx.h in the VST SDK for further details)

 

 

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.