ssplStopSpooler

Stop SoundSpooler.

Synopsis

Err ssplStopSpooler ( SoundSpooler *sspl )

Description

ssplStopSpooler() stops the SoundSpooler's sample player instrument. Unlike ssplPause(), this call does not retain the current sample data position. Starting the spooler after stopping it will start sound playback from the beginning of the first buffer in the active queue.

This function merely stops the SoundSpooler's sample player instrument. It does not disturb the active queue.

This function clears SSPL_STATUS_F_STARTED and SSPL_STATUS_F_PAUSED.

Argument

sspl: pointer to a SoundSpooler structure.

Return Value

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

Implementation

Library call implemented in music.lib V21.

Associated Files

soundspooler.h, music.lib