Difference between revisions of "API Sound.QueueEx"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import API auto-gen)
Line 1: Line 1:
 
wiki page name
 
wiki page name
==SoundQueueEx==
+
Queues a sound for playing, with the format provided
  
Queues a sound for playing, with the format provided
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 46: Line 44:
  
 
===Examples===
 
===Examples===
====Calling in a calculation:====
+
====Calling in a calculation====
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: result = ::Sound.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, elements, ratemul)
 
* Add to a calculation icon: result = ::Sound.QueueEx(sounds, _arraydata, byteoffset, ::Sound.Fmt_Signed8, elements, ratemul)

Revision as of 15:34, 10 May 2013

wiki page name 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)