|
TracksBoard.ItemVolumePointAmplitudeGet method |
  
|
|
TracksBoard.ItemVolumePointAmplitudeGet method |
|
Remarks
Obtains the amplitude of a specific volume point previously added to the given sound item through the TracksBoard.ItemVolumePointAdd method. The amplitude of the volume point can be modified through the TracksBoard.ItemVolumePointAmplitudeSet 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 class section.
Syntax
[Visual Basic] Public Function ItemVolumePointAmplitudeGet ( nUniqueId as Int32, nIndex as Int32, ByRef fAmplitude as Single ) as enumErrorCodes |
[C#] public enumErrorCodes ItemVolumePointAmplitudeGet ( Int32 nUniqueId, Int32 nIndex, ref float fAmplitude ); |
[C++] public: enumErrorCodes ItemVolumePointAmplitudeGet ( Int32 nUniqueId, Int32 nIndex, float __gc *fAmplitude ); |
Parameter |
Description |
||||||
|
|
||||||
nUniqueId |
Unique identification number assigned to the sound item after being generated by one of the following methods:
|
||||||
nIndex |
Zero-based index of the volume point. The total number of available volume points can be obtained through the TracksBoard.ItemVolumePointCountGet method. |
||||||
fAmplitude |
Reference that, on return from the method call, will contain the amplitude of the volume point. 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 |
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. |
