[pulseaudio-discuss] [PATCH 6/6] streams: Document pa_stream_write() size and offset requirements

[Ahmed S. Darwish]

Both must be in multiples of the stream's sample spec frame size.

Signed-off-by: Ahmed S. Darwish <darwish.07 at gmail.com>
---
 src/pulse/stream.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/pulse/stream.h b/src/pulse/stream.h
index ab233d5..5dfdee1 100644
--- a/src/pulse/stream.h
+++ b/src/pulse/stream.h
@@ -547,9 +547,9 @@ int pa_stream_cancel_write(
 int pa_stream_write(
         pa_stream *p             /**< The stream to use */,
         const void *data         /**< The data to write */,
-        size_t nbytes            /**< The length of the data to write in bytes */,
+        size_t nbytes            /**< The length of the data to write in bytes, must be in multiples of the stream's sample spec frame size */,
         pa_free_cb_t free_cb     /**< A cleanup routine for the data or NULL to request an internal copy */,
-        int64_t offset,          /**< Offset for seeking, must be 0 for upload streams */
+        int64_t offset           /**< Offset for seeking, must be 0 for upload streams, must be in multiples of the stream's sample spec frame size */,
         pa_seek_mode_t seek      /**< Seek mode, must be PA_SEEK_RELATIVE for upload streams */);
 
 /** Function does exactly the same as pa_stream_write() with the difference

Regards,

--
Darwish
http://darwish.chasingpointers.com