API Sound.GetPending

From Flowcode Help
Jump to navigationJump to search

<sidebar>API Contents</sidebar> Gets the number of sample blocks queued or playing for the sound

Class hierarchy

Sound

GetPending

Parameters

HANDLE Sounds

The handle of the sound object to read


Return value

ULONG

Returns the number of sample blocks queued or playing for the sound


Detailed description

The number of pending sounds includes those currently playing. This call can be used to sequence smooth sound where a certain number of samples need to be continuously queued to achieve a smooth effect.


Examples

Calling in a calculation

  • Declare a variable 'result' of type ULONG
  • Add to a calculation icon:
    result = ::Sound.GetPending(sounds)

No additional examples