COM Objects > TracksBoard object > Methods > TracksBoard.ItemAmplitudeSet method

Remarks

Changes the amplitude of a specific sound item. The current amplitude can be obtained through the TracksBoard.ItemAmplitudeGet 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]

control.TracksBoard.ItemAmplitudeSet (

nUniqueId as Long,

fAmplitude as Single,

bAutoRefresh as enumBoolean

[C++]

short control.TracksBoard.ItemAmplitudeSet (

long nUniqueId,

float fAmplitude,

short bAutoRefresh

);

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

fAmplitude

The item's amplitude. Can be a number within the range 0.0 - 2.0; values outside this range will be automatically cut to the nearest accepted value.

- value 0.0 mutes the sound

- values higher than 0.0 and lower than 1.0 attenuate the sound volume

- value 1.0 sets the sound at full volume

- values higher than 1.0 up to 2.0 amplify the sound volume

This value can be modified at any time on the TracksBoard user interface through mouse interaction.

bAutoRefresh

Boolean value indicating if the modification should be applied immediately.

Supported values are the following:

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

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