summaryrefslogtreecommitdiffstats
path: root/src/pulse/polypaudio.h
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2006-06-19 21:55:07 +0000
committerLennart Poettering <lennart@poettering.net>2006-06-19 21:55:07 +0000
commit25f79693b150eb157a92d48036b904d3f7132a08 (patch)
tree86972085e5262eb4f9ec72bf6b43c0b69bfcced9 /src/pulse/polypaudio.h
parentf44ba092651aa75055e109e04b4164ea92ae7fdc (diff)
rename polypaudio.h to pulseaudio.h
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1034 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'src/pulse/polypaudio.h')
-rw-r--r--src/pulse/polypaudio.h115
1 files changed, 0 insertions, 115 deletions
diff --git a/src/pulse/polypaudio.h b/src/pulse/polypaudio.h
deleted file mode 100644
index 5bbd4cc5..00000000
--- a/src/pulse/polypaudio.h
+++ /dev/null
@@ -1,115 +0,0 @@
-#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 <pulse/mainloop-api.h>
-#include <pulse/sample.h>
-#include <pulse/def.h>
-#include <pulse/context.h>
-#include <pulse/stream.h>
-#include <pulse/introspect.h>
-#include <pulse/subscribe.h>
-#include <pulse/scache.h>
-#include <pulse/version.h>
-#include <pulse/error.h>
-#include <pulse/operation.h>
-#include <pulse/channelmap.h>
-#include <pulse/volume.h>
-#include <pulse/xmalloc.h>
-#include <pulse/utf8.h>
-#include <pulse/thread-mainloop.h>
-#include <pulse/mainloop.h>
-#include <pulse/mainloop-signal.h>
-#include <pulse/util.h>
-#include <pulse/timeval.h>
-
-/** \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