ssplDetachInstrument

Detach the current sample player instrument from the SoundSpooler.

Synopsis

Err ssplDetachInstrument ( SoundSpooler *sspl )

Description

ssplDetachInstrument() removes the current sample player instrument from the SoundSpooler. Any buffers in the active queue are aborted (calls ssplAbort()). Spooler playback cannot be started until a new instrument is attached with ssplAttachInstrument(). Incidentally, ssplAttachInstrument() calls this function prior to attaching a new instrument, so it's pretty unlikely that you actually need to call this function directly.

Arguments

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.

Class

Low level

Note

Any buffers in the active queue are aborted by calling ssplAbort(). Note that there is no provision to supply a UserBufferProcessor function to ssplAttachInstrument(). An installed SoundBufferFunc works correctly, however.

Associated Files

soundspooler.h, music.lib