See Also
You are here: Player Plug-ins > Definitions > Playback Plug-ins > QCDModInitPlay2 > QCDModInitPlay2::toModule > Drain
QMP Developer Reference Guide
ContentsIndexHome
PreviousUpNext
Drain

The player calls this function to wait for all written data to be rendered.

Parameters
Parameters 
Description 
flags 
[in] no flags currently defined 
Return Values
Return Values 
Description 
drain failed, or drain canceled 
drain completed 
Remarks

Once called, the implementing module should not return from this function until it has rendered (played) all audio data. Input modules call this function so they can know when all the data passed to Write has been rendered. Normally Input modules call this at the end of the audio data stream, just prior to calling Stop.

See Also
Copyright (c) Quinnware 2007. All rights reserved.