Classes > TracksBoard class > Methods > TracksBoard.ItemAmplitudeGet method

Remarks

Obtains the amplitude of a specific sound item. The amplitude can be modified through the TracksBoard.ItemAmplitudeSet 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 object section.

Syntax

[Visual Basic]

Public Function ItemAmplitudeGet (

nUniqueId as Int32,

ByRef fAmplitude as Single

) as enumErrorCodes

[C#]

public enumErrorCodes ItemAmplitudeGet (

Int32 nUniqueId,

ref float fAmplitude

);

[C++]

public: enumErrorCodes ItemAmplitudeGet (

Int32 nUniqueId,

float __gc *fAmplitude

);

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

Reference that, on return from the method call, will contain the item's amplitude.

- 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

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