Difference between revisions of "API Sound.Flush"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Stops all playing and queued sounds | Stops all playing and queued sounds | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API Sound|Sound]] | + | ====Class hierarchy==== |
| + | [[API Sound|Sound]] | ||
:[[API Sound|Flush]] | :[[API Sound|Flush]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable Types|HANDLE]] ''Sounds'' | |
:The handle of the sound object to flush | :The handle of the sound object to flush | ||
| + | |||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | + | This will cause all sound waves currently playing or queued in the handle to be discarded. | |
| + | |||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Sound.Flush(sounds)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Sound.Flush(sounds)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Stops all playing and queued sounds
Contents
Parameters
HANDLE Sounds
- The handle of the sound object to flush
Return value
This call does not return a value
Detailed description
This will cause all sound waves currently playing or queued in the handle to be discarded.
Examples
Calling in a calculation
- Add to a calculation icon:
::Sound.Flush(sounds)
No additional examples
