From f44ba092651aa75055e109e04b4164ea92ae7fdc Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 19 Jun 2006 21:53:48 +0000 Subject: big s/polyp/pulse/g git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1033 fefdeb5f-60dc-0310-8127-8f9354f1896f --- src/polyp/polypaudio.h | 115 ------------------------------------------------- 1 file changed, 115 deletions(-) delete mode 100644 src/polyp/polypaudio.h (limited to 'src/polyp/polypaudio.h') diff --git a/src/polyp/polypaudio.h b/src/polyp/polypaudio.h deleted file mode 100644 index c172315b..00000000 --- a/src/polyp/polypaudio.h +++ /dev/null @@ -1,115 +0,0 @@ -#ifndef foopolypaudiohfoo -#define foopolypaudiohfoo - -/* $Id$ */ - -/*** - This file is part of polypaudio. - - polypaudio 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. - - polypaudio 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 polypaudio; 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 polyplib 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 polypaudio 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 - * polypaudio 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 polypaudio 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 polypaudio libraries provide pkg-config snippets for the different - * modules: - * - * \li polyplib - The asynchronous API and the internal main loop - * implementation. - * \li polyplib-glib12-mainloop - GLIB 1.2 main loop bindings. - * \li polyplib-glib-mainloop - GLIB 2.x main loop bindings. - * \li polyplib-simple - The simple polypaudio API. - */ - -#endif -- cgit