Difference between revisions of "API Sound.Queue"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API Sound|Sound]] | + | ====Class hierarchy==== |
| + | [[API Sound|Sound]] | ||
:[[API Sound|Queue]] | :[[API Sound|Queue]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable types|HANDLE]] ''Sounds'' | |
:The handle of the sound object to queue to | :The handle of the sound object to queue to | ||
| − | + | [[Variable types|ARRAY]] ''Data'' | |
:The array to play data from | :The array to play data from | ||
| − | + | [[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 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 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 31: | ||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
| − | No additional information | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 39: | Line 43: | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Queue(sounds, _arraydata, offset, elements, ratemul)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Queue(sounds, _arraydata, offset, elements, ratemul)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 22:09, 11 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
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)
No additional information
