Difference between revisions of "API Sound.QueueEx"
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|BYTE[]]] ''Data'' |
:The array to play data from | :The array to play data from | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''ByteOffset'' |
:The byte-offset in the array to start at | :The byte-offset in the array to start at | ||
| − | [[Variable | + | [[Variable Types|UINT]] ''SampleFormat'' |
:Format of the samples | :Format of the samples | ||
:''Typical values for this parameter:'' | :''Typical values for this parameter:'' | ||
| Line 58: | Line 58: | ||
|} | |} | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''Elements'' |
:The number of sample elements to play | :The number of sample elements to play | ||
| − | [[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 67: | Line 67: | ||
==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, 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 information
