COM Objects > TracksBoard object > Methods > TracksBoard.ItemVolumePointAmplitudeSet method

Remarks

Predisposes a modification to the amplitude of a specific volume point previously added to the given sound item through the TracksBoard.ItemVolumePointAdd method: the change becomes effective after invoking the TracksBoard.ItemVolumePointsApply method

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard class section.

Syntax

[Visual Basic]

control.TracksBoard.ItemVolumePointAmplitudeSet (

nUniqueId as Long,

nIndex as Long,

fAmplitude as Single,

bAutoRefresh as enumBoolean

) as enumErrorCodes

[C++]

short control.TracksBoard.ItemVolumePointAmplitudeSet (

long nUniqueId,

long nIndex,

float fAmplitude,

short bAutoRefresh

);

Parameter

Description

nUniqueId

Unique identification number assigned to the sound item after being generated by one of the following methods:

•	TracksBoard.ItemSoundFileAdd and TracksBoard.ItemSoundFileRawAdd for sound files

•	TracksBoard.ItemSpeechFromStringAdd and TracksBoard.ItemSpeechFromFileAdd for text to speech items

•	TracksBoard.ItemClone when an existing item has been cloned

nIndex

Zero-based index of the volume point. The total number of available volume points can be obtained through the TracksBoard.ItemVolumePointCountGet method.

fAmplitude

Amplitude of the volume point.

Can be a number within the range 0.0 - 2.0; values outside this range will be automatically cut to the nearest accepted value.

- value 0.0 mutes the sound

- values higher than 0.0 and lower than 1.0 attenuate the sound volume

- value 1.0 sets the sound at full volume

- values higher than 1.0 up to 2.0 amplify the sound volume

bAutoRefresh

Boolean value indicating if the modification should be applied immediately.

Supported values are the following:

Value

Meaning

BOOL_FALSE

The modification is not applied immediately and will be applied through a later call to one between the following methods:

•	TracksBoard.ItemVolumePointsApply

•	TracksBoard.ItemVolumePointAmplitudeSet with its bAutoRefresh parameter set to BOOL_TRUE

•	TracksBoard.ItemVolumePointPositionSet with its bAutoRefresh parameter set to BOOL_TRUE

•	TracksBoard.ItemVolumePointCurveSet with its bAutoRefresh parameter set to BOOL_TRUE

•	TracksBoard.ItemVolumePointCurveSetEx with its bAutoRefresh parameter set to BOOL_TRUE

BOOL_TRUE

The modification is applied immediately

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful