|
SoundComposer.ItemSlidingWaveToneLimitsGet method |
  
|
|
SoundComposer.ItemSlidingWaveToneLimitsGet method |
|
Remarks
Obtains initial and final frequencies and amplitudes used to generate a specific sliding wave tone item. Frequencies and/or amplitudes can be modified through the SoundComposer.ItemSlidingWaveToneLimitsSet 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.ItemSlidingWaveToneLimitsGet ( nUniqueId as Long, ByRef fFrequencyStart as Single, ByRef fFrequencyEnd as Single, ByRef fAmplitudeStart as Single, ByRef fAmplitudeEnd as Single ) as enumErrorCodes |
[C++] short control.SoundComposer.ItemSlidingWaveToneLimitsGet ( long nUniqueId, float *fFrequencyStart, float *fFrequencyEnd, float *fAmplitudeStart, float *fAmplitudeEnd ); |
Parameter |
Description |
|
|
nUniqueId |
The unique identifier of the element previously returned by the call to the SoundComposer.ItemSlidingWaveToneAdd method. |
fFrequencyStart |
Reference that, on return from the method call, will contain the initial wave tone frequency expressed in Hertz, e.g. 700 |
fFrequencyEnd |
Reference that, on return from the method call, will contain the final wave tone frequency expressed in Hertz, e.g. 1000 |
fAmplitudeStart |
Reference that, on return from the method call, will contain the initial wave tone amplitude. - value 0.0 means that sound volume is muted - values higher than 0.0 and lower than 1.0 attenuates the sound volume - value 1.0 sets the sound at full volume - values higher than 1.0 amplifies the sound volume |
fAmplitudeEnd |
Reference that, on return from the method call, will contain the final wave tone amplitude. - value 0.0 means that sound volume is muted - 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 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 |
