polyp/polyplib.h

   1 #ifndef foopolyplibhfoo
   2 #define foopolyplibhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of polypaudio.
   8
   9   polypaudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published
  11   by the Free Software Foundation; either version 2 of the License,
  12   or (at your option) any later version.
  13
  14   polypaudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU General Public License
  20   along with polypaudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #include "mainloop-api.h"
  26 #include "sample.h"
  27 #include "polyplib-def.h"
  28 #include "polyplib-context.h"
  29 #include "polyplib-stream.h"
  30 #include "polyplib-introspect.h"
  31 #include "polyplib-subscribe.h"
  32 #include "polyplib-scache.h"
  33
  34 /** \file
  35  * Include all polyplib header file at once. The following files are included: \ref mainloop-api.h, \ref sample.h,
  36  * \ref polyplib-def.h, \ref polyplib-context.h, \ref polyplib-stream.h,
  37  * \ref polyplib-introspect.h, \ref polyplib-subscribe.h and \ref polyplib-scache.h
  38  * at once */
  39
  40 /** \mainpage
  41  *
  42  * \section intro_sec Introduction
  43  *
  44  * This document describes the client API for the polypaudio sound
  45  * server. The API comes in two flavours:
  46  *
  47  * \li The complete but somewhat complicated to use asynchronous API
  48  * \li And the simplified, easy to use, but limited synchronous API
  49  *
  50  * The polypaudio client libraries are thread safe as long as all
  51  * objects created by any library function are accessed from the thread
  52  * that created them only.
  53  *
  54  * \section simple_sec Simple API
  55  *
  56  * Use this if you develop your program in synchronous style and just
  57  * need a way to play or record data on the sound server. See
  58  * \ref polyplib-simple.h for more details.
  59  *
  60  * \section async_api Asynchronous API
  61  *
  62  * Use this if you develop your programs in asynchronous, main loop
  63  * based style or want to use advanced features of the polypaudio
  64  * API. A good starting point is \ref polyplib-context.h
  65  *
  66  * The asynchronous API relies on an abstract main loop API that is
  67  * described in \ref mainloop-api.h. Two distinct implementations are
  68  * available:
  69  *
  70  * \li \ref mainloop.h: a minimal but fast implementation based on poll()
  71  * \li \ref glib-mainloop.h: a wrapper around GLIB's main loop
  72  *
  73  * UNIX signals may be hooked to a main loop using the functions from
  74  * \ref mainloop-signal.h
  75  *
  76  * \section pkgconfig pkg-config
  77  *
  78  * The polypaudio libraries provide pkg-config snippets for the different modules. To use the
  79  * asynchronous API use "polyplib" as pkg-config file. GLIB main loop
  80  * support is available as "polyplib-glib-mainloop". The simple
  81  * synchronous API is available as "polyplib-simple".
  82  */
  83
  84 #endif