Classes > TracksBoard class > Methods > TracksBoard.ItemSoundFileLoadRangeGet method

Remarks

Obtains the sound file loading range used when the sound file will be added to the session's stream. The loading range can be modified through a call to the TracksBoard.ItemSoundFileLoadRangeSet method.

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

nUniqueId as Int32,

ByRef nStartPositionMs as Int32,

ByRef nEndPositionMs as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes ItemSoundFileLoadRangeGet (

Int32 nUniqueId,

ref Int32 nStartPositionMs,

ref Int32 nEndPositionMs

);

[C++]

public: enumErrorCodes ItemSoundFileLoadRangeGet (

Int32 nUniqueId,

Int32 __gc *nStartPositionMs,

Int32 __gc *nEndPositionMs

);

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

nStartPositionMs

Reference that, on return from the method call, will contain the starting position, expressed in milliseconds, where the sound file loading will occur

nEndPositionMs

Reference that, on return from the method call, will contain the ending position, expressed in milliseconds, where the sound file loading will occur

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.