Difference between revisions of "API Sound.Flush"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Stops all playing and queued sounds
 
Stops all playing and queued sounds
  
Line 19: Line 19:
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
This will cause all sound waves currently playing or queued in the handle to be discarded.
  
  
Line 26: Line 26:
 
* 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 information</span>''
+
''<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

Class hierarchy

Sound

Flush

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