Classes > TracksBoard class > Methods > TracksBoard.ItemVolumePointPositionGet method

Remarks

Obtains the current position of a specific volume point previously added to the given sound item through the TracksBoard.ItemVolumePointAdd method. The position of the volume point can be modified through the TracksBoard.ItemVolumePointPositionSet 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 ItemVolumePointPositionGet (

nUniqueId as Int32,

nIndex as Int32,

ByRef nPositionMs as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes ItemVolumePointPositionGet (

Int32 nUniqueId,

Int32 nIndex,

ref Int32 nPositionMs

);

[C++]

public: enumErrorCodes ItemVolumePointPositionGet (

Int32 nUniqueId,

Int32 nIndex,

Int32 __gc *nPositionMs

);

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

nIndex

Zero-based index of the volume point. The total number of available volume points can be obtained through the TracksBoard.ItemVolumePointCountGet method.

nPositionMs

Reference that, on return from the method call, will contain the current position of the volume point.

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.