Copyright © 2008-2018 MultiMedia Soft

SoundComposer.ItemAmplitudeGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the amplitude used to generate a specific item. The amplitude can be modified through the SoundComposer.ItemAmplitudeSet method.

This method cannot be used to obtain the amplitude of a sliding wave tone: for this purpose you can use the SoundComposer.ItemSlidingWaveToneLimitsGet method.

 

For further details about sound composing see the the SoundComposer object and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

control.SoundComposer.ItemAmplitudeGet (

nUniqueId as Long,

ByRef fAmplitude as Single

) as enumErrorCodes


 

[C++]

short control.SoundComposer.ItemAmplitudeGet (

long nUniqueId,

float *fAmplitude

);


 

Parameter

Description

 

 

nUniqueId

The unique identifier of the element previously returned by the call to one of the following methods:

- SoundComposer.ItemDtmfStringAdd for DTMF items.

- SoundComposer.ItemNoiseAdd for noise tone items.

- SoundComposer.ItemSlidingWaveToneAdd for sliding wave tone items.

- SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd, SoundComposer.ItemSoundFileFromEditorAdd,and SoundComposer.ItemSoundFileFromRecorderAdd for sound file items

- SoundComposer.ItemWaveToneAdd for wave tone 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 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, check the LastError property value in order to get the error code

enumErrorCodes.ERR_NOERROR (0)

The method call was successful