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