Difference between revisions of "API Sound.Play"

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 10: Line 10:
  
 
==Parameters==
 
==Parameters==
[[Variable types|STRING]] ''Filename''
+
[[Variable Types|STRING]] ''Filename''
 
:The formatted file to play
 
:The formatted file to play
  
  
 
==Return value==
 
==Return value==
[[Variable types|BOOL]]
+
[[Variable Types|BOOL]]
  
 
Returns true if the sound played OK
 
Returns true if the sound played OK

Revision as of 11:09, 10 June 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