# ssplPause

Pauses the SoundSpooler

### Synopsis

`Err ssplPause ( SoundSpooler *sspl )`

### Description

`ssplPause()` pauses SoundSpooler's sample player instrument. Stops playback and retains the sample data position so that playback can be resumed at the same position with `ssplResume()`. This differs from the `ssplStartSpooler()` `ssplStopSpooler()` pair which do not retain the current sample playback position.

The playback cannot be resumed from the paused location if `ssplStartSpooler()` or `ssplStopSpooler()` are called between `ssplPause()` and `ssplResume()`. Multiple calls to `ssplPause()` have no effect; pause does not nest.

Sets 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

### See Also

``ssplResume`(), ssplStopSpooler(), PauseInstrument(), ssplGetSpoolerStatus()`