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: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Plays a formatted file sound, returns true if the sound played OK
+| width="90%" class="mtx-class-macrohead" | '''Play'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Plays a formatted file sound, returns true if the sound played OK&nbsp;
-====Class hierarchy====
+|-
-[[API Sound|Sound]]
+|-
-:[[API Sound|Play]]
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-</div>
+| width="90%" | Filename
-__TOC__
+|-
+| colspan="2" | The formatted file to play&nbsp;
-==Parameters==
+|-
-[[Variable Types|STRING]] ''Filename''
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
-:The formatted file to play
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-==Return value==
-[[Variable Types|BOOL]]
-Returns true if the sound played OK
@@ Line 30: / Line 25: @@
 * Declare a variable 'result' of type BOOL
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Play("filename")</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 13:17, 13 July 2026

Detailed description

Examples

Calling in a calculation