API Sound.QueueEx: Difference between revisions

Revision as of 16:49, 11 May 2013

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

Sound

QueueEx

HANDLE Sounds

The handle of the sound object to queue to

BYTE[] Data

The array to play data from

ULONG ByteOffset

The byte-offset in the array to start at

UINT SampleFormat

Format of the samples

Typical values for this parameter:

ULONG Elements

The number of sample elements to play

FLOAT RateMul

A multiplier to the sounds sample rate

The default value for this parameter is: 1

No additional information

No additional information

Add to a calculation icon:

result = ::Sound.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, elements, ratemul)

@@ Line 2: / Line 2: @@
 Queues a sound for playing, with the format provided
+<div style="width:25%; float:right" class="toc">
+===Class hierarchy===
+:Sound
+::QueueEx
+</div>
+__TOC__
-===Parameters===
+==Parameters==
 ''[[Variable types|HANDLE]] Sounds''
 :The handle of the sound object to queue to
@@ Line 35: / Line 41: @@
 :''The default value for this parameter is: '''''1'''
-===Return value===
+==Return value==
 [[Variable types|BOOL]]
 No additional information
-===Detailed description===
+==Detailed description==
 ''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation====
+===Calling in a calculation===
 * Declare a variable 'result' of type BOOL
-* Add to a calculation icon: <pre class="brush:[C]">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>