|
SoundComposer.ItemAmplitudeGet method |
  
|
|
SoundComposer.ItemAmplitudeGet method |
|
Remarks
Obtains the volume amplitude of the given item. The current amplitude can be modified through the SoundComposer.ItemAmplitudeSet method.
For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.
Syntax
[Visual Basic] Public Function ItemAmplitudeGet ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef fAmplitude as Single ) as enumErrorCodes |
[C#] public enumErrorCodes ItemAmplitudeGet ( Int16 nPlayerIndex, Int32 nUniqueId, ref float fAmplitude ); |
[C++] public: enumErrorCodes ItemAmplitudeGet ( Int16 nPlayerIndex, Int32 nUniqueId, float __gc *fAmplitude ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player that owns the sound composer session |
nUniqueId |
The unique identifier of the element previously returned by the call to one of the following methods: - SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd for sound file items. - SoundComposer.ItemSpeechFromStringAdd and SoundComposer.ItemSpeechFromFileAdd for text to speech items. |
fAmplitude |
Reference that, on return from the method call, will contain the item's volume amplitude. - value 0.0 means that sound volume is muted - values higher than 0.0 and smaller than 1.0 attenuate the sound volume - value 1.0 sets the sound at full volume - values higher than 1.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. |
