OutputDrain

The plug-in can call this function to know when all data written to OutputWrite has been rendered by the output plug-in.

Parameters

Parameters	Description
flags	[in] no flags currently defined

Return Values

Return Values	Description
0	draining of output failed or did not complete (was cancelled)
1	draining of output completed

Remarks

This is a blocking call. The call will only return once the output plug-in has completed the drain. For playback plug-ins this function will return after all written data has been played.

On completion of decoding the audio, the plug-in must call this function before calling PlayDone. This ensures that the player will progress to the next track after the current track truly completes.