Difference between revisions of "API Sound.Queue"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 32: Line 32:
 
[[Variable types|BOOL]]
 
[[Variable types|BOOL]]
  
''<span style="color:red;">No additional information</span>''
+
Returns true if the operation is a success, else false
  
  

Revision as of 21:28, 12 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

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

No additional information