API Sound.LoadWav - Revision history

Wiki bot at 11:55, 16 January 2023

2023-01-16T11:55:07Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:40Z

JonnyW: XML import

2014-01-16T15:57:59Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:36Z

XML import of API documentation

JonnyW at 17:23, 4 August 2013

2013-08-04T17:23:22Z

JonnyW: XML import of updated API docs

2013-06-17T09:57:58Z

XML import of updated API docs

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:09:15Z

XML Import to change Variable types into Variable Types

JonnyW: XML import API changes

2013-05-14T13:15:06Z

XML import API changes

Admin: XML import

2013-05-12T21:53:01Z

XML import

Admin: XML import

2013-05-12T21:28:46Z

XML import

← Older revision		Revision as of 11:55, 16 January 2023
Line 51:		Line 51:
	* Declare a variable 'result' of type BOOL		* 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>		* 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 examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Loads a wave file into memory, providing the values needed to play it
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LoadWav'''
-====Class hierarchy====
+|-
-[[API Sound|Sound]]
+| colspan="2" | Loads a wave file into memory, providing the values needed to play it&nbsp;
-:[[API Sound|LoadWav]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Filename
-==Parameters==
+|-
-[[Variable Types|STRING]] ''Filename''
+| colspan="2" | The formatted file to load into memory&nbsp;
-:The formatted file to load into memory
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE[]
-[[Variable Types|BYTE[]]] ''Buffer''
+| width="90%" | Buffer
-:A buffer to write the wave data to
+|-
+| colspan="2" | A buffer to write the wave data to&nbsp;
-[[Variable Types|UINT]] ''SampleFormat''
+|-
-:Variable to receive the format of the samples
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-:''This parameter is returned back to the caller''
+| width="90%" | SampleFormat
+|-
-[[Variable Types|ULONG]] ''Elements''
+| colspan="2" | Variable to receive the format of the samples&nbsp;
-:Variable to receive the number of sample elements to play
+|-
-:''This parameter is returned back to the caller''
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Elements
-[[Variable Types|FLOAT]] ''SampleRate''
+|-
-:Variable to receive the wave source sample rate
+| colspan="2" | Variable to receive the number of sample elements to play&nbsp;
-:''This parameter is returned back to the caller''
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | SampleRate
-==Return value==
+|-
-[[Variable Types|BOOL]]
+| colspan="2" | Variable to receive the wave source sample rate&nbsp;
+|-
-Returns true if the operation is a success, else false
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<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

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<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

← Older revision		Revision as of 17:23, 4 August 2013
Line 38:		Line 38:

	==Detailed description==		==Detailed description==
−	''~~<span style="color~~:~~red;">No additional information<~~/~~span>~~''	+	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 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Loads a wave file into memory, providing the values needed to play it
@@ Line 44: / Line 46: @@
 * 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>''
+''<span style="color:red;">No additional examples</span>''