API Sound.SetRate: Difference between revisions
m Text replacement - "class="wikitable" style="width:60%; background-color:#FFFFFF;"" to "class="mtx-class-macrotable wikitable"" |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{| class="mtx-class-macrotable wikitable" | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetRate''' | ||
|- | |- | ||
| colspan="2" | Sets the current sample rate for the sound - this will stop the playing sound | | colspan="2" | Sets the current sample rate for the sound - this will stop the playing sound | ||
Latest revision as of 13:17, 13 July 2026
|
SetRate |
| Sets the current sample rate for the sound - this will stop the playing sound | |
 - HANDLE
|
Sounds |
| The handle of the sound object to modify | |
 - ULONG
|
Rate |
| The sample rate to set | |
 - NONE
|
Return |
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)