API Sound.LoadWav: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|STRING]] ''Filename'' | ||
:The formatted file to load into memory | :The formatted file to load into memory | ||
[[Variable | [[Variable Types|BYTE[]]] ''Buffer'' | ||
:A buffer to write the wave data to | :A buffer to write the wave data to | ||
[[Variable | [[Variable Types|UINT]] ''SampleFormat'' | ||
:Variable to receive the format of the samples | :Variable to receive the format of the samples | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
[[Variable | [[Variable Types|ULONG]] ''Elements'' | ||
:Variable to receive the number of sample elements to play | :Variable to receive the number of sample elements to play | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
[[Variable | [[Variable Types|FLOAT]] ''SampleRate'' | ||
:Variable to receive the wave source sample rate | :Variable to receive the wave source sample rate | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| Line 30: | Line 30: | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|BOOL]] | ||
Returns true if the operation is a success, else false | Returns true if the operation is a success, else false | ||
Revision as of 11:09, 10 June 2013
<sidebar>API contents</sidebar> Loads a wave file into memory, providing the values needed to play it
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