Copyright © 2011-2023 MultiMedia Soft

TracksBoard.ItemSoundFileLoadRangeSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies the sound file loading range used when the sound file will be added to the session's stream. The current loading range can be obtained through a call to the TracksBoard.ItemSoundFileLoadRangeGet method.

 

A call to this method resets the effect of an eventual previous call to the TracksBoard.ItemDurationStretch method.

 

 

Important note about items overlapping

 

Overlapping of two items on the same track is now allowed so, in case the new duration of the item 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 ItemSoundFileLoadRangeSet (

nUniqueId as Int32,

nStartPositionMs as Int32,

nEndPositionMs as Int32,

bAutoRefresh as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes ItemSoundFileLoadRangeSet (

Int32 nUniqueId,

Int32 nStartPositionMs,

Int32 nEndPositionMs,

bool bAutoRefresh

);


 

[C++]

public: enumErrorCodes ItemSoundFileLoadRangeSet (

Int32 nUniqueId,

Int32 nStartPositionMs,

Int32 nEndPositionMs,

bool bAutoRefresh

);


 

Parameter

Description

 

 

nUniqueId

Unique identification number assigned to the sound item after being generated by one of the following methods:

TracksBoard.ItemClone when an existing item has been cloned

nStartPositionMs

The starting position, expressed in milliseconds, where the sound file loading will occur

nEndPositionMs

The ending position, expressed in milliseconds, where the sound file loading will occur

bAutoRefresh

Boolean value indicating if the modification should be applied immediately.

Supported values are the following:

Value

Meaning

false

The modification is not applied immediately and waits for the call to the TracksBoard.ItemCompose method

true

The modification is applied immediately

 

 

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.