Difference between revisions of "API Sound.Queue"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import API auto-gen) |
||
| Line 1: | Line 1: | ||
wiki page name | wiki page name | ||
| − | + | Queues a sound for playing | |
| − | |||
| − | |||
===Parameters=== | ===Parameters=== | ||
| Line 33: | Line 31: | ||
===Examples=== | ===Examples=== | ||
| − | ====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: result = ::Sound.Queue(sounds, _arraydata, offset, elements, ratemul) | ||
Revision as of 15:34, 10 May 2013
wiki page name 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)
