Difference between revisions of "API Sound.GetPending"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(12 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 number of sample blocks queued or playing 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;" | '''GetPending'''
 +
|-
 +
| colspan="2" | Gets the number of sample blocks queued or playing 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
 
::GetPending
 
</div>
 
__TOC__
 
  
==Parameters==
+
==Detailed description==
''[[Variable types|HANDLE]] Sounds''
+
The number of pending sounds includes those currently playing. This call can be used to sequence smooth sound where a certain number of samples need to be continuously queued to achieve a smooth effect.
:The handle of the sound object to read
 
 
 
==Return value==
 
[[Variable types|ULONG]]
 
 
 
Returns the number of sample blocks queued or playing for the sound
 
  
==Detailed description==
 
''No additional information''
 
  
 
==Examples==
 
==Examples==

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png GetPending
Gets the number of sample blocks queued or playing 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 number of pending sounds includes those currently playing. This call can be used to sequence smooth sound where a certain number of samples need to be continuously queued to achieve a smooth effect.


Examples

Calling in a calculation

  • Declare a variable 'result' of type ULONG
  • Add to a calculation icon:
    result = ::Sound.GetPending(sounds)