Difference between revisions of "API Sound.Queue"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import API changes) |
||
| Line 31: | Line 31: | ||
==Return value== | ==Return value== | ||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
| + | |||
Returns true if the operation is a success, else false | Returns true if the operation is a success, else false | ||
Revision as of 13:15, 14 May 2013
<sidebar>API contents</sidebar> Queues a sound for playing
Contents
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
Returns true if the operation is a success, else false
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)
No additional information
