|
TracksBoard.ItemVolumePointRemove method |
  
|
|
TracksBoard.ItemVolumePointRemove method |
|
Remarks
Predisposes the removal of a specific volume point previously added to the given sound item through the TracksBoard.ItemVolumePointAdd method: the removal of the volume point is not immediately applied so, in order to be effective, modifications to existing volume points need to be applied through a later call to the TracksBoard.ItemVolumePointsApply method.
Volume points may be automatically removed in case the duration of the sound item, containing the volume point, should be resized through the mouse and the volume point should fall outside of the new duration of the sound item itself.
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 ItemVolumePointRemove ( nUniqueId as Int32, nIndex as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemVolumePointRemove ( Int32 nUniqueId, Int32 nIndex ); |
[C++] public: enumErrorCodes ItemVolumePointRemove ( Int32 nUniqueId, Int32 nIndex ); |
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 to remove; set this value to -1 to remove all of the available volume points from the given item. The total number of available volume points can be obtained through the TracksBoard.ItemVolumePointCountGet method.
The first and last volume points of the list, whose position is automatically set to the beginning and to the end of the loaded range, are read-only so they cannot be removed. |
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. |
