API Sound.QueueEx: Difference between revisions
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|QueueEx]] | :[[API Sound|QueueEx]] | ||
</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|BYTE[]]] ''Data'' | |||
:The array to play data from | :The array to play data from | ||
[[Variable types|ULONG]] ''ByteOffset'' | |||
:The byte-offset in the array to start at | :The byte-offset in the array to start at | ||
[[Variable types|UINT]] ''SampleFormat'' | |||
:Format of the samples | :Format of the samples | ||
''Typical values for this parameter:'' | ''Typical values for this parameter:'' | ||
| Line 33: | Line 34: | ||
|} | |} | ||
[[Variable types|ULONG]] ''Elements'' | |||
:The number of sample elements to play | :The number of sample elements to play | ||
[[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 43: | Line 44: | ||
[[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 52: | Line 56: | ||
* 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.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, elements, ratemul)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, 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, with the format provided
Parameters
HANDLE Sounds
- The handle of the sound object to queue to
BYTE[] Data
- The array to play data from
ULONG ByteOffset
- The byte-offset in the array to start at
UINT SampleFormat
- Format of the samples
Typical values for this parameter:
ULONG Elements
- The number of sample elements to play
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.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, elements, ratemul)
No additional information