|
TracksBoard.ItemAmplitudeSet method |
  
|
|
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 class section.
Syntax
[Visual Basic] Public Function ItemAmplitudeSet ( nUniqueId as Int32, fAmplitude as Single, bAutoRefresh as Boolean ) as enumErrorCodes |
[C#] public enumErrorCodes ItemAmplitudeSet ( Int32 nUniqueId, float fAmplitude, bool bAutoRefresh ); |
[C++] public: enumErrorCodes ItemAmplitudeSet ( Int32 nUniqueId, float fAmplitude, bool bAutoRefresh ); |
Parameter |
Description |
||||||
|
|
||||||
nUniqueId |
Unique identification number assigned to the sound item after being generated by one of the following methods:
|
||||||
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:
|
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 |
