Classes > TracksBoard class > Methods > TracksBoard.ItemVolumePointPositionSet method

Remarks

Predisposes a modification to the current position 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.

The current position of the volume point can be obtained through the TracksBoard.ItemVolumePointPositionGet 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]

Public Function ItemVolumePointPositionSet (

nUniqueId as Int32,

nIndex as Int32,

nPositionMs as Int32,

bAutoRefresh as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes ItemVolumePointPositionSet (

Int32 nUniqueId,

Int32 nIndex,

Int32 nPositionMs,

bool bAutoRefresh

);

[C++]

public: enumErrorCodes ItemVolumePointPositionSet (

Int32 nUniqueId,

Int32 nIndex,

Int32 nPositionMs,

bool 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.

nPositionMs

The new position of the volume point, expressed in milliseconds, respect to the beginning of the original sound: this position must be within the loaded range set through the nStartPositionMs and nEndPositionMs parameters of the TracksBoard.ItemSoundFileAdd and TracksBoard.ItemSoundFileLoadRangeSet methods or an error would be reported.

This position cannot be modified for the first and last volume points of the list whose position is read-only and set to the beginning and to the end of the loaded range.

The new position must be higher than the position set into the previous volume point and lower than the position set into the next volume point: values exceeding this range will be automatically capped to the nearest valid position.

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 "true"

•	TracksBoard.ItemVolumePointPositionSet with its bAutoRefresh parameter set to "true"

•	TracksBoard.ItemVolumePointCurveSet with its bAutoRefresh parameter set to "true"

•	TracksBoard.ItemVolumePointCurveSetEx with its bAutoRefresh parameter set to "true"

BOOL_TRUE

The modification is applied immediately

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.