Copyright © 2001-2018 MultiMedia Soft

VST.ProgramParamSetValue method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the new value for the specific parameter related to the given program.

 

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.ProgramParamSetValue (

nPlayer as Integer,

nIdVST as Long,

nProgramIndex as Integer,

nParamIndex as Integer,

fValue as Single

) as enumErrorCodes


 

[C++]

short control.VST.ProgramParamSetValue (

short nPlayer,

long nIdVST,

short nProgramIndex,

short nParamIndex,

float fValue

);


 

 

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.

nProgramIndex

Zero-based index of the program

nParamIndex

Zero-based index of the parameter

fValue

The new value of the given parameter.

Values must be always in the range between 0.0 and 1.0, however, from the view of a VST effect, they may represent completely different values. In general, this value represents the ratio between the minimum and maximum values that the parameter could assume and not the "real" value of the parameter; if for example a certain parameter should have values inside the range 0-256, a value of 128 would be returned as 0.5.

 

 

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.