TracksBoard.ItemOffsetMove method |
|
Remarks
Moves of a given amount the offset of a specific item. The current offset can be obtained through the TracksBoard.ItemOffsetGet method and set through the TracksBoard.ItemOffsetSet method.
Important note about items overlapping
Overlapping of two items on the same track is now allowed so, in case the offset change should cause an overlapping and upon space availability, the item will be automatically moved to the next track or to the previous track; if both previous and next tracks should in any case suffer an overlapping, a new track will be automatically inserted on the nearest position.
|
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 object section.
Syntax
[Visual Basic] Public Function ItemOffsetMove ( nUniqueId as Int32, nOffsetMs as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemOffsetMove ( Int32 nUniqueId, Int32 nOffsetMs ); |
[C++] public: enumErrorCodes ItemOffsetMove ( Int32 nUniqueId, Int32 nOffsetMs ); |
Parameter |
Description |
||||||
|
|
||||||
nUniqueId |
Unique identification number assigned to the sound item after being generated by one of the following methods:
When this value is set to -1 all of the existing items are moved of the same amount. |
||||||
nOffsetMs |
Amount of movement applied to the current offset of the item, expressed in milliseconds. Negative values will move the offset backward while positive values will move the offset forward. In case the amount to move should bring the item(s) on a negative position, the amount to move will be reduced accordingly in order to keep all offsets >= 0 |
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 |