ssplDeleteSoundSpooler

Delete a SoundSpooler.

Synopsis

Err ssplDeleteSoundSpooler ( SoundSpooler *sspl )

Description

ssplDeleteSoundSpooler() disposes of a SoundSpooler created by ssplCreateSoundSpooler() after first stopping it with ssplStopSpooler(). All SoundBufferNodes associated with the SoundSpooler are deleted.

Arguments

sspl: Pointer to a SoundSpooler structure. Starting with music.lib v22, can be NULL.

Return Value

Non-negative value on success, or negative 3DO error code on failure.

Implementation

Library call implemented in music.lib V21.

Caveats

Doesn't tolerate a NULL sspl pointer prior to music.lib v22.

Note

This function does no notification of SoundBufferNode removal from the active queue. If this is an issue, call ssplAbort() prior to calling this function.

Associated Files

soundspooler.h, music.lib