Difference between revisions of "API Sound.QueueEx"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
(XML import of updated API docs) |
||
| Line 1: | Line 1: | ||
| + | |||
| + | |||
<sidebar>API contents</sidebar> | <sidebar>API contents</sidebar> | ||
Queues a sound for playing, with the format provided | Queues a sound for playing, with the format provided | ||
| Line 81: | Line 83: | ||
* 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 | + | ''<span style="color:red;">No additional examples</span>'' |
Revision as of 09:57, 17 June 2013
<sidebar>API contents</sidebar>
Queues a sound for playing, with the format provided
Contents
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:
Name Description Fmt_Signed8 Source data is in the range -128 to 127 Fmt_Unsigned8 Source data is in the range 0 to 255 Fmt_Signed16 Source data is in the range -32768 to 32767 Fmt_Unsigned16 Source data is in the range 0 to 65535 Fmt_Signed32 Source data is a signed 32-bit value Fmt_Unsigned32 Source data is an unsigned 32-bit value Fmt_Float32 Source data is a 32-bit float from 0 to 1 Fmt_Float64 Source data is a 64-bit float from 0 to 1 Fmt_Mono Set this flag to set a single source element per sample Fmt_Stereo Set this flag to two source elements per sample
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
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.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, elements, ratemul)
No additional examples
