mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-11-03 09:01:50 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doxygen: Documentation improvements

Browse source 
stream.h, simple.h
The words drain and flush are a little ambiguous, make it explicit as
to what happens to any existing audio.

*mainloop.h
reword *_free and *_get_api for grammar
This commit is contained in:
David Fries 2010-10-12 20:05:47 -05:00 • committed by Colin Guthrie
parent 9295e4a0dc
commit 2da3c47838
5 changed files with 16 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

15
src/pulse/stream.h
View file

@ -529,9 +529,10 @@ size_t pa_stream_writable_size(pa_stream *p);
/** Return the number of bytes that may be read using pa_stream_peek()*/
size_t pa_stream_readable_size(pa_stream *p);
/** Drain a playback stream. Use this for notification when the buffer
* is empty. Please note that only one drain operation per stream may
* be issued at a time. */
/** Drain a playback stream. Use this for notification when the
* playback buffer is empty after playing all the audio in the buffer.
* Please note that only one drain operation per stream may be issued
* at a time. */
pa_operation* pa_stream_drain(pa_stream *s, pa_stream_success_cb_t cb, void *userdata);
/** Request a timing info structure update for a stream. Use
@ -609,10 +610,10 @@ void pa_stream_set_buffer_attr_callback(pa_stream *p, pa_stream_notify_cb_t cb,
* of the stream it will be created in corked state. */
pa_operation* pa_stream_cork(pa_stream *s, int b, pa_stream_success_cb_t cb, void *userdata);
/** Flush the playback buffer of this stream. Most of the time you're
* better off using the parameter delta of pa_stream_write() instead
* of this function. Available on both playback and recording
* streams. */
/** Flush the playback buffer of this stream. This discards any audio
* in the buffer. Most of the time you're better off using the parameter
* delta of pa_stream_write() instead of this function. Available on both
* playback and recording streams. */
pa_operation* pa_stream_flush(pa_stream *s, pa_stream_success_cb_t cb, void *userdata);
/** Reenable prebuffering as specified in the pa_buffer_attr