API Sound.Queue: Difference between revisions
XML import API auto-gen |
XML import of API auto-gen |
||
| Line 33: | Line 33: | ||
====Calling in a calculation==== | ====Calling in a calculation==== | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: result = ::Sound.Queue(sounds, _arraydata, offset, elements, ratemul) | * Add to a calculation icon: <pre class="brush:[C]">result = ::Sound.Queue(sounds, _arraydata, offset, elements, ratemul)</pre> | ||
Revision as of 15:35, 10 May 2013
<sidebar>API contents</sidebar> Queues a sound for playing
Parameters
HANDLE Sounds
- The handle of the sound object to queue to
ARRAY Data
- The array to play data from
ULONG Offset
- The element in the array to start at
- The default value for this parameter is: 0
ULONG Elements
- The number of elements to play
- The default value for this parameter is: -1
FLOAT RateMul
- A multiplier to the sounds sample rate
- The default value for this parameter is: 1
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Sound.Queue(sounds, _arraydata, offset, elements, ratemul)