Commit 79b0f97a authored by Max Kellermann's avatar Max Kellermann

output/Interface: clarify Play() API documentation

parent e3ef3e8d
...@@ -125,11 +125,13 @@ public: ...@@ -125,11 +125,13 @@ public:
virtual void SendTag(const Tag &) {} 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. * 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; virtual size_t Play(const void *chunk, size_t size) = 0;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment