blob: e9fec55d9d056d1a303945544bb7e42e7bf304b0 [file] [log] [blame]
 #ifndef foopulseaudiohfoo #define foopulseaudiohfoo /*** This file is part of PulseAudio. Copyright 2004-2006 Lennart Poettering Copyright 2006 Pierre Ossman for Cendio AB 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, see . ***/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include /** \file * Include all libpulse header files at once. The following files are * included: \ref direction.h, \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 proplist.h, * \ref timeval.h, \ref rtclock.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 accommodate 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 PulseAudio 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 achieve 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 directly * thread-safe. They are however designed to be reentrant and * threads-aware. * * To use 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 objects are not manipulated when any other code is * using the main loop. * * \section error_sec Error Handling * * Every function should explicitly document how errors are reported to * the caller. Unfortunately, currently a lot of that documentation is * missing. Here is an overview of the general conventions used. * * The PulseAudio API indicates error conditions by returning a negative * integer value or a NULL pointer. On success, zero or a positive integer * value or a valid pointer is returned. * * Functions of the \ref simple API generally return -1 or NULL on failure and * can optionally store an error code (see ::pa_error_code) using a pointer * argument. * * Functions of the \ref async API return an negative error code or NULL on * failure (see ::pa_error_code). In the later case, pa_context_errno() * can be used to obtain the error code of the last failed operation. * * An error code can be turned into a human readable message using * pa_strerror(). * * \section logging_sec Logging * * You can configure different logging parameters for the PulseAudio client * libraries. The following environment variables are recognized: * * - PULSE_LOG: Maximum log level required. Bigger values result in a * more verbose logging output. The following values are recognized: * + 0: Error messages * + 1: Warning messages * + 2: Notice messages * + 3: Info messages * + 4: Debug messages * - PULSE_LOG_SYSLOG: If defined, force all client libraries to log * their output using the syslog(3) mechanism. Default behavior is to * log all output to stderr. * - PULSE_LOG_JOURNAL: If defined, force all client libraries to log * their output using the systemd journal. If both PULSE_LOG_JOURNAL * and PULSE_LOG_SYSLOG are defined, logging to the systemd journal * takes a higher precedence. Each message originating library file name * and function are included by default through the journal fields * CODE_FILE, CODE_FUNC, and CODE_LINE. Any backtrace attached to * the logging message is sent through the PulseAudio-specific journal * field PULSE_BACKTRACE. This environment variable has no effect if * PulseAudio was compiled without systemd journal support. * - PULSE_LOG_COLORS: If defined, enables colored logging output. * - PULSE_LOG_TIME: If defined, include timestamps with each message. * - PULSE_LOG_FILE: If defined, include each message originating file * name. * - PULSE_LOG_META: If defined, include each message originating file * name and path relative to the PulseAudio source tree root. * - PULSE_LOG_LEVEL: If defined, include a log level prefix with each * message. Respectively, the prefixes "E", "W", "N", "I", "D" stands * for Error, Warning, Notice, Info, and Debugging. * - PULSE_LOG_BACKTRACE: Number of functions to display in the backtrace. * If this variable is not defined, or has a value of zero, no backtrace * is shown. * - PULSE_LOG_BACKTRACE_SKIP: Number of backtrace levels to skip, from * the function printing the log message downwards. * - PULSE_LOG_NO_RATE_LIMIT: If defined, do not rate limit the logging * output. Rate limiting skips certain log messages when their frequency * is considered too high. * * \section pkgconfig pkg-config * * The PulseAudio libraries provide pkg-config snippets for the different * modules: * * \li libpulse - The asynchronous API and the internal main loop implementation. * \li libpulse-mainloop-glib - GLIB 2.x main loop bindings. * \li libpulse-simple - The simple PulseAudio API. */ #endif