code.delx.au - pulseaudio/blob - src/polyp/polypaudio.h

   1 #ifndef foopolypaudiohfoo
   2 #define foopolypaudiohfoo
   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 Lesser General Public License as
  11   published by the Free Software Foundation; either version 2.1 of the
  12   License, 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   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public
  20   License 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 <polyp/mainloop-api.h>
  26 #include <polyp/sample.h>
  27 #include <polyp/def.h>
  28 #include <polyp/context.h>
  29 #include <polyp/stream.h>
  30 #include <polyp/introspect.h>
  31 #include <polyp/subscribe.h>
  32 #include <polyp/scache.h>
  33 #include <polyp/version.h>
  34 #include <polyp/error.h>
  35 #include <polyp/operation.h>
  36 #include <polyp/channelmap.h>
  37 #include <polyp/volume.h>
  38 #include <polyp/xmalloc.h>
  39 #include <polyp/utf8.h>
  40 #include <polyp/thread-mainloop.h>
  41 #include <polyp/mainloop.h>
  42 #include <polyp/mainloop-signal.h>
  43
  44 /** \file
  45  * Include all polyplib header files at once. The following
  46  * files are included: \ref mainloop-api.h, \ref sample.h, \ref def.h,
  47  * \ref context.h, \ref stream.h, \ref introspect.h, \ref subscribe.h,
  48  * \ref scache.h, \ref version.h, \ref error.h, \ref channelmap.h,
  49  * \ref operation.h,\ref volume.h, \ref xmalloc.h, \ref utf8.h, \ref
  50  * thread-mainloop.h, \ref mainloop.h and \ref mainloop-signal.h at once */
  51
  52 /** \mainpage
  53  *
  54  * \section intro_sec Introduction
  55  *
  56  * This document describes the client API for the polypaudio sound
  57  * server. The API comes in two flavours to accomodate different styles
  58  * of applications and different needs in complexity:
  59  *
  60  * \li The complete but somewhat complicated to use asynchronous API
  61  * \li The simplified, easy to use, but limited synchronous API
  62  *
  63  * All strings in Polypaudio are in the UTF-8 encoding, regardless of current
  64  * locale. Some functions will filter invalid sequences from the string, some
  65  * will simply fail. To ensure reliable behaviour, make sure everything you
  66  * pass to the API is already in UTF-8.
  67
  68  * \section simple_sec Simple API
  69  *
  70  * Use this if you develop your program in synchronous style and just
  71  * need a way to play or record data on the sound server. See
  72  * \subpage simple for more details.
  73  *
  74  * \section async_sec Asynchronous API
  75  *
  76  * Use this if you develop your programs in asynchronous, event loop
  77  * based style or if you want to use the advanced features of the
  78  * polypaudio API. A guide can be found in \subpage async.
  79  *
  80  * By using the built-in threaded main loop, it is possible to acheive a
  81  * pseudo-synchronous API, which can be useful in synchronous applications
  82  * where the simple API is insufficient. See the \ref async page for
  83  * details.
  84  *
  85  * \section thread_sec Threads
  86  *
  87  * The polypaudio client libraries are not designed to be used in a
  88  * heavily threaded environment. They are however designed to be reentrant
  89  * safe.
  90  *
  91  * To use a the libraries in a threaded environment, you must assure that
  92  * all objects are only used in one thread at a time. Normally, this means
  93  * that all objects belonging to a single context must be accessed from the
  94  * same thread.
  95  *
  96  * The included main loop implementation is also not thread safe. Take care
  97  * to make sure event lists are not manipulated when any other code is
  98  * using the main loop.
  99  *
 100  * \section pkgconfig pkg-config
 101  *
 102  * The polypaudio libraries provide pkg-config snippets for the different
 103  * modules:
 104  *
 105  * \li polyplib - The asynchronous API and the internal main loop
 106  *                implementation.
 107  * \li polyplib-glib12-mainloop - GLIB 1.2 main loop bindings.
 108  * \li polyplib-glib-mainloop - GLIB 2.x main loop bindings.
 109  * \li polyplib-simple - The simple polypaudio API.
 110  */
 111
 112 #endif