SoundComposer.ItemSlidingWaveToneLimitsSet method |
|
Remarks
Modifies initial and final frequencies and amplitudes used to generate a specific sliding wave tone item. Current frequencies and/or amplitudes can be obtained through the SoundComposer.ItemSlidingWaveToneLimitsGet 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 ItemSlidingWaveToneLimitsSet ( nUniqueId as Int32, fFrequencyStart as Single, fFrequencyEnd as Single, fAmplitudeStart as Single, fAmplitudeEnd as Single ) as enumErrorCodes |
[C#] public enumErrorCodes ItemSlidingWaveToneLimitsSet ( Int32 nUniqueId, float fFrequencyStart, float fFrequencyEnd, float fAmplitudeStart, float fAmplitudeEnd ); |
[C++] public: enumErrorCodes ItemSlidingWaveToneLimitsSet ( Int32 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 |
Initial wave tone frequency expressed in Hertz, e.g. 700 |
fFrequencyEnd |
Final wave tone frequency expressed in Hertz, e.g. 1000 |
fAmplitudeStart |
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 |
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 (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |