API Sound.LoadWav: Difference between revisions

Latest revision as of 13:17, 13 July 2026

	LoadWav
Loads a wave file into memory, providing the values needed to play it
- 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
- ULONG	Elements
Variable to receive the number of sample elements to play
- FLOAT	SampleRate
Variable to receive the wave source sample rate
- BOOL	Return

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)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Queues a sound for playing, with the format provided
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''LoadWav'''
+|-
+| colspan="2" | Loads a wave file into memory, providing the values needed to play it&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Filename
+|-
+| colspan="2" | The formatted file to load into memory&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE[]
+| width="90%" | Buffer
+|-
+| colspan="2" | A buffer to write the wave data to&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | SampleFormat
+|-
+| colspan="2" | Variable to receive the format of the samples&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Elements
+|-
+| colspan="2" | Variable to receive the number of sample elements to play&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | SampleRate
+|-
+| colspan="2" | Variable to receive the wave source sample rate&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Sound|Sound]]
-:[[API Sound|LoadWav]]
-</div>
-__TOC__
-==Parameters==
-[[Variable types|STRING]] ''Filename''
-:The formatted file to load into memory
-[[Variable types|BYTE[]]] ''Buffer''
-:A buffer to write the wave data to
-[[Variable types|UINT]] ''SampleFormat''
-:Variable to receive the format of the samples
-:''This parameter is returned back to the caller''
-[[Variable types|ULONG]] ''Elements''
-:Variable to receive the number of sample elements to play
-:''This parameter is returned back to the caller''
-[[Variable types|FLOAT]] ''SampleRate''
-:Variable to receive the wave source sample rate
-:''This parameter is returned back to the caller''
+==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.
-==Return value==
-[[Variable types|BOOL]]
-''<span style="color:red;">No additional information</span>''
+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.
-==Detailed description==
+If ''Buffer'' is not large enough for the wave data it is resized in the call to an appropriate size.
-''<span style="color:red;">No additional information</span>''
@@ Line 43: / Line 51: @@
 * Declare a variable 'result' of type BOOL
 * 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 information</span>''

SteveT (talk | contribs)

Latest revision as of 13:17, 13 July 2026

Detailed description

Examples

Calling in a calculation