Classes > TracksBoard class > Methods > TracksBoard.ItemDurationGet method

Remarks

Obtains the duration of the given item.

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

nUniqueId as Int32,

ByRef nLoadedDurationMs as Int32,

ByRef nOriginalDurationMs as Int32

[C#]

public enumErrorCodes ItemDurationGet (

Int32 nUniqueId,

ref Int32 nLoadedDurationMs,

ref Int32 nOriginalDurationMs

);

[C++]

public: enumErrorCodes ItemDurationGet (

Int32 nUniqueId,

ref Int32 nLoadedDurationMs,

ref Int32 nOriginalDurationMs

);

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

nLoadedDurationMs

Reference that, on return from the method call, will contain the duration of the portion of sound file currently loaded, expressed in milliseconds.

This value is affected by a previous call to one between the TracksBoard.ItemSoundFileLoadRangeSet method and the TracksBoard.ItemDurationStretch method.

nOriginalDurationMs

Reference that, on return from the method call, will contain the original duration of the sound file, expressed in milliseconds

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.