Classes > TracksBoard class > Methods > TracksBoard.ItemOffsetGet method

Remarks

Modifies the offset of a specific item respect to the beginning of the session. The current offset can be modified through the TracksBoard.ItemOffsetSet method or, on the TracksBoard user interface, through mouse interaction.

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 ItemOffsetGet (

nUniqueId as Int32,

ByRef nOffsetMs as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes ItemOffsetGet (

Int32 nUniqueId,

ref Int32 nOffsetMs

);

[C++]

public: enumErrorCodes ItemOffsetGet (

Int32 nUniqueId,

Int32 __gc *nOffsetMs

);

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

nOffsetMs

Reference that, after returning from the method call, will contain the current offset of the item, expressed in milliseconds.

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