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