mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-11-05 13:29:57 -05:00
more documentation updates
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@697 fefdeb5f-60dc-0310-8127-8f9354f1896f
This commit is contained in:
parent
ceb09d8ae9
commit
20f4ae65f2
11 changed files with 106 additions and 63 deletions
|
|
@ -27,7 +27,7 @@
|
|||
|
||||
PA_C_DECL_BEGIN
|
||||
|
||||
/** \page mainloop Mainloop
|
||||
/** \page mainloop Main Loop
|
||||
*
|
||||
* \section overv_sec Overview
|
||||
*
|
||||
|
|
@ -81,15 +81,13 @@ void pa_mainloop_free(pa_mainloop* m);
|
|||
|
||||
/** Prepare for a single iteration of the main loop. Returns a negative value
|
||||
on error or exit request. timeout specifies a maximum timeout for the subsequent
|
||||
poll, or -1 for blocking behaviour. Defer events are also dispatched when this
|
||||
function is called. On success returns the number of source dispatched in this
|
||||
iteration.*/
|
||||
poll, or -1 for blocking behaviour. .*/
|
||||
int pa_mainloop_prepare(pa_mainloop *m, int timeout);
|
||||
|
||||
/** Execute the previously prepared poll. Returns a negative value on error.*/
|
||||
int pa_mainloop_poll(pa_mainloop *m);
|
||||
|
||||
/** Dispatch timeout and io events from the previously executed poll. Returns
|
||||
/** Dispatch timeout, io and deferred events from the previously executed poll. Returns
|
||||
a negative value on error. On success returns the number of source dispatched. */
|
||||
int pa_mainloop_dispatch(pa_mainloop *m);
|
||||
|
||||
|
|
@ -101,7 +99,7 @@ for pa_mainloop_prepare(), pa_mainloop_poll() and pa_mainloop_dispatch().
|
|||
Returns a negative value on error or exit request. If block is nonzero,
|
||||
block for events if none are queued. Optionally return the return value as
|
||||
specified with the main loop's quit() routine in the integer variable retval points
|
||||
to. On success returns the number of source dispatched in this iteration. */
|
||||
to. On success returns the number of sources dispatched in this iteration. */
|
||||
int pa_mainloop_iterate(pa_mainloop *m, int block, int *retval);
|
||||
|
||||
/** Run unlimited iterations of the main loop object until the main loop's quit() routine is called. */
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue