API Sound.Play: Difference between revisions

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")
```

@@ Line 1: / Line 1: @@
-API contents
+{| 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&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Filename
+|-
+| colspan="2" | The formatted file to play&nbsp;
+|-
+| 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''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|STRING]] Filename''
+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.
-:The formatted file to play
-===Return value===
-[[Variable types|BOOL]]
-Returns true if the sound played OK
+==Examples==
+===Calling in a calculation===
-===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")
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Play("filename")</pre>

SteveT (talk | contribs)

Latest revision as of 13:17, 13 July 2026

Detailed description

Examples

Calling in a calculation