mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-12-20 08:56:47 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documentation work

Browse source 
add pkg-config support for GLIB main loop


git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@133 fefdeb5f-60dc-0310-8127-8f9354f1896f
This commit is contained in:
Lennart Poettering 2004-08-17 17:17:22 +00:00
parent f693aa4c88
commit ca2265f372
36 changed files with 326 additions and 151 deletions
Download patch file Download diff file Expand all files Collapse all files

50
polyp/polyplib.h
View file

@ -31,4 +31,54 @@
#include "polyplib-subscribe.h"
#include "polyplib-scache.h"
/** \file
* Include all polyplib header file at once. The following files are included: \ref mainloop-api.h, \ref sample.h,
* \ref polyplib-def.h, \ref polyplib-context.h, \ref polyplib-stream.h,
* \ref polyplib-introspect.h, \ref polyplib-subscribe.h and \ref polyplib-scache.h
* at once */
/** \mainpage
*
* \section intro_sec Introduction
*
* This document describes the client API for the polypaudio sound
* server. The API comes in two flavours:
*
* \li The complete but somewhat complicated to use asynchronous API
* \li And the simplified, easy to use, but limited synchronous API
*
* The polypaudio client libraries are thread safe as long as all
* objects created by any library function are accessed from the thread
* that created them only.
*
* \section simple_sec Simple API
*
* Use this if you develop your program in synchronous style and just
* need a way to play or record data on the sound server. See
* \ref polyplib-simple.h for more details.
*
* \section async_api Asynchronous API
*
* Use this if you develop your programs in asynchronous, main loop
* based style or want to use advanced features of the polypaudio
* API. A good starting point is \ref polyplib-context.h
*
* The asynchronous API relies on an abstract main loop API that is
* described in \ref mainloop-api.h. Two distinct implementations are
* available:
*
* \li \ref mainloop.h: a minimal but fast implementation based on poll()
* \li \ref glib-mainloop.h: a wrapper around GLIB's main loop
*
* UNIX signals may be hooked to a main loop using the functions from
* \ref mainloop-signal.h
*
* \section pkgconfig pkg-config
*
* The polypaudio libraries provide pkg-config snippets for the different modules. To use the
* asynchronous API use "polyplib" as pkg-config file. GLIB main loop
* support is available as "polyplib-glib-mainloop". The simple
* synchronous API is available as "polyplib-simple".
*/
#endif