Copyright © 2005-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 VSTs class.

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

 

 

Syntax

 

[Visual Basic]

Public Function GetInfo (

nPlayerIndex as Int16,

nIdVST as Int32,

ByRef Info as VstEffectInfo

) as enumErrorCodes


 

[C#]

public enumErrorCodes GetInfo (

Int16 nPlayerIndex,

Int32 nIdVST,

ref VstEffectInfo Info

);


 

[C++]

public: enumErrorCodes GetInfo (

Int16 nPlayerIndex,

Int32 nIdVST,

VstEffectInfo __gc *Info

);


 

 

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 or VST.InstrumentLoad methods.

Info

Reference to an instance of class VstEffectInfo containing information about the VST effect.

The VstEffectInfo class is defined in C# as follows:

 

public class VstEffectInfo

{

 public Int32   nRegisteredUniqueID;

 public Int32   nVersion;

 public Int32   nVstVersion;

 public Int32   nVstMaxSupportedVersion;

 public Int32   nInputChannels;

 public Int32   nOutputChannels;

 public Int32   nInitialDelay;

 public Int32   ptrUnderlyingAEffect;

}

 

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.