Difference between revisions of "API Sound.GetRate"

From Flowcode Help
Jump to navigationJump to search
(XML import)
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]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRate'''
====Class hierarchy====
+
|-
[[API Sound|Sound]]
+
| colspan="2" | Gets the current sample rate for the sound&nbsp;
:[[API Sound|GetRate]]
+
|-
</div>
+
|-
__TOC__
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
+
| width="90%" | Sounds
==Parameters==
+
|-
[[Variable Types|HANDLE]] ''Sounds''
+
| colspan="2" | The handle of the sound object to read&nbsp;
:The handle of the sound object to read
+
|-
 
+
| 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''
==Return value==
+
|}
[[Variable Types|ULONG]]
 
 
 
Returns the current sample rate for the sound
 
  
  

Revision as of 11:41, 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)

No additional examples