From 79b0f97a3fb064b2849b4c6870444a66b1e6e886 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@musicpd.org>
Date: Fri, 5 Jan 2018 08:35:40 +0100
Subject: [PATCH] output/Interface: clarify Play() API documentation

---
 src/output/Interface.hxx | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/output/Interface.hxx b/src/output/Interface.hxx
index 86123dc7c..711c04b6c 100644
--- a/src/output/Interface.hxx
+++ b/src/output/Interface.hxx
@@ -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;