ssplStartSpoolerTags

Start SoundSpooler with tags.

Synopsis

Err ssplStartSpoolerTags ( SoundSpooler *sspl, const TagArg *samplertagsint32 )

Err ssplStartSpoolerTagsVA ( SoundSpooler *sspl,uint32 tag1, ... )

Description

ssplStartSpooler() starts the sound spooler's sample player instrument. It starts playback at the beginning of the first buffer in the active queue (submitted by ssplSendBuffer()). If there are no buffers in the active queue, playback will not begin until a buffer is submitted with a call to ssplSendBuffer().

If there is a SoundBufferFunc installed and there is a buffer in the active queue, sends a SSPL_SBMSG_INITIAL_START message with a pointer to the first active buffer. If SoundBufferFunc returns an error code, ssplStartSpooler() terminates and returns that error code.

This function sets SSPL_STATUS_F_STARTED and clears SSPL_STATUS_F_PAUSED.

Arguments

sspl: Pointer to a SoundSpooler structure.

samplertags: Tags to be passed to StartInstrument() for sample player instrument. Useful tags are AF_TAG_AMPLITUDE and AF_TAG_RATE. 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.

Associated Files

soundspooler.h, music.lib