_delay in output plugin will now ask the thread to repeatedly wait until it returns 0.

change the _delay API doc so that it matches its implementation behavior.
This commit is contained in:
Yue Wang 2016-09-19 09:53:40 -07:00 committed by Wang-Yue
parent d73267df5e
commit d0302d1bbe

View File

@ -93,10 +93,11 @@ struct AudioOutputPlugin {
void (*close)(AudioOutput *data);
/**
* Returns a positive number if the output thread shall delay
* the next call to play() or pause(). This should be
* implemented instead of doing a sleep inside the plugin,
* because this allows MPD to listen to commands meanwhile.
* Returns a positive number if the output thread shall further
* delay the next call to play() or pause(), which will happen
* until this function returns 0. This should be implemented
* instead of doing a sleep inside the plugin, because this
* allows MPD to listen to commands meanwhile.
*
* @return the number of milliseconds to wait
*/