Jump to content

API Sound.QueueEx: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import API auto-gen
Admin (talk | contribs)
XML import API auto-gen
Line 1: Line 1:
API contents
<sidebar>API contents</sidebar>
Queues a sound for playing, with the format provided
Queues a sound for playing, with the format provided



Revision as of 15:34, 10 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

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)