API Sound.LoadWav

<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

BOOL

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