output/Interface: clarify Play() API documentation

This commit is contained in:
Max Kellermann 2018-01-05 08:35:40 +01:00
parent e3ef3e8d71
commit 79b0f97a3f
1 changed files with 4 additions and 2 deletions

View File

@ -125,11 +125,13 @@ public:
virtual void SendTag(const Tag &) {}
/**
* Play a chunk of audio data.
* Play a chunk of audio data. The method blocks until at
* least one audio frame is consumed.
*
* Throws #std::runtime_error on error.
*
* @return the number of bytes played
* @return the number of bytes played (must be a multiple of
* the frame size)
*/
virtual size_t Play(const void *chunk, size_t size) = 0;