API Sound.Queue - Revision history

Wiki bot at 11:55, 16 January 2023

2023-01-16T11:55:09Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:41Z

JonnyW: XML import

2014-01-16T15:57:59Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:37Z

XML import of API documentation

JonnyW at 21:27, 7 August 2013

2013-08-07T21:27:19Z

JonnyW at 21:27, 7 August 2013

2013-08-07T21:27:09Z

JonnyW at 21:26, 7 August 2013

2013-08-07T21:26:05Z

JonnyW: XML import of updated API docs

2013-06-17T09:57:57Z

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:17Z

XML import API changes

← Older revision		Revision as of 11:55, 16 January 2023
Line 53:		Line 53:
	* 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.Queue(sounds, _arraydata, offset, elements, ratemul)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Queue(sounds, _arraydata, offset, 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;"
-Queues a sound for playing
+|-
+| 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;" | '''Queue'''
-====Class hierarchy====
+|-
-[[API Sound|Sound]]
+| colspan="2" | Queues a sound for playing&nbsp;
-:[[API Sound|Queue]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Sounds
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Sounds''
+| colspan="2" | The handle of the sound object to queue to&nbsp;
-:The handle of the sound object to queue to
+|-
+| width="10%" align="center" | [[File:Fc9-void-icon.png]] - ARRAY
-[[Variable Types|ARRAY]] ''Data''
+| width="90%" | Data
-:The array to play data from
+|-
+| colspan="2" | The array to play data from&nbsp;
-[[Variable Types|ULONG]] ''Offset''
+|-
-:The element in the array to start at
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-:''The default value for this parameter is: '''''0'''
+| width="90%" | Offset
+|-
-[[Variable Types|ULONG]] ''Elements''
+| colspan="2" | The element in the array to start at&nbsp;
-:The number of elements to play
+|-
-:''The default value for this parameter is: '''''-1'''
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Elements
-[[Variable Types|FLOAT]] ''RateMul''
+|-
-:A multiplier to the sounds sample rate
+| colspan="2" | The number of elements to play&nbsp;
-:''The default value for this parameter is: '''''1'''
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | RateMul
-==Return value==
+|-
-[[Variable Types|BOOL]]
+| colspan="2" | A multiplier to the sounds 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>
	Queues a sound for playing		Queues a sound for playing

← 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		Queues a sound for playing

← Older revision		Revision as of 21:27, 7 August 2013
Line 43:		Line 43:
	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 ''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'' depends on its data type. 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, so a signed 16 bit array has an expected range -32768 to 32767. To explicitly declare the data format use [[API Sound.QueueEx\|Sound.QueueEx]]	+	The format of each sample in ''Array'' depends on its data type. 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, so a signed 16 bit array has an expected range -32768 to 32767. To explicitly declare the data format use [[API Sound.QueueEx\|Sound.QueueEx]].

← Older revision		Revision as of 21:26, 7 August 2013
Line 38:		Line 38:

	==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'' depends on its data type. 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, so a signed 16 bit array has an expected range -32768 to 32767.
		+
		+
		+	''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
@@ Line 44: / Line 46: @@
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Queue(sounds, _arraydata, offset, elements, ratemul)</pre>
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''