Difference between revisions of "API Sound.Play"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Plays a formatted file sound, returns true if the sound played OK | Plays a formatted file sound, returns true if the sound played OK | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Sound | ||
| + | ::Play | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|STRING]] Filename'' | ''[[Variable types|STRING]] Filename'' | ||
:The formatted file to play | :The formatted file to play | ||
| − | + | ==Return value== | |
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
Returns true if the sound played OK | Returns true if the sound played OK | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Play("filename")</pre> |
Revision as of 16:46, 11 May 2013
<sidebar>API contents</sidebar> Plays a formatted file sound, returns true if the sound played OK
Class hierarchy
- Sound
- Play
Contents
Parameters
STRING Filename
- The formatted file to play
Return value
Returns true if the sound played OK
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")
