Difference between revisions of "API Sound.SetRate"
From Flowcode Help
Jump to navigationJump to search| Line 24: | Line 24: | ||
==Detailed description== | ==Detailed description== | ||
| − | The base sample is specified in creation through [[API Sound.Create|Sound.Create]]. This call | + | The base sample is specified in creation through [[API Sound.Create|Sound.Create]]. This call stops the current playing sound and resets that rate. Subsequent sounds played through this handle will play at the given rate. |
| − | + | If the sound handle is currently playing samples, these will be cleared meaning noticeable glitches may occur. To avoid this, use the ''RateMul'' parameter in [[API Sound.Queue|Sound.Queue]] or [[API Sound.QueueEx|Sound.QueueEx]] to perform software conversion per wave, which will not glitch. | |
| − | |||
Revision as of 21:34, 7 August 2013
<sidebar>API contents</sidebar>
Sets the current sample rate for the sound - this will stop the playing sound
Contents
Parameters
HANDLE Sounds
- The handle of the sound object to modify
ULONG Rate
- The sample rate to set
Return value
This call does not return a value
Detailed description
The base sample is specified in creation through Sound.Create. This call stops the current playing sound and resets that rate. Subsequent sounds played through this handle will play at the given rate.
If the sound handle is currently playing samples, these will be cleared meaning noticeable glitches may occur. To avoid this, use the RateMul parameter in Sound.Queue or Sound.QueueEx to perform software conversion per wave, which will not glitch.
Examples
Calling in a calculation
- Add to a calculation icon:
::Sound.SetRate(sounds, rate)
No additional examples
