oysteikt
/
mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

OutputPlugin: update API documentation

This commit is contained in:
Max Kellermann 2016-10-28 21:09:22 +02:00
parent afcff1fa77
commit 69de99636f
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/output/OutputPlugin.hxx
View File

@ -64,9 +64,7 @@ struct AudioOutputPlugin {
/** /**
* Enable the device. This may allocate resources, preparing * Enable the device. This may allocate resources, preparing
* for the device to be opened. Enabling a device cannot * for the device to be opened.
* fail: if an error occurs during that, it should be reported
* by the open() method.
* *
* @return true on success, false on error * @return true on success, false on error
*/ */
@ -96,7 +94,7 @@ struct AudioOutputPlugin {
* Returns a positive number if the output thread shall further * Returns a positive number if the output thread shall further
* delay the next call to play() or pause(), which will happen * delay the next call to play() or pause(), which will happen
* until this function returns 0. This should be implemented * until this function returns 0. This should be implemented
* instead of doing a sleep inside the plugin, because this * instead of doing a sleep inside the plugin, because this
* allows MPD to listen to commands meanwhile. * allows MPD to listen to commands meanwhile.
* *
* @return the number of milliseconds to wait * @return the number of milliseconds to wait
@ -137,8 +135,8 @@ struct AudioOutputPlugin {
* disconnected. Plugins which do not support pausing will * disconnected. Plugins which do not support pausing will
* simply be closed, and have to be reopened when unpaused. * simply be closed, and have to be reopened when unpaused.
* *
* @return false on error (output will be closed then), true * @return false on error (output will be closed by caller),
* for continue to pause * true for continue to pause
*/ */
bool (*pause)(AudioOutput *data); bool (*pause)(AudioOutput *data);