Copyright © 2011-2018 MultiMedia Soft

Effects.VstApply method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies a VST effect to the given portion of sound under editing.

 

During the execution of the editing session the CallbackEditPerc delegate is invoked in order to notify about the percentage of advancement.

 

For further details about callback delegates see the How to synchronize the container application with the API tutorial.

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

For further details about methods related to the use of special effects refer to the EffectsMan class.

 

 

Syntax

 

[Visual Basic]

Public Function VstApply (

nStartPosition as Int32,

nEndPosition as Int32,

nIdVST as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes VstApply (

Int32 nStartPosition,

Int32 nEndPosition,

Int32 nIdVST

);


 

[C++]

public: enumErrorCodes VstApply (

Int32 nStartPosition,

Int32 nEndPosition,

Int32 nIdVST

);


 

 

Parameter

Description

 

 

nStartPosition

Start position, expressed in milliseconds, of the affected sound range.

nEndPosition

End position, expressed in milliseconds, of the affected sound range.. If set to -1 the end position will be set to the end of the sound.

nIdVST

Unique identifier of the VST effect as returned by the Effects.VstLoad method.

 

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.