API Sound.LoadWav: Difference between revisions
XML import |
XML import |
||
| Line 17: | Line 17: | ||
[[Variable types|UINT]] ''SampleFormat'' | [[Variable types|UINT]] ''SampleFormat'' | ||
: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 types|ULONG]] ''Elements'' | [[Variable types|ULONG]] ''Elements'' | ||
: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 types|FLOAT]] ''SampleRate'' | [[Variable types|FLOAT]] ''SampleRate'' | ||
:Variable to receive the wave source sample rate | |||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
==Return value== | ==Return value== | ||
| Line 32: | Line 33: | ||
''<span style="color:red;">No additional information</span>'' | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 01:54, 12 May 2013
<sidebar>API contents</sidebar> Queues a sound for playing, with the format provided
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
No additional information
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