API Sound.Play: Difference between revisions
XML import API changes |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{| class="mtx-class-macrotable wikitable" | |||
Plays a formatted file sound, returns true if the sound played OK | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''Play''' | |||
|- | |||
[[ | | colspan="2" | Plays a formatted file sound, returns true if the sound played OK | ||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" | Filename | |||
= | |- | ||
| colspan="2" | The formatted file to play | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
== | |} | ||
[[ | |||
==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 28: | Line 25: | ||
* 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> | ||
Latest revision as of 13:17, 13 July 2026
|
Play |
| Plays a formatted file sound, returns true if the sound played OK | |
 - STRING
|
Filename |
| The formatted file to play | |
 - BOOL
|
Return |
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")