Difference between revisions of "API Sound.GetPending"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
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==== | ||
| + | [[API Sound|Sound]] | ||
| + | :[[API Sound|GetPending]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Sounds'' | |
:The handle of the sound object to read | :The handle of the sound object to read | ||
| − | + | ||
| − | [[Variable | + | ==Return value== |
| + | [[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 | ||
| − | |||
| − | |||
| − | ===Examples | + | ==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 | * 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> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets the number of sample blocks queued or playing for the sound
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
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)
No additional examples
