mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-11-10 13:29:58 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

stream: Document pa_stream_write() size and offset requirements

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

Signed-off-by: Ahmed S. Darwish <darwish.07@gmail.com>
This commit is contained in:
Ahmed S. Darwish 2016-03-14 00:02:09 +02:00 • committed by Tanu Kaskinen
parent 09f11ee482
commit a1713476d5
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/pulse/stream.h
View file

@ -547,9 +547,9 @@ int pa_stream_cancel_write(
int pa_stream_write( int pa_stream_write(
pa_stream *p /**< The stream to use */, pa_stream *p /**< The stream to use */,
const void *data /**< The data to write */, 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 */, 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 */); 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 /** Function does exactly the same as pa_stream_write() with the difference