API Sound.SetRate: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Sets the current sample rate for the sound - this will stop the playing sound | Sets the current sample rate for the sound - this will stop the playing sound | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Sound | |||
::SetRate | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Sounds'' | ''[[Variable types|HANDLE]] Sounds'' | ||
:The handle of the sound object to modify | :The handle of the sound object to modify | ||
| Line 10: | Line 16: | ||
:The sample rate to set | :The sample rate to set | ||
==Return value== | |||
''This call does not return a value'' | ''This call does not return a value'' | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetRate(sounds, rate)</pre> | ||
Revision as of 16:49, 11 May 2013
<sidebar>API contents</sidebar> Sets the current sample rate for the sound - this will stop the playing sound
Class hierarchy
- Sound
- SetRate
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
No additional information
Examples
Calling in a calculation
- Add to a calculation icon:
::Sound.SetRate(sounds, rate)