ssplIsSpoolerActive

Test if spooler has anything in its active queue.

Synopsis

bool ssplIsSpoolerActive (const SoundSpooler *sspl)

Description

Returns TRUE if the SoundSpooler has any SoundBufferNodes in its active queue. Simply calls ssplGetSpoolerStatus() and tests the SSPL_STATUS_F_ACTIVE flag.

Arguments

sspl: Pointer to a SoundSpooler structure.

Return Value

TRUE if SoundSpooler has any SoundBufferNodes in its active queue, FALSE otherwise.

Caveats

This state of SSPL_STATUS_F_ACTIVE is undefined when inside any SoundSpooler callback function. This is the case because the callback functions can be called inside the loop that processes the active queue. No guarantee is made about whether a SoundBufferNode is removed from the active queue before or after the callback functions are called.

Implementation

Macro implemented in soundspooler.h V24.

Associated Files

soundspooler.h, music.lib