Difference between revisions of "API Sound.Queue"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
(XML Import to change Variable types into Variable Types) |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''Sounds'' |
:The handle of the sound object to queue to | :The handle of the sound object to queue to | ||
| − | [[Variable | + | [[Variable Types|ARRAY]] ''Data'' |
:The array to play data from | :The array to play data from | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''Offset'' |
:The element in the array to start at | :The element in the array to start at | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''Elements'' |
:The number of elements to play | :The number of elements to play | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
| − | [[Variable | + | [[Variable Types|FLOAT]] ''RateMul'' |
:A multiplier to the sounds sample rate | :A multiplier to the sounds sample rate | ||
:''The default value for this parameter is: '''''1''' | :''The default value for this parameter is: '''''1''' | ||
| Line 30: | Line 30: | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[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 11:09, 10 June 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
