Remarks
Obtains specific information about the given parameter.
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 ProgramParamGetInfo (
nPlayerIndex as Int16,
nIdVST as Int32,
nProgramIndex as Int16,
nParamIndex as Int16,
nInfo as enumVstParamInfo
) as string
|
|
[C#]
public string ProgramParamGetInfo (
Int16 nPlayerIndex,
Int32 nIdVST,
Int16 nProgramIndex,
Int16 nParamIndex,
enumVstParamInfo nInfo
);
|
|
[C++]
public: string ProgramParamGetInfo (
Int16 nPlayerIndex,
Int32 nIdVST,
Int16 nProgramIndex,
Int16 nParamIndex,
enumVstParamInfo nInfo
);
|
|
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.
|
nProgramIndex
|
Zero-based index of the program
|
nParamIndex
|
Zero-based index of the parameter
|
nInfo
|
Type of requested information.
Supported values are the following:
Mnemonic constant
|
Value
|
Meaning
|
VST_PARAM_INFO_NAME
|
0
|
VST Parameter Name, for example Time, Gain, RoomType, etc.
|
VST_PARAM_INFO_LABEL
|
1
|
VST Parameter Label. This usually represents the unit of measure for the parameter, for example dB, type, sec., etc.
|
VST_PARAM_INFO_DISPLAY
|
2
|
VST Parameter Display. This usually represents the current value of the parameter in a readable format but it's not guaranteed that all VSTs available on the marker will always use this parameter for this specific purpose.
|
|
Return value
Value
|
Meaning
|
|
|
Empty string
|
An error occurred (see the LastError property for further error details)
|
Valid string
|
String containing the requested information
|
|
