ssplUnrequestBuffer

Return an unused buffer to the sound spooler.

Synopsis

Err ssplUnrequestBuffer (SoundSpooler *sspl, SoundBufferNode *sbn)

Description

ssplUnrequestBuffer() puts an unused SoundBufferNode from the requested queue back into the free queue. Use it as a way to politely give up write access to a SoundBufferNode that was given to you by ssplRequestBuffer() that you aren't going to submit to ssplSendBuffer(). For example, This can be used as part of a clean up path that traps failures between ssplRequestBuffer() and ssplSendBuffer().

This is automatically done for all SoundBufferNodes in the requested list by ssplReset(), ssplAbort(), and ssplDeleteSoundSpooler().

Argument

sspl: Pointer to a SoundSpooler structure.

sbn: Pointer to a SoundBufferNode to return. The SBN must actually be in the requested or else this function will return an error.

Return Value

Non-negative value on success, negative error code on failure:

ML_ERR_BAD_ARG: - the supplied sbn was not actually on the requested list.

Implementation

Library call implemented in music.lib V24.

Associated Files

soundspooler.h, music.lib