Difference between revisions of "API Sound.Play"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<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|Play]]
 
:[[API Sound|Play]]
 
</div>
 
</div>
Line 9: Line 10:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|STRING]] Filename''
+
[[Variable types|STRING]] ''Filename''
 
:The formatted file to play
 
:The formatted file to play
  
Line 18: Line 19:
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
Line 24: Line 26:
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Play("filename")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Play("filename")</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:09, 11 May 2013

<sidebar>API contents</sidebar> Plays a formatted file sound, returns true if the sound played OK

Class hierarchy

Sound

Play

Parameters

STRING Filename

The formatted file to play

Return value

BOOL

Returns true if the sound played OK

Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Sound.Play("filename")

No additional information