Difference between revisions of "API Sound.Play"
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> |
Plays a formatted file sound, returns true if the sound played OK | Plays a formatted file sound, returns true if the sound played OK | ||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''Filename'' |
:The formatted file to play | :The formatted file to play | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|BOOL]] |
Returns true if the sound played OK | Returns true if the sound played OK | ||
| Line 21: | Line 21: | ||
==Detailed description== | ==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 [http://en.wikipedia.org/wiki/WAV WAV file] for a more detailed description of a WAV file. |
| Line 29: | Line 29: | ||
* 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 | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Plays a formatted file sound, returns true if the sound played OK
Contents
Parameters
STRING Filename
- The formatted file to play
Return value
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
