code.delx.au - pulseaudio/blob - src/pulse/pulseaudio.h

   1 #ifndef foopulseaudiohfoo
   2 #define foopulseaudiohfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   9
  10   PulseAudio is free software; you can redistribute it and/or modify
  11   it under the terms of the GNU Lesser General Public License as
  12   published by the Free Software Foundation; either version 2.1 of the
  13   License, or (at your option) any later version.
  14
  15   PulseAudio is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public
  21   License along with PulseAudio; if not, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 ***/
  25
  26 #include <pulse/mainloop-api.h>
  27 #include <pulse/sample.h>
  28 #include <pulse/def.h>
  29 #include <pulse/context.h>
  30 #include <pulse/stream.h>
  31 #include <pulse/introspect.h>
  32 #include <pulse/subscribe.h>
  33 #include <pulse/scache.h>
  34 #include <pulse/version.h>
  35 #include <pulse/error.h>
  36 #include <pulse/operation.h>
  37 #include <pulse/channelmap.h>
  38 #include <pulse/volume.h>
  39 #include <pulse/xmalloc.h>
  40 #include <pulse/utf8.h>
  41 #include <pulse/thread-mainloop.h>
  42 #include <pulse/mainloop.h>
  43 #include <pulse/mainloop-signal.h>
  44 #include <pulse/util.h>
  45 #include <pulse/timeval.h>
  46 #include <pulse/proplist.h>
  47
  48 /** \file
  49  * Include all libpulse header files at once. The following
  50  * files are included: \ref mainloop-api.h, \ref sample.h, \ref def.h,
  51  * \ref context.h, \ref stream.h, \ref introspect.h, \ref subscribe.h,
  52  * \ref scache.h, \ref version.h, \ref error.h, \ref channelmap.h,
  53  * \ref operation.h,\ref volume.h, \ref xmalloc.h, \ref utf8.h, \ref
  54  * thread-mainloop.h, \ref mainloop.h, \ref util.h, \ref proplist.h, \ref timeval.h and
  55  * \ref mainloop-signal.h at once */
  56
  57 /** \mainpage
  58  *
  59  * \section intro_sec Introduction
  60  *
  61  * This document describes the client API for the PulseAudio sound
  62  * server. The API comes in two flavours to accomodate different styles
  63  * of applications and different needs in complexity:
  64  *
  65  * \li The complete but somewhat complicated to use asynchronous API
  66  * \li The simplified, easy to use, but limited synchronous API
  67  *
  68  * All strings in PulseAudio are in the UTF-8 encoding, regardless of current
  69  * locale. Some functions will filter invalid sequences from the string, some
  70  * will simply fail. To ensure reliable behaviour, make sure everything you
  71  * pass to the API is already in UTF-8.
  72
  73  * \section simple_sec Simple API
  74  *
  75  * Use this if you develop your program in synchronous style and just
  76  * need a way to play or record data on the sound server. See
  77  * \subpage simple for more details.
  78  *
  79  * \section async_sec Asynchronous API
  80  *
  81  * Use this if you develop your programs in asynchronous, event loop
  82  * based style or if you want to use the advanced features of the
  83  * PulseAudio API. A guide can be found in \subpage async.
  84  *
  85  * By using the built-in threaded main loop, it is possible to acheive a
  86  * pseudo-synchronous API, which can be useful in synchronous applications
  87  * where the simple API is insufficient. See the \ref async page for
  88  * details.
  89  *
  90  * \section thread_sec Threads
  91  *
  92  * The PulseAudio client libraries are not designed to be directly
  93  * thread-safe. They are however designed to be reentrant and
  94  * threads-aware.
  95  *
  96  * To use the libraries in a threaded environment, you must assure that
  97  * all objects are only used in one thread at a time. Normally, this means
  98  * that all objects belonging to a single context must be accessed from the
  99  * same thread.
 100  *
 101  * The included main loop implementation is also not thread safe. Take care
 102  * to make sure event objects are not manipulated when any other code is
 103  * using the main loop.
 104  *
 105  * \section pkgconfig pkg-config
 106  *
 107  * The PulseAudio libraries provide pkg-config snippets for the different
 108  * modules:
 109  *
 110  * \li libpulse - The asynchronous API and the internal main loop implementation.
 111  * \li libpulse-mainloop-glib - GLIB 2.x main loop bindings.
 112  * \li libpulse-simple - The simple PulseAudio API.
 113  */
 114
 115 #endif