Difference between revisions of "API Sound.LoadWav"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 1: | Line 1: | ||
<sidebar>API contents</sidebar> | <sidebar>API contents</sidebar> | ||
| − | + | Loads a wave file into memory, providing the values needed to play it | |
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| Line 32: | Line 32: | ||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
| − | + | Returns true if the operation is a success, else false | |
Revision as of 21:28, 12 May 2013
<sidebar>API contents</sidebar> Loads a wave file into memory, providing the values needed to play it
Contents
Parameters
STRING Filename
- The formatted file to load into memory
BYTE[] Buffer
- A buffer to write the wave data to
UINT SampleFormat
- Variable to receive the format of the samples
- This parameter is returned back to the caller
ULONG Elements
- Variable to receive the number of sample elements to play
- This parameter is returned back to the caller
FLOAT SampleRate
- Variable to receive the wave source sample rate
- This parameter is returned back to the caller
Return value
Returns true if the operation is a success, else false
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Sound.LoadWav("filename", _arraybuffer, return_sampleformat, return_elements, return_samplerate)
No additional information
