API Sound.QueueEx - Revision history

Wiki bot at 11:55, 16 January 2023

2023-01-16T11:55:09Z

2023-01-16T11:41:41Z

2014-01-16T15:57:59Z

XML import

2013-08-09T14:27:37Z

XML import of API documentation

2013-08-07T21:29:17Z

2013-06-17T09:57:57Z

XML import of updated API docs

2013-06-10T11:09:15Z

XML Import to change Variable types into Variable Types

2013-05-14T13:15:18Z

XML import API changes

2013-05-12T21:53:13Z

XML import

2013-05-12T21:28:58Z

XML import

← Older revision		Revision as of 11:55, 16 January 2023
Line 61:		Line 61:
	* 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.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, elements, ratemul)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, elements, ratemul)</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;"
 |-
-! width="30%" |Name
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-! width="55%" |Description
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''QueueEx'''
 |-
-|Fmt_Signed8
+| colspan="2" | Queues a sound for playing, with the format provided&nbsp;
 |-
 |-
-|Fmt_Signed16
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-|Source data is in the range -32768 to 32767
+| width="90%" | Sounds
 |-
-|Fmt_Unsigned16
+| colspan="2" | The handle of the sound object to queue to&nbsp;
 |-
-|Fmt_Signed32
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE[]
-|Source data is a signed 32-bit value
+| width="90%" | Data
 |-
-|Fmt_Unsigned32
+| colspan="2" | The array to play data from&nbsp;
 |-
-|Fmt_Float32
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-|Source data is a 32-bit float from 0 to 1
+| width="90%" | ByteOffset
 |-
-|Fmt_Float64
+| colspan="2" | The byte-offset in the array to start at&nbsp;
 |-
-|Fmt_Mono
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-|Set this flag to set a single source element per sample
+| width="90%" | SampleFormat
 |-
-|Fmt_Stereo
+| colspan="2" | Format of the samples&nbsp;
-|Set this flag to two source elements per sample
+|-
 |}

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Queues a sound for playing, with the format provided		Queues a sound for playing, with the format provided

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


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Queues a sound for playing, with the format provided		Queues a sound for playing, with the format provided

← Older revision		Revision as of 21:29, 7 August 2013
Line 75:		Line 75:

	==Detailed description==		==Detailed description==
−	''~~<span style="color:red;">No additional information</span>~~''	+	This adds a sound to the queue to be played when the currently playing sound completes. If no sound is currently playing this will play immediately.
		+
		+
		+	The ''Elements'' is a maximum, and will be bounded to the size of the input ''Array'' if too large. This means passing -1 (unsigned) is the equivalent of 'the full array'. The relevant contents of the ''Array'' are copied so the contents may be altered immediately after this call.
		+
		+	The format of each sample in ''Array'' is explicitly declared, so the data may be read from a file and its format decided dynamically.
		+
		+	Floating point samples are assumed to be in the range 0 to 1. All integer values have their sign and bit size considered and are in a range from the minimum to the maximum of their type.
		+
		+
		+	''RateMul'' can be used to adjust the sample rate for the sound in software. Linear interpolation is used to scale the input ''Array'' by this factor. This means to play at half the sample rate (so the sound plays twice as slow) set ''RateMul''=0.5.
		+

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Queues a sound for playing, with the format provided
@@ Line 81: / Line 83: @@
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, elements, ratemul)</pre>
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''

@@ Line 10: / Line 10: @@
 ==Parameters==
-[[Variable types|HANDLE]] ''Sounds''
+[[Variable Types|HANDLE]] ''Sounds''
 :The handle of the sound object to queue to
-[[Variable types|BYTE[]]] ''Data''
+[[Variable Types|BYTE[]]] ''Data''
 :The array to play data from
-[[Variable types|ULONG]] ''ByteOffset''
+[[Variable Types|ULONG]] ''ByteOffset''
 :The byte-offset in the array to start at
-[[Variable types|UINT]] ''SampleFormat''
+[[Variable Types|UINT]] ''SampleFormat''
 :Format of the samples
 :''Typical values for this parameter:''
@@ Line 58: / Line 58: @@
 |}
-[[Variable types|ULONG]] ''Elements''
+[[Variable Types|ULONG]] ''Elements''
 :The number of sample elements to play
-[[Variable types|FLOAT]] ''RateMul''
+[[Variable Types|FLOAT]] ''RateMul''
 :A multiplier to the sounds sample rate
 :''The default value for this parameter is: '''''1'''
@@ Line 67: / Line 67: @@
 ==Return value==
-[[Variable types|BOOL]]
+[[Variable Types|BOOL]]
 Returns true if the operation is a success, else false