ssplSpoolData
Send a block full of data. (convenience routine)
Synopsis
int32 ssplSpoolData ( SoundSpooler *sspl, char *Data, int32 NumBytes, void *UserData )
Description
ssplSpoolData() is a convenience function that does the following operations:
- Requests an available SoundBufferNode, returns 0 if none are available.
- Attaches sample data and optional user data pointer to the SoundBufferNode.
- Submits the SoundBufferNode to the active queue.
Arguments
- sspl
- Pointer to a SoundSpooler structure.
- Data
- Pointer to the buffer of data.
- NumBytes
- Number of bytes of data to send.
- UserData
- Pointer to user data, or NULL.
Return Value
Positive value on success indicating the signal to be sent when the buffer finishes playing, zero if no SoundBufferNodes are available, or negative 3DO error code for others kinds of failure.
Implementation
Convenience call implemented in music.lib V21.
Associated Files
soundspooler.h, music.lib
See Also
ssplPlayData(), ssplRequestBuffer(), ssplSendBuffer(), ssplSetBufferAddressLength(), ssplSetUserData()