Difference between revisions of "API Sound.Play"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
(XML import)
Line 1: Line 1:
 
 
 
<sidebar>API Contents</sidebar>
 
<sidebar>API Contents</sidebar>
 
Plays a formatted file sound, returns true if the sound played OK
 
Plays a formatted file sound, returns true if the sound played OK

Revision as of 15:57, 16 January 2014

<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

This plays WAV files given a Filename to the data. The Filename may point to a resource file. The data in the file should be in a RIFF format, see WAV file for a more detailed description of a WAV file.


Examples

Calling in a calculation

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

No additional examples