Difference between revisions of "API Sound.GetRate"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Gets the current sample rate for the sound
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRate'''
 +
|-
 +
| colspan="2" | Gets the current sample rate for the sound&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Sounds
 +
|-
 +
| colspan="2" | The handle of the sound object to read&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|HANDLE]] Sounds''
+
The base sample is specified in creation through [[API Sound.Create|Sound.Create]]. This may be altered through [[API Sound.SetRate|Sound.SetRate]] or software conversion can be done through [[API Sound.Queue|Sound.Queue]] or [[API Sound.QueueEx|Sound.QueueEx]].
−
:The handle of the sound object to read
 
  
−
===Return value===
 
−
[[Variable types|ULONG]]
 
  
−
Returns the current sample rate for the sound
+
==Examples==
−
 
+
===Calling in a calculation===
−
===Detailed description===
 
−
''No additional information''
 
−
 
 
−
===Examples===
 
−
====Calling in a calculation====
 
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
−
* Add to a calculation icon: result = ::Sound.GetRate(sounds)
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetRate(sounds)</pre>

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png GetRate
Gets the current sample rate for the sound 
Fc9-h32-icon.png - HANDLE Sounds
The handle of the sound object to read 
Fc9-u32-icon.png - ULONG Return


Detailed description

The base sample is specified in creation through Sound.Create. This may be altered through Sound.SetRate or software conversion can be done through Sound.Queue or Sound.QueueEx.


Examples

Calling in a calculation

  • Declare a variable 'result' of type ULONG
  • Add to a calculation icon: 
    result = ::Sound.GetRate(sounds)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Sound.GetRate&oldid=30243"