Difference between revisions of "API Sound.QueueEx"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 21: Line 21:
 
:Format of the samples
 
:Format of the samples
 
''Typical values for this parameter:''
 
''Typical values for this parameter:''
{| class="wikitable" |+width="20%"|Type|width="30%"|Name |width="40%"|Value|-LONG|Fmt_Signed8|4
+
{| class="wikitable" |-width="20%"|Type|width="30%"|Name |width="40%"|Value|-LONG|Fmt_Signed8|4
 
|-LONG|Fmt_Unsigned8|5
 
|-LONG|Fmt_Unsigned8|5
 
|-LONG|Fmt_Signed16|8
 
|-LONG|Fmt_Signed16|8

Revision as of 21:47, 11 May 2013

<sidebar>API contents</sidebar> Queues a sound for playing, with the format provided

===Class hierarchy===Sound

QueueEx

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

BOOL

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)