API Sound.LoadWav: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Queues a sound for playing, with the format provided | Queues a sound for playing, with the format provided | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Sound | |||
::LoadWav | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|STRING]] Filename'' | ''[[Variable types|STRING]] Filename'' | ||
:The formatted file to load into memory | :The formatted file to load into memory | ||
| Line 22: | Line 28: | ||
:Variable to receive the wave source sample rate | :Variable to receive the wave source sample rate | ||
==Return value== | |||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
No additional information | No additional information | ||
==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.LoadWav("filename", _arraybuffer, return_sampleformat, return_elements, return_samplerate)</pre> | ||
Revision as of 16:47, 11 May 2013
<sidebar>API contents</sidebar> Queues a sound for playing, with the format provided
Class hierarchy
- Sound
- LoadWav
Parameters
STRING Filename
- The formatted file to load into memory
BYTE[] Buffer
- A buffer to write the wave data to
UINT SampleFormat
- This parameter is returned back to the caller
- Variable to receive the format of the samples
ULONG Elements
- This parameter is returned back to the caller
- Variable to receive the number of sample elements to play
FLOAT SampleRate
- This parameter is returned back to the caller
- Variable to receive the wave source sample rate
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)