Difference between revisions of "API Sound.SetRate"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API Sound|Sound]]
+
====Class hierarchy====
 +
[[API Sound|Sound]]
 
:[[API Sound|SetRate]]
 
:[[API Sound|SetRate]]
 
</div>
 
</div>
Line 9: Line 10:
  
 
==Parameters==
 
==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
  
''[[Variable types|ULONG]] Rate''
+
[[Variable types|ULONG]] ''Rate''
 
:The sample rate to set
 
:The sample rate to set
  
Line 19: Line 20:
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetRate(sounds, rate)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetRate(sounds, rate)</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:09, 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)

No additional information