diff options
| author | Ahmed S. Darwish <darwish.07@gmail.com> | 2016-03-14 00:02:09 +0200 |
|---|---|---|
| committer | Tanu Kaskinen <tanuk@iki.fi> | 2016-04-25 16:59:21 +0300 |
| commit | a1713476d5caee51ae84cc78e8f1187e861f66d9 (patch) | |
| tree | 53e440c00d17c72555a5f655d014f860e6c26fcd | |
| parent | 09f11ee48279e28a73492ce5ccf7854808913f57 (diff) | |
| download | pulseaudio-a1713476d5caee51ae84cc78e8f1187e861f66d9.tar.gz | |
stream: Document pa_stream_write() size and offset requirements
Both must be in multiples of the stream's sample spec frame size.
Signed-off-by: Ahmed S. Darwish <darwish.07@gmail.com>
| -rw-r--r-- | src/pulse/stream.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/pulse/stream.h b/src/pulse/stream.h index ab233d570..5dfdee1a0 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 |