API Sound.Queue

From Flowcode Help
Revision as of 21:17, 11 May 2013 by Admin (talk | contribs) (XML import)
Jump to navigationJump to search

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

===Class hierarchy===API

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)