Difference between revisions of "API Sound.Queue"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Queues a sound for playing | Queues a sound for playing | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Sound | ||
| + | ::Queue | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|HANDLE]] Sounds'' | ''[[Variable types|HANDLE]] Sounds'' | ||
:The handle of the sound object to queue to | :The handle of the sound object to queue to | ||
| Line 22: | Line 28: | ||
:''The default value for this parameter is: '''''1''' | :''The default value for this parameter is: '''''1''' | ||
| − | + | ==Return value== | |
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
No additional information | No additional information | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Queue(sounds, _arraydata, offset, elements, ratemul)</pre> |
Revision as of 16:49, 11 May 2013
<sidebar>API contents</sidebar> Queues a sound for playing
Class hierarchy
- Sound
- Queue
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
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)
