Difference between revisions of "API Sound.Queue"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API |API ]]
+
===Class hierarchy===[[API Sound|Sound]]
:[[API Sound|Sound]]
+
:[[API Sound|Queue]]
::Queue
 
 
</div>
 
</div>
 
__TOC__
 
__TOC__

Revision as of 21:23, 11 May 2013

<sidebar>API contents</sidebar> Queues a sound for playing

===Class hierarchy===Sound

Queue

Parameters

HANDLE Sounds

The handle of the sound object to queue to

ARRAY Data

The array to play data from

ULONG Offset

The element in the array to start at
The default value for this parameter is: 0

ULONG Elements

The number of elements to play
The default value for this parameter is: -1

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.Queue(sounds, _arraydata, offset, elements, ratemul)