Difference between revisions of "API Sound.GetPending"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
Line 2: | Line 2: | ||
Gets the number of sample blocks queued or playing for the sound | Gets the number of sample blocks queued or playing for the sound | ||
+ | <div style="width:25%; float:right" class="toc"> | ||
+ | ===Class hierarchy=== | ||
+ | :Sound | ||
+ | ::GetPending | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
''[[Variable types|HANDLE]] Sounds'' | ''[[Variable types|HANDLE]] Sounds'' | ||
:The handle of the sound object to read | :The handle of the sound object to read | ||
− | + | ==Return value== | |
[[Variable types|ULONG]] | [[Variable types|ULONG]] | ||
Returns the number of sample blocks queued or playing for the sound | Returns the number of sample blocks queued or playing for the sound | ||
− | + | ==Detailed description== | |
''No additional information'' | ''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: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetPending(sounds)</pre> |
Revision as of 16:50, 11 May 2013
<sidebar>API contents</sidebar> Gets the number of sample blocks queued or playing for the sound
Class hierarchy
- Sound
- GetPending
Contents
Parameters
HANDLE Sounds
- The handle of the sound object to read
Return value
Returns the number of sample blocks queued or playing for the sound
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type ULONG
- Add to a calculation icon:
result = ::Sound.GetPending(sounds)