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.
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.ItemVolumePointPositionSet ( nUniqueId as Long, nIndex as Long, nPositionMs as Long, bAutoRefresh as enumBoolean ) as enumErrorCodes |
[C++] short control.TracksBoard.ItemVolumePointPositionSet ( long nUniqueId, long nIndex, long nPositionMs, short bAutoRefresh ); |
Parameter |
Description |
||||||||||||||
|
|
||||||||||||||
nUniqueId |
Unique identification number assigned to the sound item after being generated by one of the following methods:
|
||||||||||||||
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:
|
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 |