Difference between revisions of "API Sound.LoadWav"
(XML Import to change Variable types into Variable Types) |
(XML import) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Loads a wave file into memory, providing the values needed to play it | Loads a wave file into memory, providing the values needed to play it | ||
| Line 36: | Line 36: | ||
==Detailed description== | ==Detailed description== | ||
| − | '' | + | This loads WAV files given a ''Filename'' to the data. The ''Filename'' may point to a resource file. The data in the file should be in a RIFF format, see [http://en.wikipedia.org/wiki/WAV WAV file] for a more detailed description of a WAV file. |
| + | |||
| + | |||
| + | On exit from the routine, the ''Buffer'', ''SampleFormat'', ''Elements'' and ''SampleRate'' are all updated to contain data read from the file. These are all written with zero values (''Buffer'' is not altered) if the call fails. | ||
| + | |||
| + | |||
| + | If ''Buffer'' is not large enough for the wave data it is resized in the call to an appropriate size. | ||
| Line 44: | Line 50: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.LoadWav("filename", _arraybuffer, return_sampleformat, return_elements, return_samplerate)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.LoadWav("filename", _arraybuffer, return_sampleformat, return_elements, return_samplerate)</pre> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<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
This loads WAV files given a Filename to the data. The Filename may point to a resource file. The data in the file should be in a RIFF format, see WAV file for a more detailed description of a WAV file.
On exit from the routine, the Buffer, SampleFormat, Elements and SampleRate are all updated to contain data read from the file. These are all written with zero values (Buffer is not altered) if the call fails.
If Buffer is not large enough for the wave data it is resized in the call to an appropriate size.
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 examples
