Jump to content

API Sound.GetRate: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
{| class="mtx-class-macrotable wikitable"
Gets the current sample rate for the sound
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


<div style="width:25%; float:right" class="toc">
===Class hierarchy===
:Sound
::GetRate
</div>
__TOC__


==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


==Detailed description==
''No additional information''


==Examples==
==Examples==

Latest revision as of 13:17, 13 July 2026

GetRate
Gets the current sample rate for the sound 
- HANDLE Sounds
The handle of the sound object to read 
- 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)